i-entity overview

---

Table of contents

• utils
• IEntity (class)
  • addChildren (method)
  • removeChildren (method)
  • addComponents (method)
  • removeComponents (method)
  • onSpawned (method)
  • onRemoved (method)
  • dispose (method)
  • tick$ (property)
  • tickOrder (property)
  • _world (property)
  • _name (property)
  • _selfActive (property)
  • parent (property)
  • _onSpawned$ (property)
  • _onRemoved$ (property)

---

utils

IEntity (class)

Signature

export declare class IEntity<D, R, VTypeDoc, PTypeDoc>

addChildren (method)

Signature

public addChildren(...entities: IEntity[])

removeChildren (method)

Signature

public removeChildren(entities: IEntity[], dispose: boolean = false)

addComponents (method)

Signature

public addComponents(...components: IWorldComponent<D, R, VTypeDoc, PTypeDoc>[])

removeComponents (method)

Signature

public removeComponents(components: IWorldComponent<D, R, VTypeDoc, PTypeDoc>[], dispose: boolean = false)

onSpawned (method)

Signature

public onSpawned(world: GgWorld<D, R, VTypeDoc, PTypeDoc>)

onRemoved (method)

Signature

public onRemoved()

dispose (method)

Signature

public dispose(): void

tick$ (property)

will receive [elapsed time, delta] of each world clock tick

Signature

readonly tick$: any

tickOrder (property)

the priority of ticker: the less value, the earlier tick will be run.

Signature

readonly tickOrder: number

_world (property)

a world reference, where this entity was added to

Signature

_world: GgWorld<
  D,
  R,
  VTypeDoc,
  PTypeDoc,
  IVisualSceneComponent<D, R, VTypeDoc>,
  IPhysicsWorldComponent<D, R, PTypeDoc>
> | null

_name (property)

Signature

_name: string

_selfActive (property)

The flag whether entity should listen to ticks. If set to false, ticks will not be propagated to this entity

Signature

_selfActive: boolean

parent (property)

Signature

parent: IEntity<any, any, VisualTypeDocRepo<any, any>, PhysicsTypeDocRepo<any, any>> | null

_onSpawned$ (property)

Signature

_onSpawned$: any

_onRemoved$ (property)

Signature

_onRemoved$: any