Class World

Readonly Betaevents

Readonly Betascoreboard

broadcastClientMessage

• broadcastClientMessage(id: string, value: string): 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.

getDynamicProperty

• getDynamicProperty(identifier: string): 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?: EntityQueryOptions): PlayerIterator
  Beta

  Parameters

  • Optionaloptions: EntityQueryOptions

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

  Returns PlayerIterator

  A player array.

  Remarks

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

  Throws

  This function can throw errors.

getTime

• getTime(): number
  Beta

  Returns number

  Remarks

  Sets the current game time of the day.

playMusic

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

  Parameters

  • trackID: string
  • OptionalmusicOptions: MusicOptions

  Returns void

  Remarks

  Plays a particular music track for all players.

playSound

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

  Parameters

  • soundID: string
  • OptionalsoundOptions: SoundOptions

  Returns void

  Remarks

  Plays a sound for all players.

queueMusic

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

  Parameters

  • trackID: string
  • OptionalmusicOptions: 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: string): boolean
  Beta

  Parameters

  • identifier: string

  Returns boolean

  Remarks

  Removes a specified property.

  Throws

  This function can throw errors.

sendMessage

• sendMessage(message: string | RawMessage | (string | RawMessage)[]): void
  Beta

  Parameters

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

    The message to be displayed.

  Returns void

  Remarks

  Sends a message to all players.

  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

setDynamicProperty

• setDynamicProperty(identifier: string, value: string | number | boolean): 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: number): 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.