📚 Client/Core

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

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

📒 Event

📘 OnScriptLoad()

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

📘 OnScriptUnload()

📘 OnFrameUpdate( deltaTime )

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

deltaTime：float //增量时间

📘 OnLocalCommand( cmd, arg )

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

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

📘 OnCameraObserver( character )

📘 OnServerNetworkRPC( rpc, arg0, arg1, arg2 )

📘 OnServerStreamData( number, data )

📘 OnTypingStateChange( state )

📘 OnKeyDown( keyTag )

function OnKeyDown( keyTag ): int
{
    return 1;
}

• keyTag：按键标签（非按键代码）
• return：是否允许传递给服务端（如果服务端监听）

📘 OnKeyUp( keyTag )

function OnKeyUp( keyTag ): int
{
    return 1;
}

• keyTag：按键标签（非按键代码）
• return：是否允许传递给服务端（如果服务端监听）

📘 OnWorldTimeChange( oldTime, newTime )

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

📘 OnWorldWeatherChange( oldWeather, newWeather )

function OnWorldWeatherChange( oldWeather: int, newWeather: int )

📒 Function

📘 Exec()

function Exec( code: string )

📘 OpenUrl()

function OpenUrl( url: string )

📘 LoadNativeScene()

function LoadNativeScene( type: int )

📘 NetworkCMD()

function NetworkCMD( cmd: string, arg0: any, arg1: any, arg2: any )

📘 SendDataToServer()

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

📘 SetOutlineColor()

function SetOutlineColor( index: int, color: Color )

📘 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'，否则表示组合键
*/

注意：此功能适合绑定一个【可供玩家自定义】的游戏按键，绑定后将会在【设置界面】自动出现对应的【按键绑定选项】。由于每次切换场景都会重置代码，因此如果希望玩家在主界面就可以设置按键，应该优先在Main场景执行此代码。

//Main Scene
function OnScriptLoad()
{
    //绑定注册，【设置菜单】会出现对应的绑定选项
    BindNativeKey("EnterVehicle", "E"); //绑定一个E键按钮（默认按键）
 
    //打开设置菜单，会出现对应的绑定按钮
    CreateNativeView(1);
}
 
//Any Scene
function OnKeyDown( 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

📘 GetModArchive()

function GetModArchive( package: string = null ): string

📘 GetWorldTime()

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

📘 GetWorldTimeRate()

function GetWorldTimeRate(): float

📘 GetWorldWeather()

function GetWorldWeather(): float

📘 BindActionKey()

function BindActionKey( keyTag: string, title: string = null, onAction: Action = null, isHandled: bool = true ): string

• keyTag：按键标签（需由BindKey | BindNativeKey绑定的标签）
• title：如果不为空，则优先使用此文本（支持宏文本），否则使用默认文本
• onAction：按键按下后事件
• isHandled：是否阻止按键向下传递（OnKeyDown | OnKeyUp）
• return：返回UUID（用作识别）

📘 GetActionKey()

function GetActionKey(): string

📘 UnbindActionKey()

function UnbindActionKey( keyTag: string )

📘 UnbindActionKeyByUUID()

function UnbindActionKeyByUUID( uuid: string )

📘 UnbindAllActionKey()

function UnbindAllActionKey()

📘 GenerateMapSnapshot()

function GenerateMapSnapshot( style: int = 0, worldTime: int = 10 )

• style渲染风格（0=默认；1=描边；2=油画；3=灰质；4=黑白描边；5=霓虹描边）
• worldTime世界时间（生成快照时的亮度）

📘 SetFocusEntityDistance()

function SetFocusEntityDistance( value: float )

📘 GetFocusEntityDistance()

function GetFocusEntityDistance(): float