Class AsyncPlayerJoinBeforeEventBeta

Readonly Betaname

Readonly BetapersistentId

allowJoin

• allowJoin(): void
  Beta

  Returns void

  Remarks

  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?: string): void
  Beta

  Parameters

  • Optionalreason: string

  Returns void

  Remarks

  Deprecated - use disallowJoin instead.Call this to disconnect a player. They will be allowed to try to join again.

  Throws

  This function can throw errors.

  DisconnectedError

disconnect

• disconnect(reason?: string): void
  Beta

  Parameters

  • Optionalreason: string

  Returns void

  Remarks

  Call this to stop the player from joining the server. They will be allowed to try to join again.

  Throws

  This function can throw errors.

  DisconnectedError

isValid

• isValid(): boolean
  Beta

  Returns boolean

  Remarks

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