Script API - v1.20.0
    Preparing search index...

    Class World

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

    Index

    Properties

    afterEvents beforeEvents scoreboard

    Methods

    broadcastClientMessage getAbsoluteTime getAllPlayers getDefaultSpawnPosition getDimension getDynamicProperty getEntity getPlayers getTime playMusic playSound queueMusic removeDynamicProperty sendMessage setDefaultSpawn setDynamicProperty setTime stopMusic

    Properties

    afterEvents: AfterEvents

    Contains 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.

    beforeEvents: BeforeEvents

    Contains 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.

    scoreboard: Scoreboard

    Returns the general global scoreboard that applies to the world.

    Methods

    • Beta

      Parameters

      • id: string
      • value: string

      Returns void

      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.

    • Beta

      Returns number

      Returns the absolute time since the start of the world.

    • Returns Player[]

      Returns an array of all active players within the world.

      This function can throw errors.

    • Beta

      Returns Vector3

      Returns the default spawn position.

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

    • Parameters

      • dimensionId: string

      Returns Dimension

      The requested dimension

      Returns a dimension object.

      Throws if the given dimension name is invalid

    • Beta

      Parameters

      • identifier: string

      Returns undefined | string | number | boolean

      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

      Parameters

      • id: string

        The id of the entity.

      Returns undefined | Entity

      The requested entity object.

      Returns an entity based on the provided id.

      Throws if the given entity id is invalid.

    • Parameters

      • Optionaloptions: EntityQueryOptions

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

      Returns Player[]

      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

      Returns number

      Sets the current game time of the day.

    • Parameters

      Returns void

      Plays a particular music track for all players.

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

      This function can throw errors.

    • Parameters

      Returns void

      Plays a sound for all players.

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

      This function can throw errors.

    • Parameters

      Returns void

      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.

      This function can throw errors.

    • Beta

      Parameters

      • identifier: string

      Returns boolean

      Removes a specified property.

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

      This function can throw errors.

    • Parameters

      Returns void

      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.

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

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

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

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

      Parameters

      • spawnPosition: Vector3

        Location within the overworld where a player will spawn.

      Returns void

      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.

    • Beta

      Parameters

      • identifier: string
      • value: string | number | boolean

        Data value of the property to set.

      Returns void

      Sets a specified property to a value.

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

      This function can throw errors.

    • Beta

      Parameters

      • timeOfDay: number

      Returns void

      Returns the current game time of the day.

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

    • Returns void

      Stops any music tracks from playing.

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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods