meta data for this page
📚 Client/Player
📒 Event
📘 OnPlayerEntityLogin( player, entity )
当某个玩家注册绑定了一个实体对象(开始控制角色)时调用。
📘 OnPlayerEntityLogout( player, entity )
当某个玩家取消绑定了一个实体对象(开始控制角色)时调用。
📘 OnPlayerFocusEntityChange( player, entity )
当玩家焦点对象发生改变时调用。
function OnPlayerFocusEntityChange( player: Player, entity: Entity )
📘 OnPlayerVoiceStateChange( player, state )
当玩家语音聊天状态发生改变时调用(正在语音聊天)。
function OnPlayerVoiceStateChange( player: Player, state: bool )
📒 Static Property
📘 Player.Local
获取本地玩家实例对象(本地玩家自身)。
if(Player.Local) DLog(Player.Local.Name); //Output self player name
📒 Property
📘 player.ID
获取玩家序列ID。
player.ID: int
📘 player.Name
获取玩家用户昵称。
player.Name: string
📘 player.IsLocal
获取玩家是否为本地玩家(自身用户)。
player.IsLocal: bool
📘 player.IsComplete
获取玩家是否完全加载完毕。
player.IsComplete: bool
📘 player.IsObserver
获取玩家是否当前为相机观察模式(Client.Camera.IsObserver
)。
player.IsObserver: bool
📘 player.CameraMode
获取(只读)玩家相机模式(参考Client.Camera.Mode
)。
player.CameraMode: int
📘 player.Entity
获取玩家绑定的实体对象(角色)。
player.Entity: Character
📘 player.Character
获取玩家绑定的实体对象(角色),作用与player.Entity
完全相同。
player.Character: Character
📘 player.Pos
获取玩家世界坐标位置(通常是玩家屏幕中心位置),如果玩家正在控制角色,则返回角色坐标位置。
player.Pos: Vector
📘 player.FocusPos
获取玩家操作焦点位置(鼠标世界坐标),高度Y轴总是为0
。
player.FocusPos: Vector
📘 player.VoiceState
获取玩家语音聊天状态(是否正在语音聊天)。
player.VoiceState: bool
📒 Static Function
📘 Player.Find()
寻找一个玩家实例(通过ID),不存在则返回null
。
function Player.Find( id: int ): Player
📘 Player.Search()
寻找一个玩家实例(通过模糊查找,通常根据玩家名称\ID,不区分大小写),不存在则返回null
。
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()
寻找一个玩家实例(通过UUID),不存在则返回null
。
function Player.FindByUUID( uuid: string ): Player
📘 Player.GetCount()
获取当前所有存在玩家数量。
function Player.GetCount(): int
📘 Player.Get()
获取当前存在的指定索引玩家,通常搭配GetCount()
遍历使用。
function Player.Get( index: int ): Player
📒 Function
📘 player.GetObserver()
获取玩家视角观察对象(Client.Camera.Target
),如不存在则返回null
。
function player.GetObserver(): Character
📘 player.TestVisiblePoint()
检测玩家相机是否能看到指定坐标(模糊检测,边缘检测并非绝对准确,模拟本地Camera.TestVisiblePoint()
)。
function player.TestVisiblePoint( pos: Vector ): bool