endstone/actor

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

Defined in <endstone/actor/actor.h>

Bases: CommandSender

Represents a base actor in the level.

Methods

Name	Description
`asMob`	Gets an Actor as Mob.
`asItem`	Gets an Actor as Item.
`getType`	Get the type of the actor.
`getRuntimeId`
`getLocation`
`getVelocity`
`isOnGround`
`isInWater`
`isInLava`
`getLevel`
`getDimension`
`setRotation`
`teleport`
`teleport`
`getId`	Returns a unique id for this actor.
`remove`
`isDead`	Returns true if this actor has been marked for removal.
`isValid`
`getScoreboardTags`	Returns a list of scoreboard tags for this actor.
`addScoreboardTag`	Adds a tag to this actor.
`removeScoreboardTag`	Removes a given tag from this actor.
`isNameTagVisible`	Checks if the actor's name tag is currently visible.
`setNameTagVisible`	Sets if the actor's name tag is visible or not.
`isNameTagAlwaysVisible`	Checks if the actor's name tag is always visible.
`setNameTagAlwaysVisible`	Sets whether the actor's name tag should always be visible.
`getNameTag`	Gets the current name tag of the actor.
`setNameTag`	Sets the name tag for the actor.
`getScoreTag`	Gets the current score tag of the actor.
`setScoreTag`	Sets the score tag for the actor.

`meth`asMobabstractconst

Mob* asMob() const =0

Gets an Actor as Mob.

Returns

Type	Description
`Mob*`	Mob, nullptr if not an Mob

`meth`asItemabstractconst

Item* asItem() const =0

Gets an Actor as Item.

Returns

Type	Description
`Item*`	Item, nullptr if not an Item

`meth`getTypeabstractconst

std::string getType() const =0

Get the type of the actor.

This method returns the type of the actor as a string, for example, minecraft:pig.

Returns

Type	Description
`std::string`	The type of the actor.

`meth`getRuntimeIdabstractconst

std::uint64_t getRuntimeId() const =0

Returns the runtime id for this actor

Returns

Type	Description
`std::uint64_t`	Runtime id for this actor

`meth`getLocationabstractconst

Location getLocation() const =0

Gets the actor's current position

Returns

Type	Description
`Location`	a new copy of Location containing the position of this actor

`meth`getVelocityabstractconst

Vector getVelocity() const =0

Gets this actor's current velocity

Returns

Type	Description
`Vector`	Current traveling velocity of this actor

`meth`isOnGroundabstractconst

bool isOnGround() const =0

Returns true if the actor is supported by a block.

Returns

Type	Description
`bool`	True if actor is on ground.

`meth`isInWaterabstractconst

bool isInWater() const =0

Returns true if the actor is in water.

Returns

Type	Description
`bool`	True if the actor is in water.

`meth`isInLavaabstractconst

bool isInLava() const =0

Returns true if the actor is in lava.

Returns

Type	Description
`bool`	True if the actor is in lava.

`meth`getLevelabstractconst

Level& getLevel() const =0

Gets the current Level this actor resides in

Returns

Type	Description
`Level&`	The current Level this actor resides in

`meth`getDimensionabstractconst

Dimension& getDimension() const =0

Gets the current Dimension this actor resides in

Returns

Type	Description
`Dimension&`	The current Dimension this actor resides in

`meth`setRotationabstract

void setRotation(float yaw, float pitch) =0

Note that if the actor is affected by AI, it may override this rotation.

Parameters

Name	Type	Description
`yaw`	`float`	Rotation around the up axis (Y axis)
`pitch`	`float`	Rotation around the right axis (X axis)

Returns

Type	Description
`void`	Sets the actor's rotation.

`meth`teleportabstract

bool teleport(const Location& location) =0

Parameters

Name	Type	Description
`location`	`const Location&`	New location to teleport this actor to

Returns

Type	Description
`bool`	Teleports this actor to the given location.

`meth`teleportabstract

bool teleport(const Actor& target) =0

Teleports this actor to the target Actor.

Parameters

Name	Type	Description
`target`	`const Actor&`	Actor to teleport this actor to

`meth`getIdabstractconst

std::int64_t getId() const =0

Returns a unique id for this actor.

Returns

Type	Description
`std::int64_t`	Actor id

`meth`removeabstract

void remove() =0

Remove this actor from the level.

If you are trying to remove a Player, use Player::kick instead.

`meth`isDeadabstractconst

bool isDead() const =0

Returns true if this actor has been marked for removal.

Returns

Type	Description
`bool`	True if it is dead.

`meth`isValidabstractconst

bool isValid() const =0

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

Returns

Type	Description
`bool`	True if valid.

`meth`getScoreboardTagsabstractconst

std::vector<std::string> getScoreboardTags() const =0

Returns a list of scoreboard tags for this actor.

Returns

Type	Description
`std::vector<std::string>`	a list of scoreboard tags for this actor

`meth`addScoreboardTagabstractconst

bool addScoreboardTag(std::string tag) const =0

Adds a tag to this actor.

Parameters

Name	Type	Description
`tag`	`std::string`	the tag to add

Returns

Type	Description
`bool`	true if the tag was successfully added, false if the tag already exists.

`meth`removeScoreboardTagabstractconst

bool removeScoreboardTag(std::string tag) const =0

Removes a given tag from this actor.

Parameters

Name	Type	Description
`tag`	`std::string`	the tag to remove

Returns

Type	Description
`bool`	true if the tag was successfully removed, false if the tag does not exist.

`meth`isNameTagVisibleabstractconst

bool isNameTagVisible() const =0

Checks if the actor's name tag is currently visible.

Returns

Type	Description
`bool`	True if the name tag is visible, false otherwise.

`meth`setNameTagVisibleabstract

void setNameTagVisible(bool visible) =0

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

Parameters

Name	Type	Description
`visible`	`bool`	True to make the name tag visible, false to hide it.

`meth`isNameTagAlwaysVisibleabstractconst

bool isNameTagAlwaysVisible() const =0

Checks if the actor's name tag is always visible.

Returns

Type	Description
`bool`	True if the name tag is always visible, false otherwise.

`meth`setNameTagAlwaysVisibleabstract

void setNameTagAlwaysVisible(bool visible) =0

Sets whether the actor's name tag should always be visible.

Parameters

Name	Type	Description
`visible`	`bool`	True to make the name tag always visible, false to disable always visibility.

`meth`getNameTagabstractconst

std::string getNameTag() const =0

Gets the current name tag of the actor.

Returns

Type	Description
`std::string`	The name tag.

`meth`setNameTagabstract

void setNameTag(std::string name) =0

Sets the name tag for the actor.

Parameters

Name	Type	Description
`name`	`std::string`	The new name tag to set.

`meth`getScoreTagabstractconst

std::string getScoreTag() const =0

Gets the current score tag of the actor.

Returns

Type	Description
`std::string`	The score tag.

`meth`setScoreTagabstract

void setScoreTag(std::string score) =0

Sets the score tag for the actor.

Parameters

Name	Type	Description
`score`	`std::string`	The new score tag to set.

`class`Item

Defined in <endstone/actor/item.h>

Bases: Actor

Represents a base actor in the level.

Methods

Name	Description
`getItemStack`	Gets the item stack associated with this item drop.
`setItemStack`	Sets the item stack associated with this item drop.
`getPickupDelay`	Gets the delay before this Item is available to be picked up by players.
`setPickupDelay`	Sets the delay before this Item is available to be picked up by players.
`setUnlimitedLifetime`	Sets if this Item should live forever.
`isUnlimitedLifetime`	Gets if this Item lives forever.
`setThrower`	Set the thrower of this item.
`getThrower`	Get the thrower of this item.

`meth`getItemStackabstractconst

ItemStack getItemStack() const =0

Gets the item stack associated with this item drop.

Returns

Type	Description
`ItemStack`	An item stack.

`meth`setItemStackabstract

void setItemStack(const ItemStack& stack) =0

Sets the item stack associated with this item drop.

Parameters

Name	Type	Description
`stack`	`const ItemStack&`	An item stack.

`meth`getPickupDelayabstractconst

int getPickupDelay() const =0

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

Returns

Type	Description
`int`	Remaining delay

`meth`setPickupDelayabstract

void setPickupDelay(int delay) =0

Sets the delay before this Item is available to be picked up by players.

Parameters

Name	Type	Description
`delay`	`int`	New delay

`meth`setUnlimitedLifetimeabstract

void setUnlimitedLifetime(bool unlimited) =0

Sets if this Item should live forever.

Parameters

Name	Type	Description
`unlimited`	`bool`	true if the lifetime is unlimited

`meth`isUnlimitedLifetimeabstractconst

bool isUnlimitedLifetime() const =0

Gets if this Item lives forever.

Returns

Type	Description
`bool`	true if the lifetime is unlimited

`meth`setThrowerabstract

void setThrower(std::optional<std::int64_t> thrower) =0

Set the thrower of this item.

Note

The thrower is the entity which dropped the item.

Parameters

Name	Type	Description
`thrower`	`std::optional<std::int64_t>`	unique id of thrower

`meth`getThrowerabstractconst

std::optional<std::int64_t> getThrower() const =0

Get the thrower of this item.

Note

The thrower is the entity which dropped the item.

Returns

Type	Description
`std::optional<std::int64_t>`	unique id of thrower

`class`Mob

Defined in <endstone/actor/mob.h>

Bases: Actor

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

Methods

Name	Description
`isGliding`	Checks to see if an actor is gliding, such as using an Elytra.
`getHealth`	Gets the entity's health from 0 to its max possible value, where 0 is dead.
`setHealth`
`getMaxHealth`	Gets the maximum health this entity has.
`setMaxHealth`	Sets the maximum health this entity can have.

`meth`isGlidingabstractconst

bool isGliding() const =0

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

Returns

Type	Description
`bool`	True if this actor is gliding.

`meth`getHealthabstractconst

int getHealth() const =0

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

Returns

Type	Description
`int`	Health represented from 0 to max

`meth`setHealthabstractconst

void setHealth(int health) const =0

Sets the entity's health from 0 to its possible value, where 0 is dead.

Parameters

Name	Type	Description
`health`	`int`	New health represented from 0 to max

`meth`getMaxHealthabstractconst

int getMaxHealth() const =0

Gets the maximum health this entity has.

Returns

Type	Description
`int`	Maximum health

`meth`setMaxHealthabstractconst

void setMaxHealth(int health) const =0

Sets the maximum health this entity can have.

If the health of the entity is above the value provided, it will be set to that value.

Note

An entity with a health bar e.g., Player, EnderDragon, Wither, etc. will have their bar scaled accordingly.

Parameters

Name	Type	Description
`health`	`int`	amount of health to set the maximum to

classActor

methasMobabstractconst

methasItemabstractconst

methgetTypeabstractconst

methgetRuntimeIdabstractconst

methgetLocationabstractconst

methgetVelocityabstractconst

methisOnGroundabstractconst

methisInWaterabstractconst

methisInLavaabstractconst

methgetLevelabstractconst

methgetDimensionabstractconst

methsetRotationabstract

methteleportabstract

methteleportabstract

methgetIdabstractconst

methremoveabstract

methisDeadabstractconst

methisValidabstractconst

methgetScoreboardTagsabstractconst

methaddScoreboardTagabstractconst

methremoveScoreboardTagabstractconst

methisNameTagVisibleabstractconst

methsetNameTagVisibleabstract

methisNameTagAlwaysVisibleabstractconst

methsetNameTagAlwaysVisibleabstract

methgetNameTagabstractconst

methsetNameTagabstract

methgetScoreTagabstractconst

methsetScoreTagabstract

classItem

methgetItemStackabstractconst

methsetItemStackabstract

methgetPickupDelayabstractconst

methsetPickupDelayabstract

methsetUnlimitedLifetimeabstract

methisUnlimitedLifetimeabstractconst

methsetThrowerabstract

methgetThrowerabstractconst

classMob

methisGlidingabstractconst

methgetHealthabstractconst

methsetHealthabstractconst

methgetMaxHealthabstractconst

methsetMaxHealthabstractconst

On this page

`class`Actor

`meth`asMobabstractconst

`meth`asItemabstractconst

`meth`getTypeabstractconst

`meth`getRuntimeIdabstractconst

`meth`getLocationabstractconst

`meth`getVelocityabstractconst

`meth`isOnGroundabstractconst

`meth`isInWaterabstractconst

`meth`isInLavaabstractconst

`meth`getLevelabstractconst

`meth`getDimensionabstractconst

`meth`setRotationabstract

`meth`teleportabstract

`meth`teleportabstract

`meth`getIdabstractconst

`meth`removeabstract

`meth`isDeadabstractconst

`meth`isValidabstractconst

`meth`getScoreboardTagsabstractconst

`meth`addScoreboardTagabstractconst

`meth`removeScoreboardTagabstractconst

`meth`isNameTagVisibleabstractconst

`meth`setNameTagVisibleabstract

`meth`isNameTagAlwaysVisibleabstractconst

`meth`setNameTagAlwaysVisibleabstract

`meth`getNameTagabstractconst

`meth`setNameTagabstract

`meth`getScoreTagabstractconst

`meth`setScoreTagabstract

`class`Item

`meth`getItemStackabstractconst

`meth`setItemStackabstract

`meth`getPickupDelayabstractconst

`meth`setPickupDelayabstract

`meth`setUnlimitedLifetimeabstract

`meth`isUnlimitedLifetimeabstractconst

`meth`setThrowerabstract

`meth`getThrowerabstractconst

`class`Mob

`meth`isGlidingabstractconst

`meth`getHealthabstractconst

`meth`setHealthabstractconst

`meth`getMaxHealthabstractconst

`meth`setMaxHealthabstractconst