Class Entity

constructor

• new Entity(uuid?): Entity

• Parameters

  • Optional uuid: string

  Returns Entity

Static uuidFn

id

• get id(): string

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

  Returns string

addComponent

• addComponent(component, ...args): Entity

• Add a component to this entity

  Parameters

  • component: object | TObjectProto

  • Rest ...args: readonly unknown[]

  Returns Entity

addEventListener

• addEventListener<T>(event, handler): void

• Add event listener

  Type Parameters

  • T extends keyof IEventMap

  Parameters

  • event: T

  • handler: IEventMap[T]

  Returns void

addTag

• addTag(tag): Entity

• 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 Entity

clone

• clone(serde, uuid?): Entity

• 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 Entity

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

getComponentCount

• getComponentCount(): number

• Get number of components associated with this entity

  Returns number

getComponents

• getComponents(): IterableIterator<object>

• Get all components

  Returns IterableIterator<object>

getTagCount

• getTagCount(): number

• Get number of tags associated with this entity

  Returns number

getTags

• getTags(): IterableIterator<TTag>

• Get all tags

  Returns IterableIterator<TTag>

hasComponent

• hasComponent(component): boolean

• Check if a certain component is associated with this entity

  Parameters

  • component: ObjectConstructor | TObjectProto

  Returns boolean

hasTag

• hasTag(tag): boolean

• Check if this entity has a given tag

  Parameters

  • tag: TTag

  Returns boolean

removeComponent

• removeComponent(component): Entity

• Un-associate a component from this entity

  Parameters

  • component: object | TObjectProto

  Returns Entity

removeEventListener

• removeEventListener<T>(event, handler): void

• Remove a listener

  Type Parameters

  • T extends keyof IEventMap

  Parameters

  • event: T

  • handler: IEventMap[T]

  Returns void

removeTag

• removeTag(tag): Entity

• Remove a tag from this entity

  Parameters

  • tag: TTag

  Returns Entity