📚 Native/Core

原生脚本是一个内置的通用脚本功能类，此分类下还有更多通用的扩展工具类。

📒 Const

📘 VECTOR_NULL

const VECTOR_NULL = Vector(-128000, -128000, -128000);

📒 Type

📘 Vector()

let pos = Vector(0, 0, 10); //X, Y, Z
 
//Extend
pos.magnitude; //magnitude（向量长度）
pos.normalized; //normalized（归一化）

• xX轴数值（左右）
• yY轴数值（上下）
• zZ轴数值（前后）

📘 Vector2()

let pos = Vector2(0, 0); //X, Y

• xX轴数值
• yY轴数值

📘 Bounds()

let bounds = Bounds(Vector(0, 0, 0), Vector(0, 0, 0)); //Center, Size

• center中心位置
• size尺寸
• extents尺寸（一半）
• min最小点
• max最大点

📘 Color()

let newColor = Color(255, 255, 255, 255); //R, G, B, A
let newColor2 = Color(255, 255, 255); //R, G, B, A=255

• r颜色数值
• g颜色数值
• b颜色数值
• a透明度数值

📘 ArrayValueResult()

• GetCount()获取数组长度
• Get(index: int)获取指定索引的内容

📘 RayTraceResult()

• IsHit是否碰撞射线（如果IsHit = true && Entity = null，可能表示检测到世界地形）
• Point射线检测坐标（如没有产生碰撞，则坐标即是默认终点）
• Entity射线碰撞实体（如果对象不是标准的Entity实体，或对象为静态模型（本地静态模型），则返回为null）
• Distance射线实际产生距离
• Normal射线检测表面角度

📘 VectorPoint()

• Tag筛选标签（可空""）
• Pos坐标（Vector，不可空，至少要有一个）
• Angle旋转角度（Vector，可空）
• Scale缩放（Vector，可空）

📒 Event

📘 OnGameOptionUpdate( optionKey )

function OnGameOptionUpdate( optionKey: string )

function OnGameOptionUpdate( optionKey )
{
    if(optionKey == null)
    {
        //如果参数==null，表示不是由某个选项更新触发，而是引擎主动刷新
        DLog("Force Update.");
        return;
    }
 
    //如果不为空，则OptionKey返回具体哪个选项发生更新
    DLog("OnGameOptionUpdate: " + optionKey);
}

📒 Function

📘 UnloadMod()

function UnloadMod()

📘 QuitGame()

function QuitGame()

📘 SetDisconnectMethod()

function SetDisconnectMethod( (output: string ): int => {} )

SetDisconnectMethod((output) => {
    if(output.indexOf("Error") >= 0)
    {
        //Unload Mod
        return 2;
    }
});

📘 GCCollect()

function GCCollect( all: bool = false )

• all：是否包含对引擎的GC清理，这可能会造成临时卡顿，否则将只清理脚本GC

📘 Equals()

function Equals( a: any, b: any ): bool

📘 IsNullVector()

function IsNullVector( pos: Vector ): bool

📘 GetStringToken()

function GetStringToken( text: string, symbol: string ): StringValueResult

let source = "test a b c";
let result = GetStringToken(source, " ");
DLog(result.Get(2));  //Output: "b"

📘 Env.LoadScript()

function Env.LoadScript( path: string, IIFE: bool = false)

• path脚本目录下的 同级或子级 脚本文件路径（例如：Test/MyCode.js）
• IIFE是否为独立作用域，否则默认脚本续写加载

//Path Rule
LoadScript("Test/MyCode.js"); //√
LoadScript("Test/MyCode"); //√
LoadScript("MyCode.js"); //√
LoadScript("../MyCode.js"); //×
 
//Test
LoadScript("Test.js")
TestAction(); //Test.js >> TestAction()
 
//Test.js
function TestAction()
{
    Debug.Log("TestMode");
}

📘 Env.AddListener()

function Env.AddListener( eventName: string, action: Action, sort: int = 1 ): string

• eventName希望监听的function名称，通常用于监听引擎原生事件，但也支持自定义事件
• action当事件触发时执行的function，支持Lambda表达式
• sort监听方法的执行顺序，数值越小越靠前，默认顺序为1（在原方法执行后执行），原方法Sort默认保持为0（唯一）
• return监听事件的Hash值，可用于取消监听

Env.AddListener("OnPlayerJoin", function( player ){
    DLog("Player: " + player.Name + " joined!");
});
 
function OnPlayerJoin( player )
{
    DLog("Welcome: " + player.Name);
}
 
//Output
//"Welcome XXX";
//"Player: XXX joined!"

Env.AddListener("OnPlayerJoin", function( player ){
    DLog("Player: " + player.Name + " joined!", -1); //-1 < 0(Native)
});
 
function OnPlayerJoin( player )
{
    DLog("Welcome: " + player.Name);
}
 
//Output
//"Player: XXX joined!" //Because sort set -1(<0)
//"Welcome XXX";

📘 Env.RemoveListener()

function Env.RemoveListener( eventHash: string )

• eventHash希望取消监听的eventHash，通过AddListener()返回值获取

let listenerHash = Env.AddListener("OnPlayerJoin", function( player ){
    DLog("Player: " + player.Name + " joined!");
});
 
Env.RemoveListener(listenerHash);

📘 Env.Emit()

function Env.Emit( functionName: string, params: any = ... )

• functionName触发的函数\事件名称
• params附带参数（如存在）

Env.Emit("OnPlayerChat", Player.Find(0), "Hello!");

📘 CreateHost()

function CreateHost( map: string, script: string, port: int = 0, address: string = "", userData: string = "", additional: bool = true ): bool //是否建立成功

CreateHost("test2", "Main2");

CreateHost("test2", "Main2", 8195);

CreateHost("test2", "Main2", 0, "steam");

CreateHost("test2", "Main2", 0, "", "TestStringOrJson...");

CreateHost("test2", "Main2", 0, "", "", false);

📘 ConnectHost()

function ConnectHost(address: string, port: int = 0, password: string = "", userData: string = "")

ConnectHost("127.0.0.1"); 

📘 Disconnect()

function Disconnect()

📘 Reconnect()

function Reconnect()

📘 IsServerMode()

function IsServerMode(): bool

📘 IsNewPlayer()

function IsNewPlayer(): bool

📘 IsHost()

function IsHost(): bool

📘 GetVersionInfo()

function GetVersionInfo(): string

📘 GetModPackage()

function GetModPackage(): string

📘 GetModName()

function GetModName(): string

📘 GetEngineTickCount()

function GetEngineTickCount(): float

📘 GetModTickCount()

function GetModTickCount(): float

📘 GetDateTime()

function GetDateTime(): string

📘 GetTimestamp()

function GetTimestamp( utc: bool = false ): int

• utc是否使用UTC世界时间，否则为本地时间

📘 GetNetworkTime()

function GetNetworkTime(): double

📘 GetDeltaTime()

function GetDeltaTime(): float

📘 Env.SetGlobalVars()

function Env.SetGlobalVars( key: string, value: any )

//设置一个字符串类型的全局变量
Env.SetGlobalVars("myWebsite", "www.abc.com");
 
//设置一个JavaScript扩展对象全局变量
Env.SetGlobalVars("createServerConfig", {
    serverName: "服务器名称",
    gameMode: 1,
    openPVP: false
});

📘 Env.GetGlobalVars()

function Env.GetGlobalVars( key: string ): any

//设置一个JavaScript扩展对象全局变量
Env.SetGlobalVars("createServerConfig", {
    serverName: "服务器名称",
    gameMode: 1,
    openPVP: false
});
 
//读取时可正常进行读取
let getConfig = Env.GetGlobalVars("createServerConfig");
DLog("serverName: " + getConfig.serverName);

📘 GetScriptName()

function GetScriptName(): string

📘 GetScriptNames()

function GetScriptNames(): StringValueResult

let scriptsResult = GetScriptNames();
for(let i=0;i<scriptsResult.GetCount();i++)
{
    DLog(scriptsResult.Get(i)); //string
}

📘 GetCurrentScriptNames()

function GetCurrentScriptNames(): StringValueResult 

📘 GetPluginNames()

function GetPluginNames(): StringValueResult

let scriptsResult = GetPluginNames();
for(let i=0;i<scriptsResult.GetCount();i++)
{
    DLog(scriptsResult.Get(i)); //string
}

📘 GetCurrentPluginNames()

function GetCurrentPluginNames(): StringValueResult 

📘 GetGameFPS()

function GetGameFPS(): int

📘 GetMapName()

function GetMapName(): string

📘 GetMapNames()

function GetMapNames( filter: int = 0 ): StringValueResult

let result = GetMapNames();
for(let i=0;i<result.GetCount();i++)
{
    DLog(i + ">" + result.Get(i));
}

📘 GenerateUUID()

function GenerateUUID(): string

📘 IsLogicFrame()

function IsLogicFrame(): bool

📘 RayTrace()

function RayTrace( start: Vector, over: Vector, layer: int = 0, includeTerrain: bool = true ): RayTraceResult

• start起始点
• over结束点
• layer筛选layer层，默认为0，可用于筛选判断实体类型层（位）
• RayTraceResult返回值（类型参考）

//只判断Character + Vehicle
let result = RayTrace(Vector(0, 0, 0), Vector(10, 0, 10), 2 + 4);
DLog(result.IsHit);
DLog(result.Point);
DLog(result.Entity)

📘 OverlapEntity()

function OverlapEntity( pos: Vector, radius: float, filter: int = 0 ): OverlapEntityResult

//Only check 'Character' and 'Vehicle'
let result = OverlapEntity(Vector(0, 0, 0), 20, 2 + 4);
 
//Result
result.GetCount(); //Result Count
result.Get(0); //GetEntity by index

let result = OverlapEntity(Vector(0, 0, 0), 2, 0);
if(result.GetCount() > 0)
{
    let getEntity = result.Get(0); //Get index 0
 
    DLog(getEntity.GetType()); //"EntityType", maybe "Character" (string)
    DLog(getEntity.GetInstance()); //EntityObject, maybe Character (object)
}

📘 OverlapPlayer()

function OverlapPlayer( pos: Vector, radius: float ): OverlapEntityResult

let result = OverlapPlayer(Vector(0, 0, 0), 2);
if(result.GetCount() > 0)
{
    let getPlayer = result.Get(0); //Get index 0
 
    DLog(getPlayer.Name);
}

📘 GetLanguage()

function GetLanguage(): string

📘 GetModLanguage()

function GetLanguage(): string

📘 GetSystemLanguage()

function GetLanguage(): string

📘 GetLanguageText()

function GetLanguageText( key: string, params: any... ): string
function GetLanguageText( key: string, index: int = 0, params: any... ): string

• key：游戏语言文件内的完整路径
• index：可省略参数，表示语言结构数组索引，默认为0，如果设置为-1则表示随机取索引
• params：如果目标语言文本拥有{0}{1}{2}占位替换符号，可以根据索引填写后续参数

GetLanguageText("Native.Common.Exception"); //"发生异常错误！"

📘 GetLanguageTextCount()

function GetLanguageTextCount( key: string ): int

📘 GetVectorPoints()

function GetVectorPoints( tag: string ): VectorPointResult

//Test Code
let tag = "test";
let result = GetVectorPoints(tag);
for(let i=0;i<result.GetCount();i++)
{
    let getResult = result.Get(i);
    DLog(getResult.Tag + ": " + getResult.Pos);
}

📘 AddVectorPoint()

function AddVectorPoint( tag: string, pos: Vector, angle: Vector = null, scale: Vector = null ): VectorPoint

//Test Code
AddVectorPoint("", Vector(10, 0, 0));
AddVectorPoint("HomePos", Vector(10, 0, 0), Vector(0, 0, 0));

📘 RemoveVectorPoint()

function RemoveVectorPoint( tag: string = "" )

//Test Code
RemoveVectorPoint();
RemoveVectorPoint("HomePos");

📘 FormatPlainText()

function FormatPlainText( text: string, includeUBB: bool = true ): string

• includeUBB：如果设置为true，则允许包含UBB（忽略处理）。

📘 FormatRichText()

function FormatRichText( text: string, onlyEmoji: bool = false ): string

• onlyEmoji：如果设置为true，则#Number的行为将被识别为表情（0~74），否则#Number将识别全局TextureID。

FormatRichText("#0", false); //Out id 0 (Asset Texture_0, not emoji)
FormatRichText("#0", true); //Out id 200 (Emoji Texture, 200~274 is emoji texture)

📘 FormatDefineText()

function FormatDefineText( text: string, includeColor: bool = true ): string

• includeColor：如果设置为true，则正确识别的宏文本将附带颜色代码。

Message("Your EngineVersion: %EngineVersion%"); //"Your EngineVersion: V0.77"

📘 ExistImmunityFlag()

function ExistImmunityFlag( immunity: int, checkFlag: int )

DLog(ExistImmunityFlag(6, 1)); //AntiNormal: false
DLog(ExistImmunityFlag(6, 2)); //AntiBullet: true
DLog(ExistImmunityFlag(6, 4)); //AntiExplode: true

📘 SamplePoint()

function SamplePoint( pos: Vector, sampleAll: bool = true ): Vector

• sampleAll是否采样所有静态对象，否则仅采样地面对象（陆地）。

📘 SampleRandomPoint()

function SampleRandomPoint( pos: Vector, radius: float, sampleAll: bool = true ): Vector

• sampleAll是否采样所有静态对象，否则仅采样地面对象（陆地）。