EntityManager

The manager that keeps track of all entities.

warning

You should never have to construct this class yourself.

import { client } from 'beapi-core';

client.entities...;

Constructor

new EntityManager(client);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
client	Client	❌	null	Constructed Client instance.

Methods

newRuntimeId

returns a new runtime id.

newRuntimeId();

Returns

number

---

create

Creates an entity instance.

create(entity);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
entity	IEntity	❌	undefined	Entity to create.

Returns

Entity

---

add

Adds an entity to the manager.

add(entity);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
entity	Entity	❌	undefined	Entity to add.

Returns

void

---

remove

Removes an entity from the manager.

remove(entity);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
entity	entity	❌	undefined	Entity to remove.

Returns

void

---

removeByRuntimeId

Removes an entity from the manager by its runtime id.

removeByRuntimeId(id);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
id	number	❌	undefined	Entity id to remove.

Returns

void

---

getAll

Returns all entities as a map.

getAll();

Returns

Map<number, Entity>

---

getByNameTag

Returns an entity by its nametag.

getByNameTag(name);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
name	string	❌	undefined	Entity to get.

Returns

Entity | undefined

---

getByRuntimeId

Returns an entity by its runtime id.

getByRuntimeId(id);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
id	number	❌	undefined	Entity to get.

Returns

Entity | undefined

---

getByIEntity

Returns an entity by its IEntity.

getByIEntity(entity);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
entity	IEntity	❌	undefined	Entity to get.

Returns

Entity | undefined

---

getLastest

Gets most recently added entity (supposed to be latest but this got into production so new word "lastest").

getLastest();

Returns

Entity | undefined

---