Class Player

Represents a player within the world.

Hierarchy

Constructors

constructor

Properties

dimension id name typeId

Methods

runCommandAsync

Constructors

Protected constructor

Properties

Readonly dimension

dimension: Dimension

Dimension that the entity is currently within.

Throws

This property can throw when used.

Readonly id

id: string

Unique identifier of the player. 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.

Throws

This property can throw when used.

Readonly name

name: string

Name of the player.

Throws

This property can throw when used.

Readonly typeId

typeId: string

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

Throws

This property can throw when used.

Methods

runCommandAsync

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

    Remarks

    Runs a particular command asynchronously from the context of this entity. Where possible, running a command asynchronously is recommended, especially for long running operations.

    Throws

    This function can throw errors.

Settings

Member Visibility

Theme

On This Page