Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Entity

Abstract Entity - any object existing in a Game's World, Text or UI, comprised of Components and handled by respective EntityManagers

Concrete Entities implemented in Games should extend from this class, overring its methods as required

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Constructor. Take an EntityConfig and initialise the Entity's Components, if provided

    Parameters

    Returns Entity

Properties

Readonly id

id: string = ...

Unique id for the Entity

Accessors

tag

  • get tag(): string

  • Retrieve the Entity's tag as provided in its config

    Returns string

    the Entity's tag

Methods

addComponent

  • Add a Component to the Entity

    Parameters

    Returns void

addComponents

  • addComponents(...components: Component[]): void

  • Add a list of Components to the Entity

    Parameters

    • Rest ...components: Component[]

      the Components to add

    Returns void

getComponent

  • getComponent<T>(name: string): T

  • Retrieve a Component by name

    Throws an error if the Component is not found on the Entity to allow type safety + simplistic no-questions consumer calls

    Type parameters

    • T: Component<T>

      the type of the Component to retrieve

    Parameters

    • name: string

      the name of the Component to retrieve

    Returns T

    the retrieved Component

hasComponent

  • hasComponent(name: string): boolean

  • Check if the Entity has a named Component

    Parameters

    • name: string

      the name of the Component to check

    Returns boolean

    whether or not the Entity has the named Component

hasComponents

  • hasComponents(...names: string[]): boolean

  • Check if the Entity has a list of named Components

    Parameters

    • Rest ...names: string[]

      the names of the Components to check

    Returns boolean

    whether or not the Entity has all of the named Components

onCollisionContinue

  • Optional collision callback method for the continuation of a collision with another specific Entity, implentable by concrete Entities

    Parameters

    • game: GameBase

      the 2D or 3D Game the System is operating within

    • other: Entity

      the Entity with which collision continues

    Returns void

onCollisionEnd

  • Optional collision callback method for the end of a collision with another specific Entity, implementable by concrete Entities

    Parameters

    • game: GameBase

      the 2D or 3D Game the System is operating within

    • other: Entity

      the Entity with which collision has ended

    Returns void

onCollisionStart

  • Optional collision callback method for the start of a collision with another specific Entity, implementable by concrete Entities

    Parameters

    • game: GameBase

      the 2D or 3D Game the System is operating within

    • other: Entity

      the Entity with which collision has begun

    Returns void

removeComponent

  • removeComponent(name: string): void

  • Remove the named Component from the Entity

    Parameters

    • name: string

      the name of the Component to remove

    Returns void

removeComponents

  • removeComponents(...names: string[]): void

  • Remove a list of named Components from the Entity

    Parameters

    • Rest ...names: string[]

      the names of the Components to remove

    Returns void

tick

  • tick(game: GameBase, frameDelta: number): void

  • Optional frame update function called by the EntityManager during frame execution, implementable by concrete Entities

    Parameters

    • game: GameBase

      the Game the System is operating within

    • frameDelta: number

      the frame delta as calculated by the Game

    Returns void