📚 World/Player

玩家对象是一个抽象的概念，它并不是一个可以看见的世界实例。

任何加入到当前服务器的玩家（包括本地玩家）均被认定为Player。

📒 Event

📘 OnPlayerJoin( player )

📘 OnPlayerComplete( player )

📘 OnPlayerPart ( player, reason )

• Reason：离开原因（int）（0=断开连接；1=被服务器踢出；2=被服务器封禁）

📘 OnPlayerChat( player, text )

function OnPlayerChat( player, text )
{
    //以下2行内容实现了自定义聊天消息的扩展
    //举一反三，也可以扩展出私聊、团队信息、前缀、关键词替换等
    Message("[DIY CHAT] " + player.Name + ": " + text);
    return 0; //return 0 == ignore engine default chat message
}

📘 OnPlayerStreamData( player, number, data )

function OnPlayerStreamData( player: Player, number: float, data: string )

📘 OnPlayerCommand( player, cmd, arg )

📘 OnPlayerTypingChange( player, state )

function OnPlayerTypingChange( player: Player, state: bool )

📘 OnPlayerVoiceStateChange( player, state )

function OnPlayerVoiceStateChange( player: Player, state: bool )

📘 OnPlayerEntityLogin( player, entity )

📘 OnPlayerEntityLogout( player, entity )

📘 OnPlayerKeyDown( player, keyTag )

📘 OnPlayerKeyUp( player, keyTag )

📘 OnPlayerNativeKeyDown( player, keyTag )

📘 OnPlayerNativeKeyUp( player, keyTag )

📘 OnPlayerWorldChange( player, world )

📘 OnPlayerColorChange( player, color )

📘 OnPlayerNameChange( player, name )

📒 Property

📘 player.ID

player.ID: int

📘 player.UUID

player.UUID: string

📘 player.Name

player.Name: string

📘 player.Address

player.Address: string

📘 player.Data

player.Data = null; //any

📘 player.UserData

player.UserData: string

📘 player.GameEdition

player.GameEdition: int

📘 player.Authority

player.Authority: int

📘 player.Ping

player.Ping: int

📘 player.FPS

player.FPS: int

📘 player.Stats

player.Stats = ""; //string

📘 player.World

player.World = 0; //int

📘 player.UniqueWorld

player.UniqueWorld: int //10000 + player.ID

📘 player.Color

player.Color = Color(255, 255, 255);

📘 player.Group

player.Group = 0; //int

📘 player.Entity

player.Entity: Character

📘 player.Character

player.Character: Character

📘 player.IsAdmin

player.IsAdmin = false;

📘 player.IsBindEntity

player.IsBindEntity = true;

📘 player.Pos

player.Pos: Vector

📘 player.FocusPos

player.FocusPos: Vector

📘 player.FocusAngle

player.FocusAngle: Vector2

📘 player.FocusAngleForward

player.FocusAngleForward: Vector2

📘 player.EngineLanguage

player.EngineLanguage: string

📘 player.ModLanguage

player.ModLanguage: string

📘 player.IsTyping

player.IsTyping: bool

📘 player.IsComplete

player.IsComplete: bool

📘 player.IsObserver

player.IsObserver: bool

📘 player.VoiceState

player.VoiceState: bool

📘 player.CameraMode

player.CameraMode: int

📘 player.CameraFreeMode

[note2] 注意：此模式不会修改鼠标可见状态，因此通常应该手动关闭鼠标可见（Client），已达到随鼠标自由旋转。 [note]

player.CameraFreeMode = false; //bool

📘 player.CameraSlowMode

player.CameraSlowMode = false; //bool

📘 player.AudioReverbInternal

player.AudioReverbInternal = 3; //Room

📘 player.AudioReverbExternal

player.AudioReverbExternal = 16; //Forest

📒 Static Function

📘 Player.Find()

function Player.Find( id: int ): Player

📘 Player.Search()

function Player.Search( any: string ): Player

//Players: "Alnny", "Tommy", "Tom"
Player.Search("Tom"); //Tom（完整匹配）
Player.Search("Tomm"); //Tommy（相似匹配）
Player.Search("To"); //Tommy（以最先搜索到的为主）
Player.Search("0"); //By ID

📘 Player.FindByUUID()

function Player.FindByUUID( uuid: string ): Player

📘 Player.GetCount()

function Player.GetCount(): int

📘 Player.Get()

function Player.Get( index: int ): Player

📘 Player.BanUUID()

function Player.BanUUID( uuid: string )

📘 Player.UnbanUUID()

function Player.UnbanUUID( uuid: string )

📘 Player.UnbanName()

function Player.UnbanName( name: string )

📘 Player.UnbanAll()

function Player.UnbanAll()

📒 Function

📘 player.SetEntity()

function player.SetEntity( entity: Character, isBind: bool = true )
/*
	entity：要绑定的角色对象（如果为null则解除绑定）
	isBind：是否绑定实体（等同于player.IsBindEntity = isBind），如果设定为true则玩家断开时同时销毁角色，否则将会保留角色
*/

function OnPlayerJoin( player )
{
	let chara = Character.Create(0, Vector(0, 0, 0), 0, 0);
	player.SetEntity(chara);
}

📘 player.SetObserver()

function player.SetObserver( character: Character )

📘 player.GetObserver()

function player.GetObserver(): Character

📘 player.Kick()

function player.Kick( reason: string = "Kicked" )

📘 player.Ban()

function player.Ban( reason: string = "Banned" )

📘 player.CreateNativeMenu()

let view = {
    Cover: 5,
    Tag: "Test",
    Title: "XXX",
    Info: "ABC",
    Width: 500,
    Align: 1,
    Layout: 1,
    Items: [
        {
            Text: "点击：输出玩家Name",
            OnClick: () => {
                DLog("PlayerName: " + player.Name);
            }
        },{
            Input: "xxx",
            Restrict: "*",
            OnFocus: (text) => {
                DLog("输入框文本: " + text);
            }
        },{
            Text: "点击：刷一辆载具+关闭菜单",
            OnClick: () => {
                Vehicle.Create(10, player.Entity.Pos, player.Entity.Angle);
                player.DestroyNativeMenu();
            }
        }
    ]
};
 
player.CreateNativeMenu(view);

📘 player.DestroyNativeMenu()

📘 player.SetNativeMenuText()

📘 player.Message()

function player.Message( text: string )

📘 player.Announce()

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

📘 player.Subtitle()

function player.Subtitle( text: string )

📘 player.StoryDialog()

function player.StoryDialog( title: string, text: string, avatar: int = -1, sound: int = -1, buttons: any = null, onComplete: Action = null )

• title：标题、故事对话人昵称
• text：主要文本内容（可用html语法，以及\n换行）
• avatar：故事对话人形象图片ID（基于Texture文件机制），默认为-1
• sound：故事对话时音频ID（例如配音等，基于Sound文件机制），默认为-1，仅在当前对话框生命周期有效，对话结束（或切换对话框）后将自动停止播放
• buttons：附加按钮（最多支持3个），以数组的形式传递数据（见下方示例）
• onComplete：对话结束时触发事件

player.StoryDialog("测试角色", "风平浪静……", -1, -1, [
    {
        Button: "Button A", 
        Action: () => {
            DLog("Click A");
        }
    },{
        Button: "Button B", 
        Action: () => {
            DLog("Click B");
        }
    }
], () => {
    DLog("OnComplete Invoke!");
}); //1
player.StoryDialog("测试角色2", "风平浪静1……", -1, 1124); //2
player.StoryDialog("测试角色2", "风平浪静2……", -1, 1124); //3

📘 player.NextStoryDialog()

function player.NextStoryDialog()

📘 player.ClearStoryDialog()

function player.ClearStoryDialog()

📘 player.SendData()

function player.SendData( number: float, data: string = "" )

📘 player.ClientExec()

function player.ClientExec( code: string )

📘 player.PlaySound()

function player.PlaySound( audioID: int, loop: bool = false, volume: float = 1f, tag: string = null ): string

📘 player.Play3DSound()

function player.Play3DSound( audioID: int, pos: Vector, radius: float, loop: bool = false, volume: float = 1f, tag: string = null ): string

📘 player.StopSound()

function player.StopSound( uuid: string, fadeTime: float = 0 )

📘 player.PlayMusic()

function player.PlayMusic( audioID: int, loop: bool = false, volume: fadeTime = 3 )

📘 player.Play3DMusic()

function player.Play3DMusic( audioID: int, pos: Vector, radius: float, loop: bool = false, fadeTime: float = 3f )

📘 player.PauseMusic()

function player.PauseMusic( fadeTime: float = 3 )

📘 player.ResumeMusic()

function player.ResumeMusic( fadeTime: float = 3 )

📘 player.StopMusic()

function player.StopMusic( fadeTime: float = 3 )

📘 player.PlayNatural()

function player.PlayNatural( audioID: int, channel: int, loop: bool = true, volume: fadeTime = 3 )

📘 player.StopNatural()

function player.StopNatural( channel: int, fadeTime: float = 3 )

📘 player.StopAllNatural()

function player.StopAllNatural( fadeTime: float = 3 )

📘 player.FocusCamera()

function player.FocusCamera()

📘 player.RunTask()

function player.RunTask( time: float, title: string, onComplete: Action, theme: int = 0 )

• theme：范围0~4，表示不同的颜色

player.RunTask(5, "正在安装C4...", () => {
    //C4 Setup
});

📘 player.StopTask()

function player.StopTask()

📘 player.BindKeyPresser()

function player.BindKeyPresser( target: any )
/*
	target可选类型：null\Vector\Entity（Vector\Entity类型将作为3D坐标展示，Entity会有自动跟随）
*/

📘 player.AddKeyPresser()

function player.AddKeyPresser( index: int, keyCode: string, text: string, onPress: Action = null )
/*
	index：指引索引（如索引已存在指引，将会替换修改，一个index只能存在并表示一个指引实例），相当于一个标签作用
	keyCode：绑定按键，最好不要和其他按键冲突，除非知道在做什么
	text：按键后面的文本内容
	onPress：当玩家按下后执行的事件
*/
 
//通常情况下，如果同时只使用1个指引功能，只需要一直将index填写0即可
//在可能处理多个按键对象的情况下，可以将index作为区分标签作用，比如上车index是100，下车可能是101，这样可以随时用ExistKeyPresser来检查某个按键对象是否存在

//同时绑定多个按键对象的示例
player.AddKeyPresser(0, "F", "进入当前载具", () => { 进入代码... });
player.AddKeyPresser(3, "H", "修复当前载具", () => { 修复代码... });
 
//此时将会在玩家屏幕中，显示竖向的两行（最多支持6行）
【F】进入当前载具
【H】修复当前载具

📘 player.RemoveKeyPresser()

function player.RemoveKeyPresser( index: int )

📘 player.ExistKeyPresser()

function player.ExistKeyPresser( index: int ): bool

📘 player.ClearKeyPressers()

function player.ClearKeyPressers()

📘 player.AddGuider()

function player.AddGuider( index: int, target: any, text: string = "", autoDestroy: bool = false )
/*
	index：指引索引（如索引已存在指引，将会替换修改，一个index只能存在并表示一个指引实例），相当于一个标签作用
	target：目标对象（可以是Vector|Entity等类型，分别表示静态坐标与动态跟随目标）
	text：指引文字
	autoDestroy：到达指引目标附近是否自动移除指引，默认为false
*/
 
//通常情况下，如果同时只使用1个指引功能，只需要一直将index填写0即可

📘 player.RemoveGuider()

function player.RemoveGuider( index: int )

📘 player.ExistGuider()

function player.ExistGuider( index: int ): bool

📘 player.SetCinematicBorder()

function player.SetCinematicBorder( active: bool, time: float = 1.0 ): bool

📘 player.GetCinematicBorder()

function player.GetCinematicBorder(): bool

📘 player.SetVoiceMode()

function player.SetVoiceMode( mode: int = 0 )

📘 player.GetVoiceMode()

function player.GetVoiceMode(): int

📘 player.SetVoiceWorldMode()

function player.SetVoiceWorldMode( active: bool )

📘 player.GetVoiceWorldMode()

function player.GetVoiceWorldMode(): bool

📘 player.SetVoiceAuthority()

function player.SetVoiceAuthority( active: bool )

📘 player.GetVoiceAuthority()

function player.GetVoiceAuthority(): bool

📘 player.SetVoiceIgnore()

function player.SetVoiceIgnore( player: Player, active: bool )

📘 player.GetVoiceIgnore()

function player.GetVoiceIgnore( player: Player ): bool

📘 player.TestVisiblePoint()

function player.TestVisiblePoint( pos: Vector ): bool