endstone.actor

Classes relating to actors (entities) that can exist in a world, including all players, monsters, projectiles, etc.

Classes

Name	Description
`Actor`	Represents a base actor in the level.
`Item`	Represents a base actor in the level.
`Mob`	Represents a mobile entity (i.e. living entity), such as a monster or player.

`class`Actor

Bases: CommandSender

Actor()

Represents a base actor in the level.

Methods

Name	Description
`add_scoreboard_tag`	Adds a tag to this actor.
`remove`	Remove this actor from the level.
`remove_scoreboard_tag`	Removes a given tag from this actor.
`set_rotation`	Sets the actor's rotation.

Attributes

Name	Type	Description
`dimension`	`Dimension`	Gets the current Dimension this actor resides in.
`id`	`int`	Returns a unique id for this actor.
`is_dead`	`bool`	Returns true if this actor has been marked for removal.
`is_in_lava`	`bool`	Returns true if the actor is in lava.
`is_in_water`	`bool`	Returns true if the actor is in water.
`is_name_tag_always_visible`	`bool`	Gets or sets if the actor's name tag is always visible or not.
`is_name_tag_visible`	`bool`	Gets or sets if the actor's name tag is visible or not.
`is_on_ground`	`bool`	Returns true if the actor is supported by a block, i.e. on ground.
`is_valid`	`bool`	Returns false if the entity has died, been despawned for some other reason, or has not been added to the level.
`level`	`Level`	Gets the current Level this actor resides in.
`location`	`Location`	Gets the actor's current position.
`name_tag`	`str`	Gets or sets the current name tag of the actor.
`runtime_id`	`int`	Returns the runtime id for this actor.
`score_tag`	`str`	Gets or sets the current score tag of the actor.
`scoreboard_tags`	`list[str]`	Returns a list of scoreboard tags for this actor.
`type`	`str`	Gets the type of the actor.
`velocity`	`Vector`	Gets this actor's current velocity.

`attr`dimensionproperty

dimension: Dimension

Gets the current Dimension this actor resides in.

`attr`idproperty

id: int

Returns a unique id for this actor.

`attr`is_deadproperty

is_dead: bool

Returns true if this actor has been marked for removal.

`attr`is_in_lavaproperty

is_in_lava: bool

Returns true if the actor is in lava.

`attr`is_in_waterproperty

is_in_water: bool

Returns true if the actor is in water.

`attr`is_name_tag_always_visibleproperty

is_name_tag_always_visible: bool

Gets or sets if the actor's name tag is always visible or not.

`attr`is_name_tag_visibleproperty

is_name_tag_visible: bool

Gets or sets if the actor's name tag is visible or not.

`attr`is_on_groundproperty

is_on_ground: bool

Returns true if the actor is supported by a block, i.e. on ground.

`attr`is_validproperty

is_valid: bool

Returns false if the entity has died, been despawned for some other reason, or has not been added to the level.

`attr`levelproperty

level: Level

Gets the current Level this actor resides in.

`attr`locationproperty

location: Location

Gets the actor's current position.

`attr`name_tagproperty

name_tag: str

Gets or sets the current name tag of the actor.

`attr`runtime_idproperty

runtime_id: int

Returns the runtime id for this actor.

`attr`score_tagproperty

score_tag: str

Gets or sets the current score tag of the actor.

`attr`scoreboard_tagsproperty

scoreboard_tags: list[str]

Returns a list of scoreboard tags for this actor.

`attr`typeproperty

type: str

Gets the type of the actor.

`attr`velocityproperty

velocity: Vector

Gets this actor's current velocity.

`meth`add_scoreboard_tag

add_scoreboard_tag(tag: str) -> bool

Adds a tag to this actor.

`meth`remove

remove() -> None

Remove this actor from the level.

`meth`remove_scoreboard_tag

remove_scoreboard_tag(tag: str) -> bool

Removes a given tag from this actor.

`meth`set_rotation

set_rotation(yaw: float, pitch: float) -> None

Sets the actor's rotation.

`class`Item

Bases: Actor

Item()

Represents a base actor in the level.

Attributes

Name	Type	Description
`is_unlimited_lifetime`	`bool`	Gets or sets if this Item lives forever
`item_stack`	`ItemStack`	Gets or sets the item stack associated with this item drop.
`pickup_delay`	`int`	Gets or sets the delay before this Item is available to be picked up by players.
`thrower`	`int \| None`	Gets or sets the thrower of this item.

`attr`is_unlimited_lifetimeproperty

is_unlimited_lifetime: bool

Gets or sets if this Item lives forever

`attr`item_stackproperty

item_stack: ItemStack

Gets or sets the item stack associated with this item drop.

`attr`pickup_delayproperty

pickup_delay: int

Gets or sets the delay before this Item is available to be picked up by players.

`attr`throwerproperty

thrower: int | None

Gets or sets the thrower of this item.

`class`Mob

Bases: Actor

Mob()

Represents a mobile entity (i.e. living entity), such as a monster or player.

Attributes

Name	Type	Description
`health`	`int`	Gets or sets the entity's health from 0 to its max possible value, where 0 is dead.
`is_gliding`	`bool`	Checks to see if an actor is gliding, such as using an Elytra.
`max_health`	`int`	Gets or sets the maximum health this entity has.

`attr`healthproperty

health: int

Gets or sets the entity's health from 0 to its max possible value, where 0 is dead.

`attr`is_glidingproperty

is_gliding: bool

Checks to see if an actor is gliding, such as using an Elytra.

`attr`max_healthproperty

max_health: int

Gets or sets the maximum health this entity has.

classActor

attrdimensionproperty

attridproperty

attris_deadproperty

attris_in_lavaproperty

attris_in_waterproperty

attris_name_tag_always_visibleproperty

attris_name_tag_visibleproperty

attris_on_groundproperty

attris_validproperty

attrlevelproperty

attrlocationproperty

attrname_tagproperty

attrruntime_idproperty

attrscore_tagproperty

attrscoreboard_tagsproperty

attrtypeproperty

attrvelocityproperty

methadd_scoreboard_tag

methremove

methremove_scoreboard_tag

methset_rotation

classItem

attris_unlimited_lifetimeproperty

attritem_stackproperty

attrpickup_delayproperty

attrthrowerproperty

classMob

attrhealthproperty

attris_glidingproperty

attrmax_healthproperty

On this page

`class`Actor

`attr`dimensionproperty

`attr`idproperty

`attr`is_deadproperty

`attr`is_in_lavaproperty

`attr`is_in_waterproperty

`attr`is_name_tag_always_visibleproperty

`attr`is_name_tag_visibleproperty

`attr`is_on_groundproperty

`attr`is_validproperty

`attr`levelproperty

`attr`locationproperty

`attr`name_tagproperty

`attr`runtime_idproperty

`attr`score_tagproperty

`attr`scoreboard_tagsproperty

`attr`typeproperty

`attr`velocityproperty

`meth`add_scoreboard_tag

`meth`remove

`meth`remove_scoreboard_tag

`meth`set_rotation

`class`Item

`attr`is_unlimited_lifetimeproperty

`attr`item_stackproperty

`attr`pickup_delayproperty

`attr`throwerproperty

`class`Mob

`attr`healthproperty

`attr`is_glidingproperty

`attr`max_healthproperty