Class World

A class that wraps the state of a world - a set of dimensions and the environment of Minecraft.

Constructors

`Protected`constructor

new World(): World
Returns World

Properties

`Readonly` `Beta`events

events: Events

Remarks

Contains a set of events that are applicable to the entirety of the world.

`Readonly` `Beta`scoreboard

scoreboard: Scoreboard

Remarks

Returns the general global scoreboard that applies to the world.

Methods

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.

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: string): 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: 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.

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

Throws
This function can throw errors.

getEntity

getEntity(id: string): 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?: EntityQueryOptions): Player[]
Parameters
- Optionaloptions: 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: string, musicOptions?: MusicOptions): void
Beta
Parameters
- trackID: string
- OptionalmusicOptions: 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: string, soundOptions?: SoundOptions): void
Beta
Parameters
- soundID: string
- OptionalsoundOptions: SoundOptions
Returns void
Remarks
Plays a sound for all players.

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

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.

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

removeDynamicProperty

removeDynamicProperty(identifier: string): 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: string | RawMessage | (string | RawMessage)[]): 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);

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);

Example: simpleString.ts

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

Example: translation.ts

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

setDefaultSpawn

setDefaultSpawn(spawnPosition: Vector3): 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: 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.

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

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.

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.

Class World

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Returns World

Properties

Readonly Betaevents

Remarks

Readonly Betascoreboard

Remarks

Methods

broadcastClientMessage

Parameters

Returns void

Remarks

getAbsoluteTime

Returns number

Remarks

getAllPlayers

Returns Player[]

Remarks

Throws

getDefaultSpawnPosition

Returns Vector3

Remarks

getDimension

Parameters

Returns Dimension

Remarks

Throws

getDynamicProperty

Parameters

Returns undefined | string | number | boolean

Remarks

Throws

getEntity

Parameters

Returns undefined | Entity

Remarks

Throws

getPlayers

Parameters

Returns Player[]

Remarks

Throws

getTime

Returns number

Remarks

playMusic

Parameters

Returns void

Remarks

playSound

Parameters

Returns void

Remarks

queueMusic

Parameters

Returns void

Remarks

removeDynamicProperty

Parameters

Returns boolean

Remarks

Throws

sendMessage

Parameters

Returns void

Remarks

Throws

Example: nestedTranslation.ts

Example: scoreWildcard.ts

Example: simpleString.ts

Example: translation.ts

setDefaultSpawn

Parameters

Returns void

`Protected`constructor

`Readonly` `Beta`events

`Readonly` `Beta`scoreboard