Appearance
👤游戏玩家
- GamePlayer 是整个游戏世界的可由玩家自主控制的实体,玩家指的是进入游戏的用户,此接口可用定义游戏中的玩家属性、操作等等。玩家属于一种特殊的实体。
类
typescript
declare class GamePlayer {
//...
}
属性
name
: 玩家的昵称userId
: 玩家的用户ID,个人中心昵称下方可见boxId
: 玩家的Box ID(3-15字符)userKey
: 玩家的唯一识别码(16字符)avatar
: 玩家的头像url直链movementBounds
: 玩家的活动范围限制,如超出此范围,则传回出生点url
: 获取该玩家进入地图时所用的URL链接地址color
: 玩家的颜色emissive
: 玩家的发光度invisible
: 玩家是否隐身showName
: 玩家名字是否显示showIndicator
: 玩家标记否显示scale
: 玩家的缩放比例metalness
: 玩家的金属感shininess
: 玩家的反光度skin
: 此玩家的皮肤配置,用于管理当前玩家皮肤的展示skinInvisible
: 是否隐藏玩家模型部件cameraMode
: 视角模式cameraEntity
: 在第一人称视角(FPS)或第三人称跟随视角(FOLLOW)下,玩家视角所跟随的实体cameraPosition
: 固定视角(FIXED)和相对视角(RELATIVE)下,摄像机本身所处的位置cameraTarget
: 固定视角(FIXED)和相对视角(RELATIVE)下,摄像机看向的目标点cameraUp
: 固定视角(FIXED)和相对视角(RELATIVE)下,摄像机镜头向上的矢量cameraFovY
: 垂直方向的视场角enable3DCursor
: 启动玩家的3D光标cameraFreezedAxis
: 相对视角(RELATIVE)下,下冻结相机轴freezedForwardDirection
: 如果不为null,眼睛看向指定方向且锁定左右旋转,只可以上下移动。cameraDistance
: 摄像机离跟随目标的距离,这决定了相机在场景中观察目标时的相对位置。music
: 为指定的玩家播放背景音乐(循环播放),此声音仅该玩家能听见,其他玩家无法听到。 背景音乐的音量会根据用户在[设置-声音]更改。action0Sound
: 当玩家按下 'action0' 按键(鼠标左键 / 虚拟按钮A)时,播放的音效。action1Sound
: 当玩家按下 'action1' 按键(鼠标右键 / 虚拟按钮B)时,播放的音效。crouchSound
: 当玩家按下 'crouchButton ' 按键进行蹲下时,播放的音效。jumpSound
: 当玩家按下 'jumpButton ' 按键进行跳跃时,播放的音效doubleJumpSound
: 当玩家触发二段跳时,播放的音效landSound
: 玩家落地时,播放的音效enterWaterSound
: 当玩家进入液体时,播放的音效leaveWaterSound
: 当玩家离开液体时,播放的音效swimSound
: 当玩家正在游泳时,播放的音效spawnSound
: 当玩家重生时,播放的音效。通过entity.player.onRespawn()
触发stepSound
: 当玩家行走时,每迈出一步,播放的音效startFlySound
: 玩家开始飞行时的音效stopFlySound
: 玩家结束飞行时播放的音效colorLUT
: 用于渲染玩家所见游戏世界的色调dead
: 玩家是否已死亡,生命值hp低于0。若玩家死亡,则会倒在地上。spawnPoint
: 玩家复活后的出生点gamepad
: 设置虚拟按键图片disableInputDirection
: 禁用指定方向的摇杆输入偏移量,当横纵两个方向均被禁用时,将不显示此玩家的触屏虚拟摇杆。enableAction0
: 启动鼠标左键/移动端虚拟按钮A键enableAction1
: 启动鼠标右键/移动端虚拟按钮B键action0Button
: 鼠标左键/移动端虚拟按钮A键action1Button
: 鼠标右键/移动端虚拟按钮B键jumpButton
: 跳跃按钮walkButton
: 步行按钮swapInputDirection
: 是否交换方向按键reverseInputDirection
: 反转指定方向的摇杆facingDirection
: 玩家朝向canFly
: 是否允许玩家飞行spectator
: 玩家是否是一个幽灵,可以穿墙enableJump
: 是否允许玩家跳跃enableDoubleJump
: 是否允许玩家二段跳跃walkSpeed
: 最大步行速度天runSpeed
: 最大奔跑速度runAcceleration
: 奔跑加速度jumpPower
: 跳跃力度jumpSpeedFactor
: 跳跃速度jumpAccelerationFactor
: 跳跃加速率doubleJumpPower
: 二段跳力度crouchSpeed
: 蹲着走路的速度crouchAcceleration
: 蹲着走路的加速度flySpeed
: 最大飞行速度flyAcceleration
: 飞行加速度swimAcceleration
: 游泳加速度swimSpeed
: 最大游泳速度walkAcceleration
: 步行加速度moveState
: 玩家的运动状态walkState
: 玩家的步行状态cameraPitch
: 玩家视角准心绕水平方向的旋转弧度cameraYaw
: 玩家视角准心绕垂直方向的旋转弧度
方法
querySocial
: 查询当前玩家的社交关系querySocialStatistic
: 查询当前玩家的社交统计信息openUserProfileDialog
: 对当前玩家,调起指定ID玩家的个人主页setSkinByName
: 将指定皮肤套装应用到此玩家上。此方法不会影响皮肤的隐藏状态,设置前是隐藏的,设置后也还是隐藏着。resetToDefaultSkin
: 重置此玩家的皮肤配置为默认皮肤配置,效果同setSkinByName()
传入了默认皮肤套装名称。clearSkin
: 清除地图对此玩家应用的皮肤配置,将此玩家的皮肤配置为仅展示玩家自己的皮肤。addWearable
: 在玩家某身体部位附上穿戴配件物体removeWearable
: 把玩家身体部位已附上的穿戴配件物体删除wearables
: 列举在玩家上所有的穿戴配件物体animate
: 创建一个关键帧动画getAnimations
: 获取玩家的所有已创建的动画setCameraPitch
: 设置玩家视角准心绕水平方向的旋转弧度setCameraYaw
: 设置玩家视角准心绕垂直方向的旋转弧度sound
: 为指定的玩家播放声音,此声音仅该玩家能听见,其他玩家无法听到。forceRespawn
: 让玩家强制重生,立即返回出生点kick
: 把玩家"踢出"当前地图directMessage
: 向玩家直接发送私信dialog
: 在游戏中显示一个对话框cancelDialogs
: 关闭该玩家的所有打开的对话框link
: 在玩家弹出一个“传送门”窗口,可以跳转到其他地图或任意链接。openMarketplace
: 打开游戏商店对话框,根据传入的“商品ID”显示相应的产品。getMiaoShells
: 获取此用户在当前地图下累计打赏的喵贝壳
监听方法
onRespawn
: 玩家复活时调用的事件onPress
: 当玩家按下按钮时调用onRelease
: 当玩家松开按钮时调用onKeyDown
: 当玩家按下键盘时调用onKeyUp
: 当玩家松开键盘时调用onChat
: 当前玩家发起聊天时调用
接口
GameSkin
: 玩家身体部位GameSkinInvisible
: 玩家身体部位GameWearable
: 用于在玩家身体部位可穿戴配件物体的参数与函数GamePlayerKeyframe
: Player玩家动画关键帧参数,可对Player的大部分属性做动画效果,例如尺寸、颜色、隐身等等GameKeyBoardEvent
: 输入事件,在玩家按下或松开按键时触发。Gamepad
: 虚拟按键背景图片配置GamePlayerMoveState
: 玩家的运动状态GamePlayerWalkState
: 玩家的行走状态GameInputDirection
: 玩家通过输入设备控制移动时的方向GameDialogCall
: 在游戏中显示一个对话框GameDialogResponse
: 对话框回应GameDialogSelectResponse
: 选项对话框回应SocialStatisticType
: 社交统计信息的类型
枚举
SocialType
: 玩家的社交关系类型GameBodyPart
: 玩家身体部位的类型GameCameraMode
: 玩家的相机视角模式GameCameraFreezedAxis
: 玩家的轴模式GameDialogType
: 对话框样式类型