📚 Client/Main

在当前版本下，Client脚本更适合实现客户端独有的功能、GUI界面等。

有关世界内容的玩法（如：Player、Character、Vehicle等）建议优先使用World脚本实现。

📒 Event

📘 OnScriptLoad()

BindKey(...); //Invalid, Script not loaded
 
function OnScriptLoad()
{
	BindKey(...); //Correct
}

📘 OnScriptUnload()

📘 OnFrameUpdate( deltaTime )

由于此事件属于客户端脚本范畴，所以可以理解为每帧渲染事件，无须担心延迟问题。

deltaTime：float //增量时间

📘 OnFixedUpdate( fixedDeltaTime )

此事件会以FixedUpdate的方式每隔固定时间调用，通常情况下可以忽略使用此事件。

fixedDeltaTime：float //增量时间

📘 OnLocalCommand( cmd, arg )

此事件可供实现一些内置的“本地游戏指令”，例如可实现输入"quitgame"退出游戏等功能。

注意：对于少数引擎内置的指令（如quit\q\version\disconnect...）不会被接收和调用，这是不可拦截的。

📘 OnServerStreamData( number, data )

📘 OnKeyDown( keyTag )

function OnKeyDown( keyTag )
{
    //keyTag表示按键标签，而不是按键代码
}

📘 OnKeyUp( keyTag )

function OnKeyUp( keyTag )
{
    //keyTag表示按键标签，而不是按键代码
}

📘 OnNativeKeyDown( keyTag )

function OnNativeKeyDown( keyTag )
{
    //keyTag表示按键标签，而不是按键代码
}

📘 OnNativeKeyUp( keyTag )

function OnNativeKeyUp( keyTag )
{
    //keyTag表示按键标签，而不是按键代码
}

📘 OnTimeChange( oldTime, newTime )

function OnTimeChange( oldTime, newTime )
{
    DLog("OldTime: " + oldTime.Hour + "-" + oldTime.Minute);
    DLog("NewTime: " + newTime.Hour + "-" + newTime.Minute);
}

📒 Function

📘 Exec()

function Exec( code: string )

📘 OpenUrl()

function OpenUrl( url: string )

📘 BindGameMenuButton()

function BindGameMenuButton( titleOrKey: string, info: string = null, callback: Action = null )

function OnScriptLoad()
{
    //Custom Item
	BindGameMenuButton("启动主机", "建立本地联机服务器", () => {
		CreateHost("mapname", "scriptname");
	});
	BindGameMenuButton("[color=#ffff00]加入本地服务器[/color]", "加入本地服务器（127.0.0.1）", () => {
		ConnectHost("127.0.0.1");
	});
 
    //Internal Item
    BindGameMenuButton("@space");
    BindGameMenuButton("@mapeditor");
}

📘 UnbindAllGameMenuButton()

function UnbindAllGameMenuButton()

📘 SetGameMenuBGEffect()

function SetGameMenuBGEffect( active: bool = true )

📘 SetGameMenuStyle()

function SetGameMenuStyle( style: int )

📘 GetGameMenuStyle()

function GetGameMenuStyle(): int

📘 CreateNativeView()

function OpenNativeView( int type, Action onDisable = null )

尽管有些ID没有被表格记录，但有可能仍然是有内容的，但未被记录的ID通常不具备通用性意义，在打开时将会别引擎阻断。

📘 ExistNativeView()

function ExistNativeView( type: int ): bool

📘 DestroyNativeView()

function DestroyNativeView(type: int = -1, hasEffect: bool = true)
//如果不填写参数（-1），则默认关闭所有内置UI面板
//如果hasEffect == false则立即关闭面板

📘 LoadNativeScene()

function LoadNativeScene( type: int )

📘 CreateNativeMenu()

function CreateNativeMenu( viewData: any )

📘 DestroyNativeMenu()

function DestroyNativeMenu()

📘 SetNativeMenuText()

function SetNativeMenuText( index: int, text: string ) //index: (-1 > 标题, -2 > 子标题, 0+ > 索引Item)
function SetNativeMenuText( tag: string, text: string ) //同理，区别是通过tag参数来选择改变的Item

📘 GetCurrentNativeMenuTag()

function GetCurrentNativeMenuTag(): string

📘 CreateRadialMenu()

function CreateRadialMenu( viewData: any )

📘 DestroyRadialMenu()

function DestroyRadialMenu()

📘 GetCurrentRadialMenuTag()

function GetCurrentRadialMenuTag(): string

📘 SendDataToServer()

function SendDataToServer( number: float(int), data: string = "" )

📘 SetChatEnabled()

function SetChatEnabled( enable: bool )

📘 GetChatEnabled()

function GetChatEnabled(): bool

📘 SetChatPanelPivot()

function SetChatPanelPivot( pivot: int = -1 )

SetChatPanelPivot(-1); //Use engine config (default)
SetChatPanelPivot(0); //Change pivot to Left_Top
SetChatPanelPivot(1); //Change pivot to Left_Center
SetChatPanelPivot(2); //Change pivot to Left_Bottom

📘 ScreenFade()

function ScreenFade( time: float, middleTime = 0, color: Color = Color(0, 0, 0), isTop: bool = true, onMiddle = null, ignoreHit: bool = true )
/*
	time：渐变时间（渐入>不透明>渐出），例如设置为2，则表示0~1秒变不透明，1~2秒变透明
	middleTime：不透明延迟时间，默认为0，否则将等待X秒后再进行透明渐变
	color：颜色，默认为黑色
	isTop：是否顶层，默认为true
	onMiddle：可选委托事件，当颜色完成不透明时调用
	ignoreHit：转场是否屏蔽点击，默认为true
*/

📘 ScreenFadeIn()

function ScreenFadeIn( time: float, color: Color = Color(0, 0, 0), isTop: bool = true, onComplete = null, ignoreHit: bool = true )
/*
	time：整体时间（渐入>不透明）
	color：颜色，默认为黑色
	isTop：是否顶层，默认为true
	onComplete：可选委托事件，当颜色完成不透明时调用
	ignoreHit：转场是否屏蔽点击，默认为true
*/

📘 ScreenFadeOut()

function ScreenFadeOut( time: float, color: Color = Color(0, 0, 0), isTop: bool = true, onComplete = null, ignoreHit: bool = true )
/*
	time：整体时间（不透明>渐出）
	color：颜色，默认为黑色
	isTop：是否顶层，默认为true
	onComplete：可选委托事件，当颜色完成透明时调用
	ignoreHit：转场是否屏蔽点击，默认为true
*/

📘 Transition()

function Transition( type: int, addTime: float = 0, color: Color = Color(255, 255, 255), action: Action = null, isOut: bool = false )

• type：转场特效类型
• addTime：转场中途覆盖后，等待的延迟时间（默认为0，即为立即渐出）
• color：转场特效颜色
• action：当转场中途完全覆盖时执行代码
• isOut：是否立即淡出

📘 Message()

function Message( text: string )

📘 Announce()

function Announce( text: string, type: int = 0, time: float = 6 )

📘 Subtitle()

function Subtitle( text: string )

📘 BindKey()

function BindKey( keyTag: string, key1: string, key2: string = "None", key3: string = "None" )
/*
	keyTag：按键标签（用于识别）
	key1：按键1标准名称（如'H'）
	key2：默认'None'，否则表示组合键
	key3：默认'None'，否则表示组合键
*/

📘 UnbindKey()

function UnbindKey( keyTag: string )

📘 UnbindAllKey()

function UnbindAllKey()

📘 BindNativeKey()

function BindNativeKey( keyTag: string, key1: string, key2: string = "None", key3: string = "None" )
/*
	keyTag：按键标签（用于识别）
	key1：按键1标准名称（例如'H'）
	key2：默认'None'，否则表示组合键
	key3：默认'None'，否则表示组合键
*/

注意：此功能适合绑定一个【可供玩家自定义】的游戏按键，绑定后将会在【设置界面】自动出现对应的【按键绑定选项】，直到模组关闭前持续有效。

按键绑定选项只会在通过BindNativeKey()注册过的场景打开设置菜单时出现，通常情况下，开发者只需在Main场景绑定暴露一次即可，自定义选项会持续到模组关闭。

//Main Scene
function OnScriptLoad()
{
    //绑定注册，【设置菜单】会出现对应的绑定选项
    BindNativeKey("EnterVehicle", "E"); //绑定一个E键按钮（默认按键）
 
    //打开设置菜单，会出现对应的绑定按钮
    CreateNativeView(1);
}
 
//Any Scene
function OnNativeKeyDown( key )
{
	if(key == "EnterVehicle")
	{
		DLog("按下进入载具按钮！");
	}
}

📘 UnbindNativeKey()

function UnbindNativeKey( keyTag: string )

📘 UnbindAllNativeKey()

function UnbindAllNativeKey()

📘 SetGameOption()

function SetGameOption( keyPath: string, value: any = null, param: any = null, overwrite: bool = false )

补充：Mod.InternalNull是一个特殊空隙路径，填写此路径会默认被理解为是一个空行占位符号。

//KeyPath
"Mod.XXXXX" == "XXXXX" //Easy write method
 
//Example
SetGameOption("PlayerName", "UserName"); //InputField: default "UserName"
 
SetGameOption("InternalNull"); //Null string
SetGameOption("FlyMode", true); //Bool Select: default true
SetGameOption("DamageMultiple", 50); //Progress 0~100: default 50.0 (50%)
SetGameOption("PlayerSkin", "0|XXX", "Pig|Dog|Cat"); //Dropdown: default "Pig" (0)
SetGameOption("PlayerSkin2", "2|XXX", "Pig|Dog|Cat"); //Dropdown: default "Cat" (2)

📘 GetGameOption()

function GetGameOption( keyTag: string, defaultValue: any = null ): any

📘 ReadFile()

function ReadFile( fileName: string ): string

ReadFile( "Test.txt" ); //read: Mod/Space/Test.txt

📘 GetModArchive()

function GetModArchive( package: string = null ): string

📘 GetPropSourceData()

function GetPropSourceData( prop: int, keyPath: string ): any

📘 GetTime()

let worldTime = GetTime();
DLog("Hour: " + worldTime.Hour + ", Minute: " + worldTime.Minute);

📘 GetTimeRate()

function GetTimeRate(): float