#Class: AsyncPlayerJoinBeforeEvent deprecated

event player

Beta

玩家加入世界前可获得的数据。

The data available before a player joins the world.

#Properties

#name

readonly name: string

Beta

#Remarks

玩家的名称。

The player's name

---

#persistentId

readonly persistentId: string

Beta

#Remarks

一个可用于跨会话识别玩家的标识符。

An identifier that can be used to identify a player across sessions.

---

#splitScreenSlot?

readonly optional splitScreenSlot?: any

Beta

#Remarks

加入玩家的分屏槽位；若玩家不在分屏会话中则为 undefined。

The split screen slot of the joining player or undefined if the player is not in a split screen session.

#Methods

#allowJoin()

allowJoin(): void

Beta

#Returns

void

#Remarks

调用此方法可显式允许玩家加入服务器。当玩家加入被禁用时（在专用服务器上 allow-player-joining 被设置为 false）很有用。

Call this to explicitly allow the player to join the server. This is useful when player joining is disabled (allow-player-joining is set to false when playing on dedicated server).

#Throws

This function can throw errors.

DisconnectedError

---

#disallowJoin()

disallowJoin(reason?): void

Beta

#Parameters

#reason?

string

#Returns

void

#Remarks

调用此方法以拒绝玩家加入服务器。可用于阻止未授权的访问。

Call this to disallow the player from joining the server. This is useful for preventing unauthorized access to the server.

#Throws

This function can throw errors.

DisconnectedError

---

#disconnect()

disconnect(reason?): void

Beta

#Parameters

#reason?

string

#Returns

void

#Remarks

#Throws

This function can throw errors.

DisconnectedError

---

#isValid()

isValid(): boolean

Beta

#Returns

boolean

#Remarks

若玩家仍在等待加入世界则返回 true。若玩家已断开连接则返回 false。

Will return true if the player is still waiting to join the world. If they disconnect then it will return false.

#同领域相关

• AsyncPlayerJoinBeforeEventSignal
• BlockComponentPlayerBreakEvent
• BlockComponentPlayerInteractEvent
• BlockComponentPlayerPlaceBeforeEvent
• PlayerBreakBlockAfterEvent
• PlayerBreakBlockAfterEventSignal