Skip to content

API Reference / api/Server / Server

Class: Server

Defined in: api/Server.d.ts:6

表示一个服务器实现。

Accessors

BroadcastChannelAdmin

Get Signature

ts
get static BroadcastChannelAdmin(): string

Defined in: api/Server.d.ts:294

用于所有管理消息,例如操作员使用命令时的消息。

Returns

string


BroadcastChannelUser

Get Signature

ts
get static BroadcastChannelUser(): string

Defined in: api/Server.d.ts:299

用于所有公告消息,比如通知用户有玩家加入。

Returns

string

Methods

broadcast()

ts
broadcast(message, permission): void

Defined in: api/Server.d.ts:156

向具有指定权限名称的每个用户广播特定消息。

Parameters

message

Message

要广播的消息

permission

string

接收广播的权限主体必须具备的所需权限

Returns

void


broadcastMessage()

ts
broadcastMessage(message): void

Defined in: api/Server.d.ts:163

向拥有“endstone.broadcast.user”权限的每位用户广播指定消息。

Parameters

message

Message

消息内容

Returns

void


dispatchCommand()

ts
dispatchCommand(sender, command_line): any

Defined in: api/Server.d.ts:73

在这个服务器上派发命令,并如果找到,则执行它。

Parameters

sender

CommandSender

看似命令发送者的对象

command_line

string

命令及其参数。

Returns

any

如果执行成功,返回true;否则,返回false


getAverageMillisecondsPerTick()

ts
getAverageMillisecondsPerTick(): number

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

获取平均每刻的毫秒数(MSPT)。

Returns

number

平均每刻的毫秒数。


getAverageTicksPerSecond()

ts
getAverageTicksPerSecond(): number

Defined in: api/Server.d.ts:216

获取平均每秒刻数(TPS)。

Returns

number

平均每秒刻数


getAverageTickUsage()

ts
getAverageTickUsage(): number

Defined in: api/Server.d.ts:230

获取服务器的平均刻使用率。

Returns

number

平均刻使用率的百分比。


getCurrentMillisecondsPerTick()

ts
getCurrentMillisecondsPerTick(): number

Defined in: api/Server.d.ts:195

获取当前每刻的毫秒数(MSPT)。

Returns

number

当前每刻的平均毫秒数。


getCurrentTicksPerSecond()

ts
getCurrentTicksPerSecond(): number

Defined in: api/Server.d.ts:209

获取当前每秒刻数(TPS)。

Returns

number

当前每秒刻数


getCurrentTickUsage()

ts
getCurrentTickUsage(): number

Defined in: api/Server.d.ts:223

获取服务器当前的刻使用率。

Returns

number

当前刻使用率的百分比。


getLevel()

ts
getLevel(): Level

Defined in: api/Server.d.ts:87

获取服务器 level.

Returns

Level

服务器 level


getLogger()

ts
getLogger(): Logger

Defined in: api/Server.d.ts:35

返回与这个服务器实例关联的主日志记录器。

Returns

Logger

与这个服务器关联的日志记录器


getMaxPlayers()

ts
getMaxPlayers(): number

Defined in: api/Server.d.ts:101

获取可登录此服务器的最大玩家数量。

Returns

number

此服务器允许的玩家数量


getMinecraftVersion()

ts
getMinecraftVersion(): string

Defined in: api/Server.d.ts:28

获取这个服务器正在运行的Minecraft版本。

Returns

string

Minecraft版本


getName()

ts
getName(): string

Defined in: api/Server.d.ts:14

获取这个服务器实现的名称。

Returns

string

这个服务器实现的名称


getOnlineMode()

ts
getOnlineMode(): boolean

Defined in: api/Server.d.ts:123

获取服务器是否处于在线模式。

Returns

boolean

如果服务器对客户端进行身份验证,则返回true;否则返回false


getOnlinePlayers()

ts
getOnlinePlayers(): Player[]

Defined in: api/Server.d.ts:94

获取当前在线的玩家。

Returns

Player[]

当前在线的玩家


getPlayer()

Call Signature

ts
getPlayer(uuid): Player

Defined in: api/Server.d.ts:116

根据给定的通用唯一识别码(UUID)获取玩家信息。

Parameters
uuid

UUID

要检索的玩家的通用唯一识别码(UUID)

Returns

Player

如果找到,则返回一个玩家对象;否则返回 null

Call Signature

ts
getPlayer(name): Player

Defined in: api/Server.d.ts:131

根据给定的准确名称(不区分大小写)获取玩家。

Parameters
name

string

要检索的玩家的准确名称

Returns

Player

如果找到则返回一个玩家对象,否则返回 null


getStartTime()

ts
getStartTime(): number

Defined in: api/Server.d.ts:237

获取服务器的启动时间。

Returns

number

服务器的启动时间。


getVersion()

ts
getVersion(): string

Defined in: api/Server.d.ts:21

获取这个服务器实现的版本字符串。

Returns

string

这个服务器实现的版本


isPrimaryThread()

ts
isPrimaryThread(): boolean

Defined in: api/Server.d.ts:170

将当前线程与预期的主服务器线程进行比对

Returns

boolean

如果当前线程与预期的主线程匹配,则返回true,否则返回false


reload()

ts
reload(): void

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

重新加载服务器配置、功能、脚本和插件。

Returns

void


reloadData()

ts
reloadData(): void

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

仅重新加载服务器的 Minecraft 数据。

这包括所有行为包中的函数和脚本文件。

Returns

void


setMaxPlayers()

ts
setMaxPlayers(max_players): void

Defined in: api/Server.d.ts:108

设置允许同时登录的最大玩家数量。

Parameters

max_players

number

最大并发玩家数量

Returns

void


shutdown()

ts
shutdown(): void

Defined in: api/Server.d.ts:136

关闭服务器,停止所有运行。

Returns

void


toString()

ts
toString(): string

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

Returns

string