ArenaEdit API手册

Appearance

S-👤 游戏玩家 ​

GamePlayer 是整个游戏世界的可由玩家自主控制的实体，它提供了以下核心功能：

  • 玩家信息：管理玩家的基本信息、社交关系和统计数据
  • 外观系统：控制玩家的外观、皮肤、穿戴物品等视觉效果
  • 相机系统：管理玩家的视角模式、视场角、跟随目标等
  • 音效系统：控制玩家听到的音乐、音效和环境声
  • 输入系统：处理玩家的键盘、鼠标、触屏等输入
  • 战斗系统：管理玩家的生命、死亡、重生等状态
  • 交互系统：处理玩家的对话、商店、传送等功能

你可以通过实体的 player 属性来使用这些功能。

类定义 ​

typescript
declare class GamePlayer {
  //...
}

属性列表 ​

基础信息 ​

  • name : 玩家的昵称
  • userId : 玩家的用户 ID，个人中心昵称下方可见
  • boxId : 玩家的 Box ID(3-15 字符)
  • userKey : 玩家的唯一识别码(16 字符)
  • avatar : 玩家的头像 url 直链
  • movementBounds : 玩家的活动范围限制，如超出此范围，则传回出生点
  • url : 获取该玩家进入地图时所用的 URL 链接地址

外观系统 ​

相机系统 ​

  • 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 : 当玩家重生时，播放的音效
  • stepSound : 当玩家行走时，每迈出一步，播放的音效
  • startFlySound : 玩家开始飞行时的音效
  • stopFlySound : 玩家结束飞行时播放的音效

渲染效果 ​

  • colorLUT : 用于渲染玩家所见游戏世界的色调

战斗系统 ​

  • dead : 玩家是否已死亡，生命值 hp 低于 0。若玩家死亡，则会倒在地上
  • spawnPoint : 玩家复活后的出生点

输入系统 ​

移动控制 ​

方法 ​

基础信息 ​

外观系统 ​

  • setSkinByName : 将指定皮肤套装应用到此玩家上
  • resetToDefaultSkin : 重置此玩家的皮肤配置为默认皮肤配置
  • clearSkin : 清除地图对此玩家应用的皮肤配置
  • addWearable : 在玩家某身体部位附上穿戴配件物体
  • removeWearable : 把玩家身体部位已附上的穿戴配件物体删除
  • wearables : 列举在玩家上所有的穿戴配件物体

动画系统 ​

相机系统 ​

  • setCameraPitch : 设置玩家视角准心绕水平方向的旋转弧度
  • setCameraYaw : 设置玩家视角准心绕垂直方向的旋转弧度

音效系统 ​

  • sound : 为指定的玩家播放声音，此声音仅该玩家能听见

战斗系统 ​

  • forceRespawn : 让玩家强制重生，立即返回出生点

交互系统 ​

  • kick : 把玩家"踢出