Interface IEntity

Hierarchy

IReadOnlyEntity
- IEntity

Implemented by

Entity

Index

Properties

Methods

addComponent addEventListener addTag clone getComponent getComponentCount getComponents getTagCount getTags hasComponent hasTag removeComponent removeEventListener removeTag

Properties

`Readonly` id

id: string

UUID to identify the entity across instances The ID is generated and must be manually maintained when syncing with another instance

Methods

addComponent

addComponent(component, ...args): IEntity
Add a component to this entity
Parameters
- component: object | TObjectProto
- Rest ...args: readonly unknown[]
Returns IEntity
- Defined in src/entity/entity.spec.ts:104

addEventListener

addEventListener<T>(event, handler): void
Add event listener
Type Parameters
- T extends keyof IEventMap
Parameters
- event: T
- handler: IEventMap[T]
Returns void
Inherited from IReadOnlyEntity.addEventListener
- Defined in src/entity/entity.spec.ts:42

addTag

addTag(tag): IEntity
Add a tag to this entity Tagging can be used to mark the entity instead of using an empty marker-component Tags cannot be queried for! They are only markers and should be implemented and used as lean and light-weight as possible.
Parameters
- tag: TTag
Returns IEntity
- Defined in src/entity/entity.spec.ts:113

clone

clone(serde, uuid?): IEntity
Clone this entity with all of its components and tags. This is done by serializing and de-serializing the entity
Parameters
- serde: ISerDe
  
  SerDe to use for serialization
- Optional uuid: string
  
  UUID of new component
Returns IEntity
Inherited from IReadOnlyEntity.clone
- Defined in src/entity/entity.spec.ts:50

getComponent

getComponent<T>(component): undefined | T
Get a component of a certain type which is associated with this entity
Type Parameters
- T extends object
Parameters
- component: TTypeProto<T>
Returns undefined | T
Inherited from IReadOnlyEntity.getComponent
- Defined in src/entity/entity.spec.ts:56

getComponentCount

getComponentCount(): number
Get number of components associated with this entity

Returns number
Inherited from IReadOnlyEntity.getComponentCount
- Defined in src/entity/entity.spec.ts:61

getComponents

getComponents(): IterableIterator<object>
Get all components

Returns IterableIterator<object>
Inherited from IReadOnlyEntity.getComponents
- Defined in src/entity/entity.spec.ts:66

getTagCount

getTagCount(): number
Get number of tags associated with this entity

Returns number
Inherited from IReadOnlyEntity.getTagCount
- Defined in src/entity/entity.spec.ts:71

getTags

getTags(): IterableIterator<TTag>
Get all tags

Returns IterableIterator<TTag>
Inherited from IReadOnlyEntity.getTags
- Defined in src/entity/entity.spec.ts:76

hasComponent

hasComponent(component): boolean
Check if a certain component is associated with this entity
Parameters
- component: ObjectConstructor | TObjectProto
Returns boolean
Inherited from IReadOnlyEntity.hasComponent
- Defined in src/entity/entity.spec.ts:82

hasTag

hasTag(tag): boolean
Check if this entity has a given tag
Parameters
- tag: TTag
Returns boolean
Inherited from IReadOnlyEntity.hasTag
- Defined in src/entity/entity.spec.ts:88

removeComponent

removeComponent(component): IEntity
Un-associate a component from this entity
Parameters
- component: object | TObjectProto
Returns IEntity
- Defined in src/entity/entity.spec.ts:119

removeEventListener

removeEventListener<T>(event, handler): void
Remove a listener
Type Parameters
- T extends keyof IEventMap
Parameters
- event: T
- handler: IEventMap[T]
Returns void
Inherited from IReadOnlyEntity.removeEventListener
- Defined in src/entity/entity.spec.ts:95

removeTag

removeTag(tag): IEntity
Remove a tag from this entity
Parameters
- tag: TTag
Returns IEntity
- Defined in src/entity/entity.spec.ts:125

Generated using TypeDoc