API Reference / api/Player / Player

Class: Player

Defined in: api/Player.d.ts:7

玩家类

Extends

• Mob

Implements

• OfflinePlayer

Methods

addScoreboardTag()

addScoreboardTag(tag): boolean

Defined in: api/actor/Actor.d.ts:149

向该实体添加一个标签。如果标签已经存在，则返回 false，否则返回 true。标签通常用于在服务器上显示和管理玩家的统计信息或属性。

Parameters

tag

string

要添加的标签。

Returns

boolean

如果标签成功添加则返回 true，否则返回 false。

Inherited from

Mob.addScoreboardTag

---

asActor()

asActor(): Actor

Defined in: api/command/CommandSender.d.ts:25

该方法获取一个CommandSender作为Actor。

Returns

Actor

Player，如果不是Actor，则返回null

Inherited from

Mob.asActor

---

asCommandSender()

asCommandSender(): CommandSender

Defined in: api/command/CommandSender.d.ts:11

转成命令发送者

Returns

CommandSender

Inherited from

Mob.asCommandSender

---

asMob()

asMob(): Mob

Defined in: api/actor/Mob.d.ts:13

将实体转换为Mob类型

Returns

Mob

Inherited from

Mob.asMob

---

asPlayer()

asPlayer(): Player

Defined in: api/command/CommandSender.d.ts:37

该方法获取一个CommandSender作为Player。

Returns

Player

Player，如果不是Player，则返回null

Inherited from

Mob.asPlayer

---

closeForm()

closeForm(): void

Defined in: api/Player.d.ts:349

关闭当前打开的表单给玩家。

Returns

void

---

getAddress()

getAddress(): SocketAddress

Defined in: api/Player.d.ts:29

获取此玩家的套接字地址

Returns

SocketAddress

玩家的套接字地址

---

getAllowFlight()

getAllowFlight(): boolean

Defined in: api/Player.d.ts:120

确定玩家是否允许通过跳跃键双击飞行。

Returns

boolean

是否允许玩家通过跳跃键双击飞行

---

getDeviceId()

getDeviceId(): string

Defined in: api/Player.d.ts:315

获取玩家的当前设备 ID。

Returns

string

玩家的设备 ID

---

getDeviceOS()

getDeviceOS(): string

Defined in: api/Player.d.ts:308

获取玩家的当前设备的操作系统（OS）。

Returns

string

玩家的设备 OS

---

getExpLevel()

getExpLevel(): number

Defined in: api/Player.d.ts:97

获取玩家当前经验等级。

Returns

number

当前的经验等级

---

getExpProgress()

getExpProgress(): number

Defined in: api/Player.d.ts:81

获取玩家当前经验进度，接近下一个等级。

这是一个百分比值。0.0表示“没有进度”，1.0表示“下一个级别”。

Returns

number

当前经验点数

---

getFlySpeed()

getFlySpeed(): number

Defined in: api/Player.d.ts:148

获取当前允许客户端飞行的速度。

Returns

number

允许的当前速度，默认为0.05。

---

getGameMode()

getGameMode(): GameMode

Defined in: api/Player.d.ts:280

获取此玩家当前的游戏模式

Returns

GameMode

当前游戏模式

---

getGameVersion()

getGameVersion(): string

Defined in: api/Player.d.ts:322

获取玩家的游戏版本

Returns

string

玩家的游戏版本

---

getHealth()

getHealth(): number

Defined in: api/actor/Actor.d.ts:120

获取实体的健康值。健康值是从 0 到最大值，其中 0 表示该实体已经死亡。这个方法用于获取和设置实体的健康值。如果健康值小于等于 0，则表示该实体已死亡，并且无法进行任何操作。

Returns

number

实体的健康值。

Inherited from

Mob.getHealth

---

getId()

getId(): number

Defined in: api/actor/Actor.d.ts:106

获取该实体的唯一标识符（ID）。ID是用于标识单个实体的唯一标识符，通常是一个整数。它在服务器之间传递实体信息，并且可以在命令中引用特定的实体。

Returns

number

实体的唯一标识符（ID）。

Inherited from

Mob.getId

---

getLocale()

getLocale(): string

Defined in: api/Player.d.ts:301

获取玩家的当前语言环境。

Returns

string

玩家的语言环境

---

getMaxHealth()

getMaxHealth(): number

Defined in: api/actor/Actor.d.ts:134

获取实体的最大健康值。最大健康值是实体可以承受的最大生命值。这个方法用于获取和设置实体的最大健康值。如果最大健康值为零，则表示该实体无法承受任何生命值，并且无法进行任何操作。

Returns

number

实体的最大健康值。

Inherited from

Mob.getMaxHealth

---

getName()

getName(): string

Defined in: api/command/CommandSender.d.ts:65

获取此命令发送者的名称

Returns

string

发送者的名字

Implementation of

OfflinePlayer.getName

Inherited from

Mob.getName

---

getNameTag()

getNameTag(): string

Defined in: api/actor/Actor.d.ts:195

获取角色的当前名称标签。

Returns

string

名称标签。

Inherited from

Mob.getNameTag

---

getPing()

getPing(): number

Defined in: api/Player.d.ts:258

获取玩家的平均 ping

Returns

number

玩家的 ping

---

getRuntimeId()

getRuntimeId(): number

Defined in: api/actor/Actor.d.ts:26

获取实体的运行时ID。

运行时ID是用于标识单个实体的唯一标识符。它在服务器之间传递实体信息，并且可以在命令中引用特定的实体。

Returns

number

实体的运行时ID。

Inherited from

Mob.getRuntimeId

---

getScoreboardTags()

getScoreboardTags(): string[]

Defined in: api/actor/Actor.d.ts:141

获取该实体的所有 scoreboard 标签。这些标签通常用于在服务器上显示和管理玩家的统计信息或属性。

Returns

string[]

实体的所有 scoreboard 标签列表。

Inherited from

Mob.getScoreboardTags

---

getScoreTag()

getScoreTag(): string

Defined in: api/actor/Actor.d.ts:209

获取角色的当前分数标签。

Returns

string

分数标签。

Inherited from

Mob.getScoreTag

---

getServer()

getServer(): Server

Defined in: api/command/CommandSender.d.ts:58

返回运行该命令的服务器实例

Returns

Server

服务器实例

Inherited from

Mob.getServer

---

getSkin()

getSkin(): Skin

Defined in: api/Player.d.ts:329

获取玩家的皮肤

Returns

Skin

玩家的皮肤

---

getTotalExp()

getTotalExp(): number

Defined in: api/Player.d.ts:113

获取玩家总经验点数。

这是当前收集的总经验点数，而不是客户端显示的当前经验点数。

Returns

number

当前总经验点数

---

getType()

getType(): string

Defined in: api/actor/Actor.d.ts:17

获取该实体的类型。

该方法返回实体的类型作为字符串，例如minecraft:pig。它用于获取实体的类型信息，以便可以为其提供相应的功能或属性。

Returns

string

实体的类型。

Inherited from

Mob.getType

---

getUniqueId()

getUniqueId(): UUID

Defined in: api/Player.d.ts:15

返回此玩家的UUID

Returns

UUID

玩家的UUID

Implementation of

OfflinePlayer.getUniqueId

---

getWalkSpeed()

getWalkSpeed(): number

Defined in: api/Player.d.ts:162

获取当前允许客户端行走的速度。

Returns

number

允许的当前速度，默认为0.10。

---

getXuid()

getXuid(): string

Defined in: api/Player.d.ts:22

返回此玩家的Xbox用户ID（XUID）

Returns

string

玩家的Xbox用户ID

---

giveExp()

giveExp(amount): void

Defined in: api/Player.d.ts:65

给玩家指定经验量。

Parameters

amount

number

给予的经验量

Returns

void

---

giveExpLevels()

giveExpLevels(amount): void

Defined in: api/Player.d.ts:72

给玩家指定经验等级。

Parameters

amount

number

要给定或减少的经验等级量

Returns

void

---

hasPermission()

Call Signature

hasPermission(name): boolean

Defined in: api/permissions/Permissible.d.ts:45

获取指定权限的值，如果已设置。如果没有设置此对象中的权限覆盖，则返回权限的默认值

Parameters

name

string

权限名称

Returns

boolean

权限的值

Inherited from

Mob.hasPermission

Call Signature

hasPermission(perm): boolean

Defined in: api/permissions/Permissible.d.ts:53

获取指定权限的值，如果已设置。如果没有设置此对象中的权限覆盖，则返回权限的默认值

Parameters

perm

Permission

权限获取

Returns

boolean

权限的值

Inherited from

Mob.hasPermission

---

isDead()

isDead(): boolean

Defined in: api/actor/Actor.d.ts:113

判断该实体是否已经被标记为死亡或已删除。返回真如果是这样的实体，表示该实体已经死亡，并且无法进行任何操作。

Returns

boolean

true如果实体已经被标记为死亡或已删除。

Inherited from

Mob.isDead

---

isFlying()

isFlying(): boolean

Defined in: api/Player.d.ts:134

检查此玩家是否当前飞行或不是。

Returns

boolean

是否正在飞行，否则为false

---

isGliding()

isGliding(): boolean

Defined in: api/actor/Mob.d.ts:19

检查是否使用滑翔器或任何其他方式飞行的实体。返回真如果是这样的实体。

Returns

boolean

true如果这个实体在滑翔或使用滑翔器等方法飞行。

Inherited from

Mob.isGliding

---

isInLava()

isInLava(): boolean

Defined in: api/actor/Actor.d.ts:61

判断该角色是否处于熔岩中

Returns

boolean

如果该角色在熔岩中，返回true

Inherited from

Mob.isInLava

---

isInWater()

isInWater(): boolean

Defined in: api/actor/Actor.d.ts:54

判断该角色是否处于水中

Returns

boolean

如果该角色在水中，返回true

Inherited from

Mob.isInWater

---

isNameTagAlwaysVisible()

isNameTagAlwaysVisible(): boolean

Defined in: api/actor/Actor.d.ts:181

判断该实体的名称标签是否当前不可见。如果名称标签是不可见，则返回 true，否则返回false。名称标签通常用于在服务器上显示和管理玩家的名称信息或属性。

Returns

boolean

名称标签是否当前不可见。

Inherited from

Mob.isNameTagAlwaysVisible

---

isNameTagVisible()

isNameTagVisible(): boolean

Defined in: api/actor/Actor.d.ts:167

判断该实体的名称标签是否当前可见。如果名称标签是当前可见，则返回 true，否则返回false。名称标签通常用于在服务器上显示和管理玩家的名称信息或属性。

Returns

boolean

名称标签是否当前可见。

Inherited from

Mob.isNameTagVisible

---

isOnGround()

isOnGround(): boolean

Defined in: api/actor/Actor.d.ts:47

判断该实体是否在地面上（即块下）。返回真如果是这样的实体。

Returns

boolean

true如果实体在地面上（即块下）。

Inherited from

Mob.isOnGround

---

isOp()

isOp(): boolean

Defined in: api/permissions/Permissible.d.ts:14

检查此对象是否是服务器管理员

Returns

boolean

true 如果这是服务器管理员，否则 false

Inherited from

Mob.isOp

---

isPermissionSet()

Call Signature

isPermissionSet(name): boolean

Defined in: api/permissions/Permissible.d.ts:29

检查此对象中是否存在指定权限的完全限定名称的覆盖

Parameters

name

string

权限名称

Returns

boolean

如果权限设置，则为 true，否则为 false

Inherited from

Mob.isPermissionSet

Call Signature

isPermissionSet(perm): boolean

Defined in: api/permissions/Permissible.d.ts:37

检查此对象中是否存在指定权限的覆盖

Parameters

perm

Permission

权限检查

Returns

boolean

如果权限设置，则为 true，否则为 false

Inherited from

Mob.isPermissionSet

---

kick()

kick(message): void

Defined in: api/Player.d.ts:58

将玩家踢出并自定义踢出消息。

Parameters

message

string

踢出消息

Returns

void

---

performCommand()

performCommand(command): boolean

Defined in: api/Player.d.ts:273

让玩家执行给定的命令

Parameters

command

string

要执行的命令

Returns

boolean

命令是否成功，否则为 false

---

recalculatePermissions()

recalculatePermissions(): void

Defined in: api/permissions/Permissible.d.ts:84

根据附件的变化值重新计算此对象的权限。这通常很少需要从插件中调用。

Returns

void

Inherited from

Mob.recalculatePermissions

---

removeScoreboardTag()

removeScoreboardTag(tag): boolean

Defined in: api/actor/Actor.d.ts:157

从该实体中删除一个标签。如果标签不存在，则返回 false，否则返回 true。标签通常用于在服务器上显示和管理玩家的统计信息或属性。

Parameters

tag

string

要删除的标签。

Returns

boolean

如果标签成功删除则返回 true，否则返回 false。

Inherited from

Mob.removeScoreboardTag

---

resetTitle()

resetTitle(): void

Defined in: api/Player.d.ts:213

重置玩家显示的标题。这将清除显示的标题和子标题，并重置计时器到默认值。

Returns

void

---

sendErrorMessage()

sendErrorMessage(...message): void

Defined in: api/command/CommandSender.d.ts:51

将这个发送者的错误消息发送出去

Parameters

message

...any[]

错误消息要显示

Returns

void

Inherited from

Mob.sendErrorMessage

---

sendForm()

sendForm(form): void

Defined in: api/Player.d.ts:344

发送表单到玩家。

Parameters

form

表单要发送

MessageForm | ActionForm

Returns

void

---

sendMessage()

sendMessage(...message): void

Defined in: api/command/CommandSender.d.ts:44

将这个发送者的消息发送出去

Parameters

message

...any[]

要显示的消息

Returns

void

Inherited from

Mob.sendMessage

---

sendPopup()

sendPopup(message): void

Defined in: api/Player.d.ts:36

发送玩家弹出消息

Parameters

message

string

要显示的消息

Returns

void

---

sendTip()

sendTip(message): void

Defined in: api/Player.d.ts:43

发送玩家提示消息

Parameters

message

string

要显示的消息

Returns

void

---

sendTitle()

Call Signature

sendTitle(title, subtitle): void

Defined in: api/Player.d.ts:191

发送标题和子标题消息给玩家。如果它们为空字符串，显示将按默认时间更新。标题和子标题将以默认时长显示。

Parameters

title

string

标题文本

subtitle

string

子标题文本

Returns

void

Call Signature

sendTitle(
   title, 
   subtitle, 
   fade_in, 
   stay, 
   fade_out): void

Defined in: api/Player.d.ts:202

发送标题和子标题消息给玩家。如果它们为空字符串，显示将按默认时间更新。

Parameters

title

string

标题文本

subtitle

string

子标题文本

fade_in

number

持续时间（以 ticks 为单位），标题在显示时 fades入。默认值为 10。

stay

number

持续时间（以 ticks 为单位），标题在显示时保持显示。默认值为 70。

fade_out

number

持续时间（以 ticks 为单位），标题在隐藏时 fades出。默认值为 20。

Returns

void

---

sendToast()

sendToast(title, content): void

Defined in: api/Player.d.ts:51

发送玩家提示通知。

Parameters

title

string

提示通知的标题。

content

string

提示通知的内容。

Returns

void

---

setAllowFlight()

setAllowFlight(flight): void

Defined in: api/Player.d.ts:127

设置玩家是否允许通过跳跃键双击飞行。

Parameters

flight

boolean

是否允许飞行

Returns

void

---

setExpLevel()

setExpLevel(level): void

Defined in: api/Player.d.ts:104

设置玩家当前经验等级。

Parameters

level

number

新的经验等级

Returns

void

---

setExpProgress()

setExpProgress(progress): void

Defined in: api/Player.d.ts:90

设置玩家当前经验进度，接近下一个等级。

这是一个百分比值。0.0表示“没有进度”，1.0表示“下一个级别”。

Parameters

progress

number

新的体验进度

Returns

void

---

setFlying()

setFlying(value): void

Defined in: api/Player.d.ts:141

开始或停止玩家飞行。

Parameters

value

boolean

是否飞行

Returns

void

---

setFlySpeed()

setFlySpeed(value): void

Defined in: api/Player.d.ts:155

设置客户端飞行的速度。

Parameters

value

number

新的速度

Returns

void

---

setGameMode()

setGameMode(mode): void

Defined in: api/Player.d.ts:287

设置此玩家的当前游戏模式

Parameters

mode

GameMode

新的游戏模式

Returns

void

---

setHealth()

setHealth(health): void

Defined in: api/actor/Actor.d.ts:127

设置实体的健康值。健康值是从 0 到最大值，其中 0 表示该实体已经死亡。这个方法用于获取和设置实体的健康值。如果健康值小于等于 0，则表示该实体已死亡，并且无法进行任何操作。

Parameters

health

number

实体的健康值。

Returns

void

Inherited from

Mob.setHealth

---

setNameTag()

setNameTag(name): void

Defined in: api/actor/Actor.d.ts:202

设置角色的名称标签。

Parameters

name

string

新的名称标签。

Returns

void

Inherited from

Mob.setNameTag

---

setNameTagAlwaysVisible()

setNameTagAlwaysVisible(invisible): boolean

Defined in: api/actor/Actor.d.ts:188

设置该实体的名称标签为不可见或可见。如果名称标签是可见，则返回 false，否则返回true。名称标签通常用于在服务器上显示和管理玩家的名称信息或属性。

Parameters

invisible

string

是否设置名称标签为不可见。

Returns

boolean

Inherited from

Mob.setNameTagAlwaysVisible

---

setNameTagVisible()

setNameTagVisible(visible): void

Defined in: api/actor/Actor.d.ts:174

设置该实体的名称标签为可见或不可见。如果名称标签是不可见，则返回 false，否则返回 true。名称标签通常用于在服务器上显示和管理玩家的名称信息或属性。

Parameters

visible

string

是否设置名称标签为可见。

Returns

void

Inherited from

Mob.setNameTagVisible

---

setOp()

setOp(value): void

Defined in: api/permissions/Permissible.d.ts:21

设置此对象的管理员状态

Parameters

value

boolean

新的管理员值

Returns

void

Inherited from

Mob.setOp

---

setScoreTag()

setScoreTag(score): void

Defined in: api/actor/Actor.d.ts:216

设置角色的分数标签。

Parameters

score

string

新的分数标签。

Returns

void

Inherited from

Mob.setScoreTag

---

setWalkSpeed()

setWalkSpeed(value): void

Defined in: api/Player.d.ts:169

设置客户端行走的速度。

Parameters

value

number

新的速度

Returns

void

---

toString()

toString(): string

Defined in: api/Player.d.ts:8

Returns

string

Implementation of

OfflinePlayer.toString

Overrides

Mob.toString

---

transfer()

transfer(host, port): void

Defined in: api/Player.d.ts:337

将玩家转移到另一个服务器

Parameters

host

string

转移玩家到的服务器地址

port

number

转移玩家到的服务器端口

Returns

void

---

updateCommands()

updateCommands(): void

Defined in: api/Player.d.ts:265

将命令列表发送到客户端。

通常在权限更改完成后，确保客户端有完整的命令列表。

Returns

void