Class Entity

Represents the state of an entity (a mob, the player, or other moving objects like minecarts) in the world.

Hierarchy

Constructors

constructor

Properties

dimension id location nameTag typeId

Methods

getHeadLocation getVelocity getViewDirection runCommandAsync

Constructors

Protected constructor

  • Returns Entity

Properties

Readonly dimension

dimension: Dimension

Remarks

Dimension that the entity is currently within.

Throws

This property can throw when used.

Readonly id

id: string

Remarks

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.

Throws

This property can throw when used.

Readonly location

location: Vector3

Remarks

Current location of the entity.

Throws

This property can throw when used.

nameTag

nameTag: string

Remarks

Given name of the entity.

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

Readonly typeId

typeId: string

Remarks

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

Throws

This property can throw when used.

Methods

getHeadLocation

  • Returns Vector3

    Remarks

    Returns the current location of the head component of this entity.

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

    Throws

    This function can throw errors.

getVelocity

  • Returns Vector3

    Remarks

    Returns the current velocity vector of the entity.

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

    Throws

    This function can throw errors.

getViewDirection

  • Returns Vector3

    Remarks

    Returns the current view direction of the entity.

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

    Throws

    This function can throw errors.

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

    Throws

    This function can throw errors.

Settings

Member Visibility

Theme

On This Page