Class Entity

Hierarchy

UniqueObject
- Entity

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Entity(): Entity

Inherited from UniqueObject.constructor
- Defined in src/core/UniqueObject.ts:16
Returns Entity

Properties

children

children: Entity[] = []

id

id: string

name

name: string

Optional parent

parent: Entity

Optional prefabId

prefabId: undefined | string

Optional templatePath

templatePath: undefined | string

transient

transient: boolean = false

Accessors

active

get active(): boolean
set active(active: boolean): void

- Defined in src/core/Entity.ts:106
Returns boolean
- Defined in src/core/Entity.ts:107
Parameters
- active: boolean
Returns void

transform

get transform(): Transform

- Defined in src/core/Entity.ts:105
Returns Transform

Methods

addChild

addChild(c: Entity, preserveWorldPosition?: boolean): this

- Defined in src/core/Entity.ts:193
Parameters
- c: Entity
- Default value preserveWorldPosition: boolean = false
Returns this

clearComponent

clearComponent<T>(ctor: Constructor<T>): this

- Defined in src/core/Entity.ts:162
Type parameters
- T: Component
Parameters
- ctor: Constructor<T>
Returns this

copy

copy(oldIdToNewId?: undefined | __type, persistent?: undefined | false | true): Entity

Overrides UniqueObject.copy
- Defined in src/core/Entity.ts:399
Parameters
- Optional oldIdToNewId: undefined | __type
- Optional persistent: undefined | false | true
Returns Entity

deserialize

deserialize(json: SerializedObjectType): Promise<never>

Overrides SerializableObject.deserialize
- Defined in src/core/Entity.ts:386
Parameters
- json: SerializedObjectType
Returns Promise<never>

destroy

destroy(): void

Overrides SerializableObject.destroy
- Defined in src/core/Entity.ts:361
Returns void

filterChildren

filterChildren(filter: function): Entity[]

- Defined in src/core/Entity.ts:288
Parameters
- filter: function
  - - (child: Entity): boolean
    - Parameters
      - child: Entity
      Returns boolean
Returns Entity[]

findChild

findChild(name: string): Entity | undefined

- Defined in src/core/Entity.ts:273
Parameters
- name: string
Returns Entity | undefined

getAncestor

getAncestor(typeName: string): Component | null

- Defined in src/core/Entity.ts:346
Parameters
- typeName: string
Returns Component | null

getAncestorOfType

getAncestorOfType<T>(ctor: Constructor<T>): T | null

- Defined in src/core/Entity.ts:357
Type parameters
- T: Component
Parameters
- ctor: Constructor<T>
Returns T | null

getComponent

getComponent<T>(ctor: Constructor<T>): null | T

- Defined in src/core/Entity.ts:154
Type parameters
- T: Component
Parameters
- ctor: Constructor<T>
Returns null | T

getComponentByName

getComponentByName(name: string): null | Component

- Defined in src/core/Entity.ts:158
Parameters
- name: string
Returns null | Component

getComponents

getComponents<T>(ctor: Constructor<T>): T[]

- Defined in src/core/Entity.ts:187
Type parameters
- T: Component
Parameters
- ctor: Constructor<T>
Returns T[]

getOrSetComponent

getOrSetComponent<T>(ctor: Constructor<T>): T

- Defined in src/core/Entity.ts:179
Type parameters
- T: Component
Parameters
- ctor: Constructor<T>
Returns T

getOrSetComponentByName

getOrSetComponentByName(name: string): Component

- Defined in src/core/Entity.ts:183
Parameters
- name: string
Returns Component

hasComponent

hasComponent<T>(ctor: Constructor<T>): boolean

- Defined in src/core/Entity.ts:376
Type parameters
- T
Parameters
- ctor: Constructor<T>
Returns boolean

hasComponentByName

hasComponentByName(typeName: string): boolean

- Defined in src/core/Entity.ts:372
Parameters
- typeName: string
Returns boolean

hasTag

hasTag(tag: string): boolean

- Defined in src/core/Entity.ts:316
Parameters
- tag: string
Returns boolean

insertChild

insertChild(c: Entity, index: number, preserveWorldPosition?: boolean): this

- Defined in src/core/Entity.ts:214
Parameters
- c: Entity
- index: number
- Default value preserveWorldPosition: boolean = false
Returns this

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

isAncestor

isAncestor(potentialAncestor: Entity): boolean

- Defined in src/core/Entity.ts:299
Parameters
- potentialAncestor: Entity
Returns boolean

isLoaded

isLoaded(): boolean

- Defined in src/core/Entity.ts:126
Returns boolean

iterateComponents

iterateComponents(handler: function): void

- Defined in src/core/Entity.ts:340
Parameters
- handler: function
  - - (component: Component): void
    - Parameters
      - component: Component
      Returns void
Returns void

removeAllChildren

removeAllChildren(): this

- Defined in src/core/Entity.ts:245
Returns this

removeChild

removeChild(c: Entity): this

- Defined in src/core/Entity.ts:235
Parameters
- c: Entity
Returns this

serialize

serialize(): object

Overrides SerializableObject.serialize
- Defined in src/core/Entity.ts:380
Returns object
- properties: object
- typeName: string
- version: number

setComponent

setComponent<T>(ctor: object, props?: ObjectProps<T>): this

- Defined in src/core/Entity.ts:143
Type parameters
- T: Component
Parameters
- ctor: object
- Optional props: ObjectProps<T>
Returns this

setComponentByName

setComponentByName(name: string, props?: ObjectProps<Component>): this

- Defined in src/core/Entity.ts:149
Parameters
- name: string
- Optional props: ObjectProps<Component>
Returns this

setProperty

setProperty(name: string, value: any): void

Inherited from SerializableObject.setProperty
- Defined in src/core/SerializableObject.ts:37
Parameters
- name: string
- value: any
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

setTag

setTag(tag: string): this

- Defined in src/core/Entity.ts:309
Parameters
- tag: string
Returns this

traverse

traverse(handler: function, includeSelf?: boolean): void

- Defined in src/core/Entity.ts:320
Parameters
- handler: function
  - - (e: Entity): boolean
    - Parameters
      - e: Entity
      Returns boolean
- Default value includeSelf: boolean = false
Returns void

traverseAncestors

traverseAncestors(handler: function, includeSelf?: boolean): void

- Defined in src/core/Entity.ts:330
Parameters
- handler: function
  - - (e: Entity): boolean
    - Parameters
      - e: Entity
      Returns boolean
- Default value includeSelf: boolean = false
Returns void

updateComponent

updateComponent<T>(ctor: Constructor<T>, props: ObjectProps<T>): this

- Defined in src/core/Entity.ts:167
Type parameters
- T: Component
Parameters
- ctor: Constructor<T>
- props: ObjectProps<T>
Returns this

updateComponentByName

updateComponentByName(name: string, props: ObjectProps<Component>): this

- Defined in src/core/Entity.ts:171
Parameters
- name: string
- props: ObjectProps<Component>
Returns this

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Inherited from SerializableObject.upgrade
- Defined in src/core/SerializableObject.ts:50
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject