Class ScriptPlayer

constructor

• new ScriptPlayer(world: ScriptWorld, descriptor: PlayerDescriptor): ScriptPlayer

  Parameters

  • world: ScriptWorld
  • descriptor: PlayerDescriptor

  Returns ScriptPlayer

Readonlyname

ReadonlynameTag

ReadonlyonScreenDisplay

ReadonlyuniqueId

Readonlyworld

isValid

• get isValid(): boolean

  Returns boolean

getDimension

• getDimension(): Promise<ScriptDimension>

  Returns Promise<ScriptDimension>

getGameMode

• getGameMode(): Promise<GameMode>

  Returns Promise<GameMode>

getLocation

• getLocation(): Promise<Vector3>

  Returns Promise<Vector3>

kick

• kick(reason?: string): Promise<void>

  Parameters

  • Optionalreason: string

  Returns Promise<void>

sendMessage

• sendMessage(
      message: string | RawMessage | (string | RawMessage)[],
  ): Promise<void>

  Parameters

  • message: string | RawMessage | (string | RawMessage)[]

  Returns Promise<void>

setGameMode

• setGameMode(gameMode: GameMode): Promise<void>

  Parameters

  • gameMode: GameMode

  Returns Promise<void>