LogoArcartX Doc
服务端Aria玩家对象

玩家信息

玩家对象:获取玩家状态信息

  • 以下函数的目标对象为玩家(Player),仅在目标为玩家时可用。

getLevel()

  • 获取玩家当前经验等级
  • 参数:无
  • 返回值:整数类型
  • 调用示例
玩家对象.getLevel()

getExp()

  • 获取玩家当前等级的经验进度,范围为 0.0 到 1.0
  • 参数:无
  • 返回值:单精度浮点数类型
  • 调用示例
玩家对象.getExp()

getExpToLevel()

  • 获取玩家升到下一级所需的经验值
  • 参数:无
  • 返回值:整数类型
  • 调用示例
玩家对象.getExpToLevel()

getTotalExperience()

  • 获取玩家累计经验值
  • 参数:无
  • 返回值:整数类型
  • 调用示例
玩家对象.getTotalExperience()

getGameMode()

  • 获取玩家当前游戏模式名称,例如 SURVIVAL 或 CREATIVE
  • 参数:无
  • 返回值:字符串类型
  • 调用示例
玩家对象.getGameMode()

getLocale()

  • 获取玩家客户端上报的语言代码,例如 zh_cn
  • 参数:无
  • 返回值:字符串类型
  • 调用示例
玩家对象.getLocale()

getPing()

  • 获取玩家当前网络延迟,单位为毫秒
  • 参数:无
  • 返回值:整数类型
  • 调用示例
玩家对象.getPing()

getSaturation()

  • 获取玩家当前饱和度
  • 参数:无
  • 返回值:单精度浮点数类型
  • 调用示例
玩家对象.getSaturation()

getExhaustion()

  • 获取玩家当前消耗度
  • 参数:无
  • 返回值:单精度浮点数类型
  • 调用示例
玩家对象.getExhaustion()

getWalkSpeed()

  • 获取玩家当前行走速度
  • 参数:无
  • 返回值:单精度浮点数类型
  • 调用示例
玩家对象.getWalkSpeed()

getFlySpeed()

  • 获取玩家当前飞行速度
  • 参数:无
  • 返回值:单精度浮点数类型
  • 调用示例
玩家对象.getFlySpeed()

hasPermission(permission)

  • 判断玩家是否拥有指定权限
  • 参数:permission — 字符串类型,权限节点;参数缺失、多余或为空时返回 false
  • 返回值:布尔类型
  • 调用示例
玩家对象.hasPermission("arcartx.admin")

isOp()

  • 判断玩家是否为服务器管理员
  • 参数:无
  • 返回值:布尔类型
  • 调用示例
玩家对象.isOp()

isOnline()

  • 判断玩家当前是否在线
  • 参数:无
  • 返回值:布尔类型
  • 调用示例
玩家对象.isOnline()

isBlocking()

  • 判断玩家是否正在使用物品格挡
  • 参数:无
  • 返回值:布尔类型
  • 调用示例
玩家对象.isBlocking()

isFlightAllowed()

  • 判断玩家当前是否被允许飞行;该状态不代表玩家正在飞行
  • 参数:无
  • 返回值:布尔类型
  • 调用示例
玩家对象.isFlightAllowed()

isAfterJump()

  • 判断玩家是否处于「刚跳跃」的状态(起跳后的短暂时间窗口内)
  • 参数:无
  • 返回值:布尔类型
  • 调用示例
玩家对象.isAfterJump()

isSprinting()

  • 判断玩家是否正在奔跑
  • 参数:无
  • 返回值:布尔类型
  • 调用示例
玩家对象.isSprinting()

isSneaking()

  • 判断玩家是否正在潜行
  • 参数:无
  • 返回值:布尔类型
  • 调用示例
玩家对象.isSneaking()

isFlying()

  • 判断玩家是否正在飞行
  • 参数:无
  • 返回值:布尔类型
  • 调用示例
玩家对象.isFlying()

getFood()

  • 获取玩家饱食度
  • 参数:无
  • 返回值:整数类型
  • 调用示例
玩家对象.getFood()

getPlaceholder(placeholder)

  • 以该玩家为对象解析 PlaceholderAPI 变量,并返回解析后的字符串
  • 参数:placeholder — 字符串类型,待解析的 PAPI 变量文本(如 %player_name%)
  • 返回值:字符串类型(解析结果;参数数量不为 1 时返回空字符串)
  • 调用示例
玩家对象.getPlaceholder("%player_name%")