Class BaseEntity

constructor

• new BaseEntity(props?: BaseEntityProps): BaseEntity

  Parameters

  • Optionalprops: BaseEntityProps

  Returns BaseEntity

Readonlyuuid

name

• get name(): string

  Returns string

• set name(value: string): void

  The name of the entity. Must be unique in the same scene

  Parameters

  • value: string

  Returns void

addComponent

• addComponent(component: IComponent): void

  Adds a component to this entity.

  The component type is used as search key for the component. A key is also added for any item in its types chain. If a component of the same type is already present, it will be added to the components list as a new Item. The latest item to be added is the first in the list. The same applies for types in its type chain

  Parameters

  • component: IComponent

    the componnt to add to this entity

  Returns void

getComponent

• getComponent<Component extends IComponent>(type: string): undefined | Component

  Gets the first component matching a specific type. We highly recommend to not use base types as a search key due to high chances of collisions See .addComponent() method

  Type Parameters

  • Component extends IComponent

  Parameters

  • type: string

  Returns undefined | Component

  the first component found with the type

getComponents

• getComponents<Component extends IComponent>(type: string): Component[]

  Gets all the components mathcing a specific type. We highly recommend to not use base types as a search key due to high chances of collisions See .addComponent() method

  Type Parameters

  • Component extends IComponent

  Parameters

  • type: string

  Returns Component[]

  the first component found with the type

toJson

• toJson(): WithType<BaseEntityProps>

  Returns a Json Object representation of the Entity

  Returns WithType<BaseEntityProps>