Entity

The main entity object for BeAPI

warning

You should never have to construct this class yourself.

Constructor

new Entity(client, entity);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
client	Client	❌	null	Constructed Client instance.
entity	IEntity	❌	null	Minecraft IEntity Object.

Methods

destroy

Destroys the entity object.

destroy();

Returns

void

---

getIEntity

Returns the vanilla entity object.

getIEntity();

Returns

IEntity

---

getRuntimeId

Returns the entity's runtime id.

getRuntimeId();

Returns

number

---

getId

Returns the entity's mob id.

getId();

Returns

string

---

getNameTag

Returns the entity's above head name.

getNameTag();

Returns

string

---

setNameTag

Sets the entity's above head name.

setNameTag(nametag);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
nametag	string	❌	undefined	Nametag for the entity.

Returns

void

---

getTags

Returns the all the tags on the entity.

getTags();

Returns

string[]

---

hasTag

Checks if a entity has a specific tag.

hasTag(tag);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
tag	string	❌	undefined	The tag to check for.

Returns

boolean

---

addTag

Adds a tag to the entity.

addTag(tag);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
tag	string	❌	undefined	The tag to add.

Returns

boolean

---

removeTag

Removes a tag from the entity.

removeTag(tag);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
tag	string	❌	undefined	The tag to remove.

Returns

boolean

---

executeCommand

Executes a command as the entity.

executeCommand(cmd, debug);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
cmd	string	❌	undefined	Minecraft command to execute.
debug	boolean?	✔️	false	Pipe logs to debug console.

Returns

ServerCommandResponse

---

getScore

Gets the score of an objective.

getScore(objective);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
objective	string	❌	undefined	The scoreboard objective name.

Returns

number

---

getLocation

Gets the entity's current location.

getLocation();

Returns

Location

---

getDimension

Gets the entity's current dimension.

getDimension();

Returns

IDimension

---

getDimensionName

Gets the entity's current dimension name.

getDimensionName();

Returns

Dimension

---

getInventory

Gets the entity's inventory.

getInventory();

Returns

Inventory | undefined

---

getHealth

Gets the entity's health.

getHealth();

Returns

Health

---

getVelocity

Gets the entity's current velocity.

getVelocity();

Returns

Vector

---

setVelocity

Sets the entity's velocity.

setVelocity(velocity);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
velocity	Vector	❌	undefined	The velocity vector.

Returns

void

---

teleport

Teleports the entity.

teleport(location, dimension, xrot, yrot);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
location	ILocation	❌	undefined	The location to be teleported.
dimension	IDimension	❌	undefined	The dimension to be teleported.
xrot	number	❌	undefined	The xrot of the entity.
yrot	number	❌	undefined	The yrot of the entity.

Returns

void

---

teleportFacing

Teleports the entity facing a direction.

teleportFacing(location, dimension, facingLocaton);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
location	ILocation	❌	undefined	The location to be teleported.
dimension	IDimension	❌	undefined	The dimension to be teleported.
facingLocation	ILocation	❌	undefined	The facing location to be teleported.

Returns

void

---

triggerEvent

Triggers a entity event from the entity.json.

triggerEvent(event);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	string	❌	undefined	The event to be triggered.

Returns

void

---

getRotation

Gets the rotation of the entity.

getRotation();

Returns

number

---

getHeadLocation

Gets the location of the entity's head.

getHeadLocation();

Returns

ILocation

---