Class default<CT>

Type parameters

CT

Hierarchy

default

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new default<CT>(world: default<CT>): default<CT>

- Defined in Entity.ts:41
Type parameters
- CT
Parameters
- world: default<CT>
Returns default<CT>

Properties

Private _error

_error: null | Error

Private _id

_id: string

Private _state

_state: default<EntityState, EntityState>

Private _world

_world: default<CT>

Accessors

components

get components(): default<CT>

- Defined in Entity.ts:256
Get all components that have been added to an entity, via a ComponentCollection. Does the same thing as entityInstance.getAll().

Returns default<CT>

id

get id(): string

- Defined in Entity.ts:31
Returns string

state

get state(): EntityState

- Defined in Entity.ts:39
Returns EntityState

tags

get tags(): Set<Tag>

- Defined in Entity.ts:266
Retrieves all the tags that have been added to this entity.

Returns Set<Tag>

world

get world(): default<CT>

- Defined in Entity.ts:35
Returns default<CT>

Methods

add

add<T>(component: T): default<CT>

- Defined in Entity.ts:99
Add a component to an Entity, doh.

Type parameters
- T
Parameters
- component: T
Returns default<CT>

addTag

addTag(tag: Tag): default<CT>

- Defined in Entity.ts:108
Add a tag to a component

Parameters
- tag: Tag
Returns default<CT>

clear

clear(): default<CT>

- Defined in Entity.ts:198
Clears all components from an Entity

Returns default<CT>

clearTags

clearTags(): default<CT>

- Defined in Entity.ts:207
Remove all tags on an entity

Returns default<CT>

destroy

destroy(): void

- Defined in Entity.ts:230
Destroy an entity. Actual destruction is deferred until after the next pass of systems. This gives the systems a chance to do any cleanup that might be needed.

Returns void

destroyImmediately

destroyImmediately(): void

- Defined in Entity.ts:241
Returns void

finishCreation

finishCreation(): void

- Defined in Entity.ts:222
Sets the state of the entity to 'created'. that's it.

Returns void

get

get<T>(cl: ClassConstructor<T>): T

- Defined in Entity.ts:149
Get a component that belongs to an entity.

Type parameters
- T
Parameters
- cl: ClassConstructor<T>
Returns T

getAll

getAll(): default<CT>

- Defined in Entity.ts:162
Get all components that have been added to an entity, via a ComponentCollection

Returns default<CT>

has

has<T>(cType: ClassConstructor<T>): boolean

- Defined in Entity.ts:124
Determines if an entity has a component related to it.

Type parameters
- T
Parameters
- cType: ClassConstructor<T>
Returns boolean

hasTag

hasTag(tag: Tag): boolean

- Defined in Entity.ts:135
Check to see if an entity tagged with a given tag.

Parameters
- tag: Tag
Returns boolean

onComponentAdd

onComponentAdd(args: EntityCompEventArgs<CT>): void

- Defined in Entity.ts:84
Parameters
- args: EntityCompEventArgs<CT>
Returns void

onComponentRemove

onComponentRemove(args: EntityCompEventArgs<CT>): void

- Defined in Entity.ts:92
Parameters
- args: EntityCompEventArgs<CT>
Returns void

onCreate

onCreate(world: default<CT>): void

- Defined in Entity.ts:76
Parameters
- world: default<CT>
Returns void

onDestroy

onDestroy(world: default<CT>): void

- Defined in Entity.ts:80
Parameters
- world: default<CT>
Returns void

onTrackedComponentUpdate

onTrackedComponentUpdate(args: EntityCompEventArgs<CT>): void

- Defined in Entity.ts:88
Parameters
- args: EntityCompEventArgs<CT>
Returns void

remove

remove(cType: ClassConstructor<CT>): default<CT>

- Defined in Entity.ts:173
Remove a component from an entity.

Parameters
- cType: ClassConstructor<CT>
  
  A component class, eg MyComponent
Returns default<CT>

removeTag

removeTag(tag: Tag): default<CT>

- Defined in Entity.ts:182
Remove a tag from an entity

Parameters
- tag: Tag
Returns default<CT>

toDevEntity

toDevEntity(): default<CT>

- Defined in Entity.ts:280
Convert Entity to a DevEntity. Very helpful in for debugging.

Returns default<CT>

Generated using TypeDoc