Protected constructorReadonly Beta afterContains a set of events that are applicable to the entirety of the world. Event callbacks are called in a deferred manner. Event callbacks are executed in read-write mode.
Readonly Beta beforeContains a set of events that are applicable to the entirety of the world. Event callbacks are called immediately. Event callbacks are executed in read-only mode.
Readonly Beta scoreboardReturns the general global scoreboard that applies to the world.
Beta
Returns the value for the property, or undefined if the property has not been set.
Returns a property value.
This function can throw errors.
Beta
Optional options: EntityQueryOptionsAdditional options that can be used to filter the set of players returned.
A player array.
Returns a set of players based on a set of conditions defined via the EntityQueryOptions set of filter criteria.
This function can throw errors.
Beta
Optional musicOptions: MusicOptionsPlays a particular music track for all players.
This function can't be called in read-only mode.
This function can throw errors.
Beta
Optional soundOptions: WorldSoundOptionsPlays a sound for all players.
This function can't be called in read-only mode.
This function can throw errors.
Beta
Optional musicOptions: MusicOptionsQueues 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.
This function can throw errors.
Beta
The message to be displayed.
Sends a message to all players.
This method can throw if the provided RawMessage is
in an invalid format. For example, if an empty name string
is provided to score.
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);
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);
simpleString.ts
// Displays "Hello, world!"
world.sendMessage("Hello, world!");
translation.ts
// Displays "First or Second"
const rawMessage = { translate: "accessibility.list.or.two", with: ["First", "Second"] };
world.sendMessage(rawMessage);
Beta
Location within the overworld where a player will spawn.
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.
This function can throw errors.
A class that wraps the state of a world - a set of dimensions and the environment of Minecraft.