Members

active :Boolean

core/GameEntity.js, line 35

Whether this game entity is active or not.

Default Value:

• true

boundingRadius :Number

core/GameEntity.js, line 110

The bounding radius of this game entity in world units.

Default Value:

• 0

canActivateTrigger :Boolean

core/GameEntity.js, line 125

Whether the entity can activate a trigger or not.

Default Value:

• true

children :Array.<GameEntity>

core/GameEntity.js, line 41

The child entities of this game entity.

forward :Vector3

core/GameEntity.js, line 96

The default forward vector of this game entity.

Default Value:

• (0,0,1)

readonly manager :EntityManager

core/GameEntity.js, line 134

A reference to the entity manager of this game entity. Automatically set when added to an EntityManager.

Default Value:

• null

maxTurnRate :Number

core/GameEntity.js, line 118

The maximum turn rate of this game entity in radians per seconds. The only method that uses this property right now is GameEntity#rotateTo.

Default Value:

• π

name :String

core/GameEntity.js, line 28

The name of this game entity.

neighborhoodRadius :Number

core/GameEntity.js, line 64

Game entities within this radius are considered as neighbors of this entity.

Default Value:

• 1

readonly neighbors :Array.<GameEntity>

core/GameEntity.js, line 57

A list of neighbors of this game entity.

readonly, nullable parent :GameEntity

core/GameEntity.js, line 50

A reference to the parent entity of this game entity. Automatically set when added to a GameEntity.

Default Value:

• null

position :Vector3

core/GameEntity.js, line 77

The position of this game entity.

rotation :Quaternion

core/GameEntity.js, line 83

The rotation of this game entity.

scale :Vector3

core/GameEntity.js, line 89

The scaling of this game entity.

up :Vector3

core/GameEntity.js, line 103

The default up vector of this game entity.

Default Value:

• (0,1,0)

updateNeighborhood :Boolean

core/GameEntity.js, line 71

Whether the neighborhood of this game entity is updated or not.

Default Value:

• false

readonly uuid :String

core/GameEntity.js, line 191

Unique ID, primarily used in context of serialization/deserialization.

readonly worldMatrix :Matrix4

core/GameEntity.js, line 178

A transformation matrix representing the world space of this game entity.

Methods

add(entity) → {GameEntity}

core/GameEntity.js, line 234

Adds a game entity as a child to this game entity.

Parameters:

Name	Type	Description
entity	GameEntity	The game entity to add.

Returns:

GameEntity -

A reference to this game entity.

fromJSON(json) → {GameEntity}

core/GameEntity.js, line 491

Restores this instance from the given JSON object.

Parameters:

Name	Type	Description
json	Object	The JSON object.

Returns:

GameEntity -

A reference to this game entity.

getDirection(result) → {Vector3}

core/GameEntity.js, line 273

Computes the current direction (forward) vector of this game entity and stores the result in the given vector.

Parameters:

Name	Type	Description
result	Vector3	The direction vector of this game entity.

Returns:

Vector3 -

The direction vector of this game entity.

getWorldDirection(result) → {Vector3}

core/GameEntity.js, line 358

Computes the current direction (forward) vector of this game entity in world space and stores the result in the given vector.

Parameters:

Name	Type	Description
result	Vector3	The direction vector of this game entity in world space.

Returns:

Vector3 -

The direction vector of this game entity in world space.

getWorldPosition(result) → {Vector3}

core/GameEntity.js, line 373

Computes the current position of this game entity in world space and stores the result in the given vector.

Parameters:

Name	Type	Description
result	Vector3	The position of this game entity in world space.

Returns:

Vector3 -

The position of this game entity in world space.

handleMessage(telegram) → {Boolean}

core/GameEntity.js, line 401

Holds the implementation for the message handling of this game entity.

Parameters:

Name	Type	Description
telegram	Telegram	The telegram with the message data.

Returns:

Boolean -

Whether the message was processed or not.

lineOfSightTest(ray, intersectionPoint) → {Vector3}

core/GameEntity.js, line 417

Holds the implementation for the line of sight test of this game entity. This method is used by Vision#visible in order to determine whether this game entity blocks the given line of sight or not. Implement this method when your game entity acts as an obstacle.

Parameters:

Name	Type	Description
ray	Ray	The ray that represents the line of sight.
intersectionPoint	Vector3	The intersection point.

Returns:

Vector3 -

The intersection point.

lookAt(target) → {GameEntity}

core/GameEntity.js, line 285

Directly rotates the entity so it faces the given target position.

Parameters:

Name	Type	Description
target	Vector3	The target position.

Returns:

GameEntity -

A reference to this game entity.

remove(entity) → {GameEntity}

core/GameEntity.js, line 255

Removes a game entity as a child from this game entity.

Parameters:

Name	Type	Description
entity	GameEntity	The game entity to remove.

Returns:

GameEntity -

A reference to this game entity.

resolveReferences(entities) → {GameEntity}

core/GameEntity.js, line 531

Restores UUIDs with references to GameEntity objects.

Parameters:

Name	Type	Description
entities	Map.<String, GameEntity>	Maps game entities to UUIDs.

Returns:

GameEntity -

A reference to this game entity.

rotateTo(target, delta, tolerance) → {Boolean}

core/GameEntity.js, line 323

Given a target position, this method rotates the entity by an amount not greater than GameEntity#maxTurnRate until it directly faces the target.

Parameters:

Name	Type	Default	Description
target	Vector3		The target position.
delta	Number		The time delta.
tolerance	Number	0.0001	A tolerance value in radians to tweak the result when a game entity is considered to face a target.

Returns:

Boolean -

Whether the entity is faced to the target or not.

sendMessage(receiver, message, delay, data) → {GameEntity}

core/GameEntity.js, line 432

Sends a message with the given data to the specified receiver.

Parameters:

Name	Type	Default	Description
receiver	GameEntity		The receiver.
message	String		The actual message.
delay	Number	0	A time value in millisecond used to delay the message dispatching.
data	Object	null	An object for custom data.

Returns:

GameEntity -

A reference to this game entity.

setRenderComponent(renderComponent, callback) → {GameEntity}

core/GameEntity.js, line 386

Sets a renderable component of a 3D engine with a sync callback for this game entity.

Parameters:

Name	Type	Description
renderComponent	Object	A renderable component of a 3D engine.
callback	function	A callback that can be used to sync this game entity with the renderable component.

Returns:

GameEntity -

A reference to this game entity.

start() → {GameEntity}

core/GameEntity.js, line 208

Executed when this game entity is updated for the first time by its EntityManager.

Returns:

GameEntity -

A reference to this game entity.

toJSON() → {Object}

core/GameEntity.js, line 453

Transforms this instance into a JSON object.

Returns:

Object -

The JSON object.

update(delta) → {GameEntity}

core/GameEntity.js, line 221

Updates the internal state of this game entity. Normally called by EntityManager#update in each simulation step.

Parameters:

Name	Type	Description
delta	Number	The time delta.

Returns:

GameEntity -

A reference to this game entity.