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.

  This function can't be called in read-only mode.

getAbsoluteTime

• getAbsoluteTime(): number
• Beta

  Returns number

  Remarks

  Returns the absolute time since the start of the world.

  This function can't be called in read-only mode.

getAllPlayers

• getAllPlayers(): Player[]

• Returns Player[]

  Remarks

  Returns an array of all active players within the world.

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.

getDefaultSpawnPosition

• getDefaultSpawnPosition(): Vector3
• Beta

  Returns Vector3

  Returns the default spawn position.

  Remarks

  Returns the default spawn position within the world where players are spawned if they don't have a specific spawn position set.

  This function can't be called in read-only mode.

getDimension

• getDimension(dimensionId): Dimension

• Parameters

  • dimensionId: string

  Returns Dimension

  The requested dimension

  Remarks

  Returns a dimension object.

  This function can't be called in read-only mode.

  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.

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.

getEntity

• getEntity(id): undefined | Entity
• Beta

  Parameters

  • id: string

    The id of the entity.

  Returns undefined | Entity

  The requested entity object.

  Remarks

  Returns an entity based on the provided id.

  This function can't be called in read-only mode.

  Throws

  Throws if the given entity id is invalid.

getPlayers

• getPlayers(options?): Player[]

• Parameters

  • Optional options: EntityQueryOptions

    Additional options that can be used to filter the set of players returned.

  Returns Player[]

  A player array.

  Remarks

  Returns a set of players based on a set of conditions defined via the EntityQueryOptions set of filter criteria.

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.

getTime

• getTime(): number
• Beta

  Returns number

  Remarks

  Sets the current game time of the day.

  This function can't be called in read-only mode.

playMusic

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

  Parameters

  • trackID: string

  • Optional musicOptions: MusicOptions

  Returns void

  Remarks

  Plays a particular music track for all players.

  This function can't be called in read-only mode.

playSound

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

  Parameters

  • soundID: string

  • Optional soundOptions: SoundOptions

  Returns void

  Remarks

  Plays a sound for all players.

  This function can't be called in read-only mode.

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.

  This function can't be called in read-only mode.

removeDynamicProperty

• removeDynamicProperty(identifier): boolean
• Beta

  Parameters

  • identifier: string

  Returns boolean

  Remarks

  Removes a specified property.

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.

sendMessage

• sendMessage(message): void

• Parameters

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

    The message to be displayed.

  Returns void

  Remarks

  Sends a message to all players.

  This function can't be called in read-only mode.

  Throws

  This method can throw if the provided RawMessage is in an invalid format. For example, if an empty name string is provided to score.

  Example

  nestedTranslation.ts

         // Displays "Apple or Coal"
         let rawMessage = {
           translate: "accessibility.list.or.two",
           with: { rawtext: [{ translate: "item.apple.name" }, { translate: "item.coal.name" }] },
         };
         world.sendMessage(rawMessage);
  
  Copy

  Example

  scoreWildcard.ts

         // Displays the player's score for objective "obj". Each player will see their own score.
         const rawMessage = { score: { name: "*", objective: "obj" } };
         world.sendMessage(rawMessage);
  
  Copy

  Example

  simpleString.ts

         // Displays "Hello, world!"
         world.sendMessage("Hello, world!");
  
  Copy

  Example

  translation.ts

         // Displays "First or Second"
         const rawMessage = { translate: "accessibility.list.or.two", with: ["First", "Second"] };
         world.sendMessage(rawMessage);
  
  Copy

setDefaultSpawn

• setDefaultSpawn(spawnPosition): void
• Beta

  Parameters

  • spawnPosition: Vector3

    Location within the overworld where a player will spawn.

  Returns void

  Remarks

  Sets the default spawn location for players within the world. Note that players can override this with their own spawn position. Note also that the default spawn position must be in the overworld dimension.

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.

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.

  This function can't be called in read-only mode.

  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.

  This function can't be called in read-only mode.

stopMusic

• stopMusic(): void
• Beta

  Returns void

  Remarks

  Stops any music tracks from playing.

  This function can't be called in read-only mode.