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

    Class Player

    Represents a player within the world.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    dimension id location name nameTag typeId

    Methods

    getHeadLocation getVelocity getViewDirection runCommandAsync sendMessage

    Constructors

    Properties

    dimension: Dimension

    Dimension that the entity is currently within.

    This property can throw when used.

    id: string

    Unique identifier of the entity. This identifier is intended to be consistent across loads of a world instance. No meaning should be inferred from the value and structure of this unique identifier - do not parse or interpret it.

    This property can throw when used.

    location: Vector3

    Current location of the entity.

    This property can throw when used.

    name: string

    Name of the player.

    This property can throw when used.

    nameTag: string

    Given name of the entity.

    This property can't be edited in read-only mode.

    typeId: string

    Unique identifier of the type of the entity - for example, 'minecraft:skeleton'.

    This property can throw when used.

    Methods

    • Parameters

      • commandString: string

        Command to run. Note that command strings should not start with slash.

      Returns Promise<CommandResult>

      For commands that return data, returns a JSON structure with command response values.

      Runs a particular command asynchronously from the context of this entity. Note that there is a maximum queue of 128 asynchronous commands that can be run in a given tick.

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

      This function can throw errors.

    • Parameters

      Returns void

      Sends a message to the player.

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

      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" }] },
             };
             player.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"] };
             player.sendMessage(rawMessage);

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods