Interface IReadOnlyEntity

Readonly id

addEventListener

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

• Add event listener

  Type Parameters

  • T extends keyof IEventMap

  Parameters

  • event: T

  • handler: IEventMap[T]

  Returns void

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

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

removeEventListener

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

• Remove a listener

  Type Parameters

  • T extends keyof IEventMap

  Parameters

  • event: T

  • handler: IEventMap[T]

  Returns void