Class Entity

Hierarchy

Entity

Constructors

constructor

new Entity(__namedParameters: { name: string; scene?: Scene; tag?: string }): Entity

- Defined in core/entity.ts:116
Class constructor.

Parameters
- __namedParameters: { name: string; scene?: Scene; tag?: string }
  - name: string
  - Optional scene?: Scene
  - Optional tag?: string
Returns Entity

Properties

Private _behaviours

_behaviours: IBehaviour[] = ...

Private _children

_children: Entity[] = ...

Private _components

_components: IComponent[] = ...

Private _id

_id: string

Private _isAlive

_isAlive: boolean = true

Private _isLoaded

_isLoaded: boolean = false

Private _isVisible

_isVisible: boolean = true

Private _localMatrix

_localMatrix: Matrix4 = ...

Private _name

_name: string

Private _parent

_parent: undefined | Entity

Private _scene

_scene: undefined | Scene

Private _tag

_tag: string

Private _worldMatrix

_worldMatrix: Matrix4 = ...

transform

transform: Transform = ...

Accessors

children

get children(): Entity[]

- Defined in core/entity.ts:30
Gets the children of the entity object.

Returns Entity[]
Array

id

get id(): string

- Defined in core/entity.ts:37
Gets the unique id of the object.

Returns string
string

isAlive

get isAlive(): boolean
set isAlive(value: boolean): void

- Defined in core/entity.ts:65
Gets if the object is alive.

Returns boolean
boolean
- Defined in core/entity.ts:72
Sets if the object is alive.

Parameters
- value: boolean
Returns void
boolean

isLoaded

get isLoaded(): boolean

- Defined in core/entity.ts:44
Gets if the object is loaded.

Returns boolean
boolean

isVisible

get isVisible(): boolean
set isVisible(value: boolean): void

- Defined in core/entity.ts:58
Gets if the object is visible.

Returns boolean
boolean
- Defined in core/entity.ts:51
Sets if the object is visible.

Parameters
- value: boolean
Returns void

localMatrix

get localMatrix(): Matrix4

- Defined in core/entity.ts:93
Gets the location matrix of the entity based on the transform.

Returns Matrix4
Matrix4

name

get name(): string

- Defined in core/entity.ts:79
Gets the name of the entity.

Returns string
string

parent

get parent(): undefined | Entity

- Defined in core/entity.ts:86
Gets the parent object of the entity or undefined if no parent.

Returns undefined | Entity
Entity

scene

get scene(): Scene

- Defined in core/entity.ts:100
Gets the scene that the entity is attached to.

Returns Scene
Scene

worldMatrix

get worldMatrix(): Matrix4

- Defined in core/entity.ts:107
Gets the world matrix of the entity, based on the parent matrix.

Returns Matrix4
Matrix4

Methods

addBehaviour

addBehaviour(behaviour: IBehaviour): void

- Defined in core/entity.ts:146
Adds a behaviour to the entity.

Parameters
- behaviour: IBehaviour
Returns void
void

addChild

addChild(child: Entity): void

- Defined in core/entity.ts:127
Adds a child entity to the current entity.

Parameters
- child: Entity
Returns void
void

addComponent

addComponent(component: IComponent): void

- Defined in core/entity.ts:137
Adds a component to the entity.

Parameters
- component: IComponent
Returns void
void

destroy

destroy(): void

- Defined in core/entity.ts:154
Destroys the entity.

Returns void
void

Private die

die(): void

- Defined in core/entity.ts:334
Kills the entity, components, behaviours and children recursively.

Returns void
void

getBehaviourByName

getBehaviourByName(name: string): undefined | IBehaviour

- Defined in core/entity.ts:175
Gets the behavoiur by name from the entity.

Parameters
- name: string
Returns undefined | IBehaviour
IBehaviour

getComponentByName

getComponentByName(name: string): undefined | IComponent

- Defined in core/entity.ts:190
Gets the component by name from the entity.

Parameters
- name: string
Returns undefined | IComponent
IComponent

getObjectByName

getObjectByName(name: string): undefined | Entity

- Defined in core/entity.ts:205
Gets the child entity by name from the entity.

Parameters
- name: string
Returns undefined | Entity
Entity

getWorldPosition

getWorldPosition(): Vector3

- Defined in core/entity.ts:222
Gets the position relative to the world of the object.

Returns Vector3
Vector3

load

load(): void

- Defined in core/entity.ts:161
Loads the entity and it's components.

Returns void
void

Protected onAdded

onAdded(scene: Scene): void

- Defined in core/entity.ts:327
Adds the scene to the entity.

Parameters
- scene: Scene
Returns void
void

removeChild

removeChild(child: Entity): void

- Defined in core/entity.ts:231
Removes the child entity from the entity. //REVIEW: change this to by name?

Parameters
- child: Entity
Returns void
void

removeComponent

removeComponent(name: string): void

- Defined in core/entity.ts:243
Removes the component by name.

Parameters
- name: string
Returns void
void

render

render(shader: Shader): void

- Defined in core/entity.ts:259
Renders the entity, components and all children recursively.

Parameters
- shader: Shader
Returns void
void

unsubscribeAll

unsubscribeAll(): void

- Defined in core/entity.ts:310
Unsubscribe the components, behaviours and children from all message types.

Returns void
void

update

update(delta: number): void

- Defined in core/entity.ts:274
Updates the entity by delta and recursively called on components, behaviours and children.

Parameters
- delta: number
Returns void
void

updateReady

updateReady(): void

- Defined in core/entity.ts:295
Checks if the components, behaviours and children is ready.

Returns void
void

Private updateWorldMatrix

updateWorldMatrix(parentWorldMatrix: undefined | Matrix4): void

- Defined in core/entity.ts:351
Updates the world matrix based on the parent matrix and the local matrix.

Parameters
- parentWorldMatrix: undefined | Matrix4
Returns void
void

Generated using TypeDoc