Class GameObject<TEventMap>

Type Parameters

TEventMap extends Object3DEventMap = Object3DEventMap

Hierarchy

Object3D<TEventMap>
- GameObject

Implements

EntityLike

Index

Constructors

Properties

active componentMask isGameObject

Methods

addComponent clone copy destroy getComponent getComponentTypes hasComponent removeComponent

Constructors

constructor

new GameObject<TEventMap>(world: World): GameObject<TEventMap>
Type Parameters
- TEventMap extends Object3DEventMap = Object3DEventMap
Parameters
- world: World
Returns GameObject<TEventMap>
Overrides Object3D<TEventMap>.constructor
- Defined in src/ecs/GameObject.ts:30

Properties

active

active: boolean = true

componentMask

componentMask: number = 0

`Readonly` isGameObject

isGameObject: boolean = true

Methods

addComponent

addComponent<T>(componentClass: T, initialData?: {
[key: string]: any;
}): Component
Type Parameters
- T extends typeof Component
Parameters
- componentClass: T
- initialData: {
  [key: string]: any;
  } = {}
  - [key: string]: any
Returns Component
Implementation of EntityLike.addComponent
- Defined in src/ecs/GameObject.ts:46

clone

clone(_recursive?: boolean): GameObject<TEventMap>
Parameters
- Optional _recursive: boolean
Returns GameObject<TEventMap>
Overrides Object3D.clone
- Defined in src/ecs/GameObject.ts:42

copy

copy(_source: GameObject<TEventMap>, _recursive?: boolean): GameObject<TEventMap>
Parameters
- _source: GameObject<TEventMap>
- Optional _recursive: boolean
Returns GameObject<TEventMap>
Overrides Object3D.copy
- Defined in src/ecs/GameObject.ts:38

destroy

destroy(): void
Returns void
Implementation of EntityLike.destroy
- Defined in src/ecs/GameObject.ts:102

getComponent

getComponent<T>(componentClass: {
    bitmask: number;
    defaults: {
        [key: string]: any;
    };
    new (_cm: ComponentManager, _mi: number): T;
}): T
Type Parameters
- T extends Component<T>
Parameters
- componentClass: {
      bitmask: number;
      defaults: {
          [key: string]: any;
      };
      new (_cm: ComponentManager, _mi: number): T;
  }
  - - new (_cm: ComponentManager, _mi: number): T
    - Parameters
      
      _cm: ComponentManager
      
      _mi: number
      
      Returns T
  - bitmask: number
  - defaults: {
    [key: string]: any;
    }
    - [key: string]: any
Returns T
Implementation of EntityLike.getComponent
- Defined in src/ecs/GameObject.ts:86

getComponentTypes

getComponentTypes(): typeof Component[]
Returns typeof Component[]
Implementation of EntityLike.getComponentTypes
- Defined in src/ecs/GameObject.ts:97

hasComponent

hasComponent<T>(componentClass: T): boolean
Type Parameters
- T extends typeof Component
Parameters
- componentClass: T
Returns boolean
Implementation of EntityLike.hasComponent
- Defined in src/ecs/GameObject.ts:81

removeComponent

removeComponent<T>(componentClass: T): void
Type Parameters
- T extends typeof Component
Parameters
- componentClass: T
Returns void
Implementation of EntityLike.removeComponent
- Defined in src/ecs/GameObject.ts:65