Class World

Readonly Beta events

Readonly Beta scoreboard

broadcastClientMessage

• broadcastClientMessage(id, value): void
• Beta

  Parameters

  • id: string

  • value: string

  Returns void

  Remarks

  A method that is internal-only, used for broadcasting specific messages between client and server.

getAbsoluteTime

• getAbsoluteTime(): number
• Beta

  Returns number

  Remarks

  Returns the absolute time since the start of the world.

getAllPlayers

• getAllPlayers(): Player[]

• Returns Player[]

  Remarks

  Returns an array of all active players within the world.

  Throws

  This function can throw errors.

getDefaultSpawnPosition

• getDefaultSpawnPosition(): Vector3

• Returns Vector3

getDimension

• getDimension(dimensionId): Dimension

• Parameters

  • dimensionId: string

  Returns Dimension

  The requested dimension

  Remarks

  Returns a dimension object.

  Throws

  Throws if the given dimension name is invalid

getDynamicProperty

• getDynamicProperty(identifier): undefined | string | number | boolean
• Beta

  Parameters

  • identifier: string

  Returns undefined | string | number | boolean

  Returns the value for the property, or undefined if the property has not been set.

  Remarks

  Returns a property value.

  Throws

  This function can throw errors.

getPlayers

• getPlayers(options?): PlayerIterator
• Beta

  Parameters

  • Optional options: EntityQueryOptions

  Returns PlayerIterator

  All players currently in the world.

  Remarks

  Returns all players currently in the world.

  Throws

  This function can throw errors.

getTime

• getTime(): number
• Beta

  Returns number

  Remarks

  Sets the current game time of the day.

playMusic

• playMusic(trackID, musicOptions?): void
• Beta

  Parameters

  • trackID: string

  • Optional musicOptions: MusicOptions

  Returns void

  Remarks

  Plays a particular music track for all players.

playSound

• playSound(soundID, soundOptions?): void
• Beta

  Parameters

  • soundID: string

  • Optional soundOptions: SoundOptions

  Returns void

  Remarks

  Plays a sound for all players.

queueMusic

• queueMusic(trackID, musicOptions?): void
• Beta

  Parameters

  • trackID: string

  • Optional musicOptions: MusicOptions

  Returns void

  Remarks

  Queues an additional music track for players. If a track is not playing, a music track will play.

removeDynamicProperty

• removeDynamicProperty(identifier): boolean
• Beta

  Parameters

  • identifier: string

  Returns boolean

  Remarks

  Removes a specified property.

  Throws

  This function can throw errors.

sendMessage

• sendMessage(message): void

• Parameters

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

  Returns void

setDefaultSpawn

• setDefaultSpawn(spawnPosition): void

• Parameters

  • spawnPosition: Vector3

  Returns void

setDynamicProperty

• setDynamicProperty(identifier, value): void
• Beta

  Parameters

  • identifier: string

  • value: string | number | boolean

    Data value of the property to set.

  Returns void

  Remarks

  Sets a specified property to a value.

  Throws

  This function can throw errors.

setTime

• setTime(timeOfDay): void
• Beta

  Parameters

  • timeOfDay: number

  Returns void

  Remarks

  Returns the current game time of the day.

stopMusic

• stopMusic(): void
• Beta

  Returns void

  Remarks

  Stops any music tracks from playing.