📚 Native/Main

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

📒 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（归一化）

• x：X轴数值（左右）
• y：Y轴数值（上下）
• z：Z轴数值（前后）

📘 Vector2()

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

• x：X轴数值
• y：Y轴数值

📘 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：透明度数值

📘 RayTraceResult()

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

📘 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()

📘 GCCollect()

function GCCollect( all: bool = false )

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

📘 DLog()

function DLog("Hello World!")

📘 DWarn()

function DWarn("Hello World!")

📘 DError()

function DError("Hello World!")

📘 Equals()

function Equals( a, b ): bool

📘 IsNullVector()

function IsNullVector( pos: Vector ): bool

📘 GetStringToken()

function GetStringToken( text: string, symbol: string, index: int ): string

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

📘 LoadScript()

function LoadScript( path: string )

• path：脚本目录下的 同级或子级 脚本文件路径（例如：Test/MyCode.js）

//Path Rule
LoadScript("Test/MyCode.js"); //√ 正确，读取Test目录下的MyCode.js
LoadScript("Test/MyCode"); //√ 正确，读取Test目录下的MyCode.js（可忽略".js"）
LoadScript("MyCode.js"); //√ 正确，读取脚本目录下的MyCode.js
LoadScript("../MyCode.js"); //× 错误，安全性考虑无法使用层级符号
 
//Test
LoadScript("Test.js")
TestAction(); //Test.js >> TestAction()
 
//Test.js
function TestAction()
{
    DLog("TestMode");
}

📘 AddListener()

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

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

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

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";

📘 RemoveListener()

function RemoveListener( eventHash: string )

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

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

📘 Emit()

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

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

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

📘 GetEngineTickCount()

function GetEngineTickCount(): float

📘 GetModTickCount()

function GetModTickCount(): float

📘 GetDateTime()

function GetDateTime(): string

📘 GetTimestamp()

function GetDateTime(): int

📘 GetNetworkTime()

function GetNetworkTime(): double

📘 GetDeltaTime()

function GetDeltaTime(): float

📘 SetGlobalVars()

function SetGlobalVars( key: string, value: any )

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

📘 GetGlobalVars()

function GetGlobalVars( key: string ): any

//设置一个JavaScript扩展对象全局变量
SetGlobalVars("createServerConfig", {
    serverName: "服务器名称",
    gameMode: 1,
    openPVP: false
});
 
//读取时可正常进行读取
let getConfig = 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

📘 Distance()

function Distance( pos: Vector, pos2: Vector ): float

📘 DistanceSqrt()

function DistanceSqrt( pos: Vector, pos2: Vector ): float

📘 GreaterDistance()

function GreaterDistance( pos: Vector, pos2: Vector, distance: float ): bool

📘 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);
}

📘 InPoly()

function InPoly( pos: Vector, p1: Vector, p2: Vector, p3: Vector, p4: Vector = null, p5: Vector = null, p6: Vector = null, p7: Vector = null, p8: Vector = null ): bool

DLog(InPoly(Vector(0, 0, 0), Vector(-10, 0, -10), Vector(-10, 0, 10), Vector(10, 0, 10), Vector(10, 0, -10))); //返回true

📘 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
• params：如果目标语言文本拥有{0}{1}{2}占位替换符号，可以根据索引填写后续参数

GetLanguageText("Native.Common.Exception"); //"发生异常错误！"
_Language("Native.Common.Exception"); //"发生异常错误！"
 
_Language("Native.Common.Exception", 1); //"因为异常原因，部分行为没有被执行"
_Language("Native.MapEditor.MultipleDelete", "QWQ") //"即将删除QWQ个对象？此操作不可恢复！"

📘 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");

📘 FormatRichText()

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

• 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 )

• 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

📘 GetRandomPoint()

function GetRandomPoint( pos: Vector, radius: float, changeHeight: bool = false )

• changeHeight：高度坐标是否参与随机，默认为false（即只计算X\Z轴）