Class ScriptWorld<S>

constructor

• new ScriptWorld<S extends ISession = ISession>(
      app: Application,
      session: S,
      isWebSocket: boolean,
  ): ScriptWorld<S>

  Type Parameters

  • S extends ISession = ISession

  Parameters

  • app: Application
  • session: S
  • isWebSocket: boolean

  Returns ScriptWorld<S>

Readonly_dimensions

ReadonlyconnectedAt

Readonlylogger

Readonlyplayers

Readonlyscoreboard

Readonlysession

averagePing

• get averagePing(): number

  Returns number

name

• get name(): string

  Returns string

disconnect

• disconnect(reason?: DisconnectReason): Promise<void>

  Parameters

  • Optionalreason: DisconnectReason

  Returns Promise<void>

getPlayerList

• getPlayerList(): { current: number; max?: number; players: ScriptPlayer[] }

  Returns { current: number; max?: number; players: ScriptPlayer[] }

getPlayers

• getPlayers(): ScriptPlayer[]

  Returns ScriptPlayer[]

getTPS

• getTPS(): Promise<number>

  Returns Promise<number>

isLocal

• isLocal(): this is ScriptWorld<SocketSession>

  Returns this is ScriptWorld<SocketSession>

isServer

• isServer(): this is ScriptWorld<Session>

  Returns this is ScriptWorld<Session>

onChatSend

• onChatSend(senderUniqueId: UniqueId, message: string): void

  Parameters

  • senderUniqueId: UniqueId
  • message: string

  Returns void

onInitialize

• onInitialize(data: { players: PlayerDescriptor[] }): void

  Parameters

  • data: { players: PlayerDescriptor[] }

  Returns void

onPlayerJoin

• onPlayerJoin(descriptor: PlayerDescriptor): void

  Parameters

  • descriptor: PlayerDescriptor

  Returns void

onPlayerLeave

• onPlayerLeave(playerUniqueId: UniqueId): void

  Parameters

  • playerUniqueId: UniqueId

  Returns void

runCommand

• runCommand(command: string): Promise<{ successCount: number }>

  Parameters

  • command: string

  Returns Promise<{ successCount: number }>

sendMessage

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

  Parameters

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

  Returns Promise<void>

sendScriptEvent

• sendScriptEvent(id: string, message: string): Promise<void>

  Parameters

  • id: string
  • message: string

  Returns Promise<void>