World |

Hierarchy

WorldBase
- World

Properties

Private tmpEntity

tmpEntity: any

Methods

addComponent

addComponent<T>(entity: Entity, ctype: ComponentClass<T> | T): void

- Defined in RuntimeFull.ts:126
Type parameters
- T
Parameters
- entity: Entity
- ctype: ComponentClass<T> | T
Returns void

addComponentData

addComponentData<T>(entity: Entity, cdata: T): void

- Defined in RuntimeFull.ts:127
Type parameters
- T
Parameters
- entity: Entity
- cdata: T
Returns void

addComponentRaw

addComponentRaw(entity: Entity, type: ComponentTypeId): void

Inherited from WorldBase.addComponentRaw
- Defined in RuntimeFull.ts:511
Parameters
- entity: Entity
- type: ComponentTypeId
Returns void

addSharedComponent

addSharedComponent<T>(entity: Entity, ctype: ComponentClass<T> | T): void

- Defined in RuntimeFull.ts:131
Type parameters
- T
Parameters
- entity: Entity
- ctype: ComponentClass<T> | T
Returns void

allocChunkIterator

allocChunkIterator(...specs: ComponentSpec[]): ArchetypeChunkIterator

- Defined in RuntimeFull.ts:137
Parameters
- Rest ...specs: ComponentSpec[]
Returns ArchetypeChunkIterator

bufferDepth

bufferDepth(): number

Inherited from WorldBase.bufferDepth
- Defined in RuntimeFull.ts:491
Returns number

createArchetype

createArchetype(...ctypes: any[]): Archetype

- Defined in RuntimeFull.ts:136
Parameters
- Rest ...ctypes: any[]
Returns Archetype

createEntities

createEntities(archetype: Archetype, count: number): Entity[]

- Defined in RuntimeFull.ts:122
Parameters
- archetype: Archetype
- count: number
Returns Entity[]

createEntity

createEntity(archetype?: Archetype): Entity

Inherited from WorldBase.createEntity
- Defined in RuntimeFull.ts:497
Create an entity with ut.Archetype{@link archetype}.

Parameters
- Optional archetype: Archetype
Returns Entity

debugCheckEntities

debugCheckEntities(): void

Inherited from WorldBase.debugCheckEntities
- Defined in RuntimeFull.ts:472
Returns void

destroyEntities

destroyEntities(entities: Entity[]): void

- Defined in RuntimeFull.ts:124
Parameters
- entities: Entity[]
Returns void

destroyEntity

destroyEntity(entity: Entity): void

Inherited from WorldBase.destroyEntity
- Defined in RuntimeFull.ts:505
Destroy {@link entity}. If the entity has any State Components, all non-System State Components are removed, but the entity is not destroyed until all System State Component are deleted by the systems they belong to.

Parameters
- entity: Entity
Returns void

emptyArchetype

emptyArchetype(): Archetype

Inherited from WorldBase.emptyArchetype
- Defined in RuntimeFull.ts:495
Return the empty ut.Archetype, containing no components.

Returns Archetype

exists

exists(entity: Entity): boolean

Inherited from WorldBase.exists
- Defined in RuntimeFull.ts:507
Returns true if {@link entity} refers to a valid, live entity.

Parameters
- entity: Entity
Returns boolean

forEach

forEach<A>(components: [CSA<A>], fn: function): void
forEach<A>(components: [CSA<A>], specs: ComponentSpec[], fn: function): void
forEach<A, B>(components: [CSA<A>, CSA], fn: function): void
forEach<A, B>(components: [CSA<A>, CSA], specs: ComponentSpec[], fn: function): void
forEach<A, B, C>(components: [CSA<A>, CSA, CSA<C>], fn: function): void
forEach<A, B, C>(components: [CSA<A>, CSA, CSA<C>], specs: ComponentSpec[], fn: function): void
forEach<A, B, C, D>(components: [CSA<A>, CSA, CSA<C>, CSA<D>], fn: function): void
forEach<A, B, C, D>(components: [CSA<A>, CSA, CSA<C>, CSA<D>], specs: ComponentSpec[], fn: function): void
forEach<A, B, C, D, E>(components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>], fn: function): void
forEach<A, B, C, D, E>(components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>], specs: ComponentSpec[], fn: function): void
forEach<A, B, C, D, E, F>(components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>, CSA<F>], fn: function): void
forEach<A, B, C, D, E, F>(components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>, CSA<F>], specs: ComponentSpec[], fn: function): void
forEach<A, B, C, D, E, F, G>(components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>, CSA<F>, CSA<G>], fn: function): void
forEach<A, B, C, D, E, F, G>(components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>, CSA<F>, CSA<G>], specs: ComponentSpec[], fn: function): void
forEach<A, B, C, D, E, F, G, H>(components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>, CSA<F>, CSA<G>, CSA<H>], fn: function): void
forEach<A, B, C, D, E, F, G, H>(components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>, CSA<F>, CSA<G>, CSA<H>], specs: ComponentSpec[], fn: function): void
forEach(components: CSABase[], fn: function): void
forEach(components: CSABase[], specs: ComponentSpec[], fn: function): void

- Defined in RuntimeFull.ts:138
Type parameters
- A
Parameters
- components: [CSA<A>]
- fn: function
 - - (a: A): void
 - Parameters
 - a: A
 Returns void
Returns void
- Defined in RuntimeFull.ts:139
Type parameters
- A
Parameters
- components: [CSA<A>]
- specs: ComponentSpec[]
- fn: function
 - - (a: A): void
 - Parameters
 - a: A
 Returns void
Returns void
- Defined in RuntimeFull.ts:140
Type parameters
- A
- B
Parameters
- components: [CSA<A>, CSA]
- fn: function
 - - (a: A, b: B): void
 - Parameters
 - a: A
 - b: B
 Returns void
Returns void
- Defined in RuntimeFull.ts:141
Type parameters
- A
- B
Parameters
- components: [CSA<A>, CSA]
- specs: ComponentSpec[]
- fn: function
 - - (a: A, b: B): void
 - Parameters
 - a: A
 - b: B
 Returns void
Returns void
- Defined in RuntimeFull.ts:142
Type parameters
- A
- B
- C
Parameters
- components: [CSA<A>, CSA, CSA<C>]
- fn: function
 - - (a: A, b: B, c: C): void
 - Parameters
 - a: A
 - b: B
 - c: C
 Returns void
Returns void
- Defined in RuntimeFull.ts:143
Type parameters
- A
- B
- C
Parameters
- components: [CSA<A>, CSA, CSA<C>]
- specs: ComponentSpec[]
- fn: function
 - - (a: A, b: B, c: C): void
 - Parameters
 - a: A
 - b: B
 - c: C
 Returns void
Returns void
- Defined in RuntimeFull.ts:144
Type parameters
- A
- B
- C
- D
Parameters
- components: [CSA<A>, CSA, CSA<C>, CSA<D>]
- fn: function
 - - (a: A, b: B, c: C, d: D): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 Returns void
Returns void
- Defined in RuntimeFull.ts:145
Type parameters
- A
- B
- C
- D
Parameters
- components: [CSA<A>, CSA, CSA<C>, CSA<D>]
- specs: ComponentSpec[]
- fn: function
 - - (a: A, b: B, c: C, d: D): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 Returns void
Returns void
- Defined in RuntimeFull.ts:146
Type parameters
- A
- B
- C
- D
- E
Parameters
- components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>]
- fn: function
 - - (a: A, b: B, c: C, d: D, e: E): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 - e: E
 Returns void
Returns void
- Defined in RuntimeFull.ts:147
Type parameters
- A
- B
- C
- D
- E
Parameters
- components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>]
- specs: ComponentSpec[]
- fn: function
 - - (a: A, b: B, c: C, d: D, e: E): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 - e: E
 Returns void
Returns void
- Defined in RuntimeFull.ts:148
Type parameters
- A
- B
- C
- D
- E
- F
Parameters
- components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>, CSA<F>]
- fn: function
 - - (a: A, b: B, c: C, d: D, e: E, f: F): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 - e: E
 - f: F
 Returns void
Returns void
- Defined in RuntimeFull.ts:149
Type parameters
- A
- B
- C
- D
- E
- F
Parameters
- components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>, CSA<F>]
- specs: ComponentSpec[]
- fn: function
 - - (a: A, b: B, c: C, d: D, e: E, f: F): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 - e: E
 - f: F
 Returns void
Returns void
- Defined in RuntimeFull.ts:150
Type parameters
- A
- B
- C
- D
- E
- F
- G
Parameters
- components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>, CSA<F>, CSA<G>]
- fn: function
 - - (a: A, b: B, c: C, d: D, e: E, f: F, g: G): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 - e: E
 - f: F
 - g: G
 Returns void
Returns void
- Defined in RuntimeFull.ts:151
Type parameters
- A
- B
- C
- D
- E
- F
- G
Parameters
- components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>, CSA<F>, CSA<G>]
- specs: ComponentSpec[]
- fn: function
 - - (a: A, b: B, c: C, d: D, e: E, f: F, g: G): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 - e: E
 - f: F
 - g: G
 Returns void
Returns void
- Defined in RuntimeFull.ts:152
Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>, CSA<F>, CSA<G>, CSA<H>]
- fn: function
 - - (a: A, b: B, c: C, d: D, e: E, f: F, g: G, h: H): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 - e: E
 - f: F
 - g: G
 - h: H
 Returns void
Returns void
- Defined in RuntimeFull.ts:153
Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- components: [CSA<A>, CSA, CSA<C>, CSA<D>, CSA<E>, CSA<F>, CSA<G>, CSA<H>]
- specs: ComponentSpec[]
- fn: function
 - - (a: A, b: B, c: C, d: D, e: E, f: F, g: G, h: H): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 - e: E
 - f: F
 - g: G
 - h: H
 Returns void
Returns void
- Defined in RuntimeFull.ts:154
Parameters
- components: CSABase[]
- fn: function
  - - (...comps: any[]): void
    - Parameters
      - Rest ...comps: any[]
      Returns void
Returns void
- Defined in RuntimeFull.ts:155
Parameters
- components: CSABase[]
- specs: ComponentSpec[]
- fn: function
  - - (...comps: any[]): void
    - Parameters
      - Rest ...comps: any[]
      Returns void
Returns void

fromJSON

fromJSON(json: string): void

Inherited from WorldBase.fromJSON
- Defined in RuntimeFull.ts:490
Parameters
- json: string
Returns void

getArchetype

getArchetype(entity: Entity): Archetype

Inherited from WorldBase.getArchetype
- Defined in RuntimeFull.ts:509
Returns the ut.Archetype of {@link entity}.

Parameters
- entity: Entity
Returns Archetype

getComponentData

getComponentData<T>(entity: Entity, ctype: ComponentClass<T>): T

- Defined in RuntimeFull.ts:129
Type parameters
- T
Parameters
- entity: Entity
- ctype: ComponentClass<T>
Returns T

getConfigData

getConfigData<T>(ctype: ComponentClass<T>): T

- Defined in RuntimeFull.ts:134
Type parameters
- T
Parameters
- ctype: ComponentClass<T>
Returns T

getConfigEntity

getConfigEntity(): Entity

Inherited from WorldBase.getConfigEntity
- Defined in RuntimeFull.ts:486
Gets the ut.Entity that contains configuration components.

Returns Entity

getEntityByName

getEntityByName(name: string): Entity

Inherited from WorldBase.getEntityByName
- Defined in RuntimeFull.ts:482
Finds an entity by its name. If multiple entities have the same name, this function returns only one of them. Which one it returns may change from one GetEntityByName call to the next.

This operation is slow. If you need direct access to entities, you can save ut.Entity references to them ahead of time and use the references directly.

Parameters
- name: string
Returns Entity

getEntityName

getEntityName(entity: Entity): string

Inherited from WorldBase.getEntityName
- Defined in RuntimeFull.ts:474
Parameters
- entity: Entity
Returns string

getOrAddComponentData

getOrAddComponentData<T>(entity: Entity, ctype: ComponentClass<T>): T

- Defined in RuntimeFull.ts:158
Gets the component data if it's already present on the given entity, or adds it, and returns it. For performance, if you expect the component to be present on the entity you should call getComponentData directly.

Type parameters
- T: Component
Parameters
- entity: Entity
- ctype: ComponentClass<T>
Returns T

getSharedComponentData

getSharedComponentData<T>(entity: Entity, ctype: ComponentClass<T>): T

- Defined in RuntimeFull.ts:132
Type parameters
- T
Parameters
- entity: Entity
- ctype: ComponentClass<T>
Returns T

hasComponent

hasComponent<T>(entity: Entity, ctype: ComponentClass<T>): boolean

- Defined in RuntimeFull.ts:125
Type parameters
- T
Parameters
- entity: Entity
- ctype: ComponentClass<T>
Returns boolean

hasComponentRaw

hasComponentRaw(entity: Entity, type: ComponentTypeId): boolean

Inherited from WorldBase.hasComponentRaw
- Defined in RuntimeFull.ts:510
Parameters
- entity: Entity
- type: ComponentTypeId
Returns boolean

instantiateEntities

instantiateEntities(proto: Entity, count: number): Entity[]

- Defined in RuntimeFull.ts:123
Parameters
- proto: Entity
- count: number
Returns Entity[]

instantiateEntity

instantiateEntity(proto: Entity): Entity

Inherited from WorldBase.instantiateEntity
- Defined in RuntimeFull.ts:501
Instantiate (clone) the source entity {@link proto}. This is a shallow copy of the source entity's components. Transform hierarchy children are ignored.

Parameters
- proto: Entity
Returns Entity

removeComponent

removeComponent<T>(entity: Entity, ctype: ComponentClass<T>): void

- Defined in RuntimeFull.ts:128
Type parameters
- T
Parameters
- entity: Entity
- ctype: ComponentClass<T>
Returns void

removeComponentRaw

removeComponentRaw(entity: Entity, type: ComponentTypeId): void

Inherited from WorldBase.removeComponentRaw
- Defined in RuntimeFull.ts:512
Parameters
- entity: Entity
- type: ComponentTypeId
Returns void

run

run(): void

Inherited from WorldBase.run
- Defined in RuntimeFull.ts:488
Runs the default scheduler.

Returns void

scheduler

scheduler(): SchedulerBase

Inherited from WorldBase.scheduler
- Defined in RuntimeFull.ts:484
Obtains the default frame scheduler for this world.

Returns SchedulerBase

setComponentData

setComponentData<T>(entity: Entity, cdata: T): void

- Defined in RuntimeFull.ts:130
Type parameters
- T
Parameters
- entity: Entity
- cdata: T
Returns void

setConfigData

setConfigData<T>(cdata: T): void

- Defined in RuntimeFull.ts:135
Type parameters
- T
Parameters
- cdata: T
Returns void

setEntityName

setEntityName(entity: Entity, name: string): void

Inherited from WorldBase.setEntityName
- Defined in RuntimeFull.ts:473
Parameters
- entity: Entity
- name: string
Returns void

setOrAddComponentData

setOrAddComponentData<T>(entity: Entity, cdata: T): void

- Defined in RuntimeFull.ts:161
Sets the component data if it's already present on the given entity, or adds it. For performance, if you expect the component to be present on the entity you should call setComponentData directly.

Type parameters
- T: Component
Parameters
- entity: Entity
- cdata: T
Returns void

setSharedComponentData

setSharedComponentData<T>(entity: Entity, cdata: T): void

- Defined in RuntimeFull.ts:133
Type parameters
- T
Parameters
- entity: Entity
- cdata: T
Returns void

startBuffering

startBuffering(): void

Inherited from WorldBase.startBuffering
- Defined in RuntimeFull.ts:492
Returns void

stopBuffering

stopBuffering(): void

Inherited from WorldBase.stopBuffering
- Defined in RuntimeFull.ts:493
Returns void

toJSON

toJSON(): string

Inherited from WorldBase.toJSON
- Defined in RuntimeFull.ts:489
Returns string

usingComponentData

usingComponentData<A>(entity: Entity, components: [CC<A>], fn: function): void
usingComponentData<A, B>(entity: Entity, components: [CC<A>, CC], fn: function): void
usingComponentData<A, B, C>(entity: Entity, components: [CC<A>, CC, CC<C>], fn: function): void
usingComponentData<A, B, C, D>(entity: Entity, components: [CC<A>, CC, CC<C>, CC<D>], fn: function): void
usingComponentData<A, B, C, D, E>(entity: Entity, components: [CC<A>, CC, CC<C>, CC<D>, CC<E>], fn: function): void
usingComponentData<A, B, C, D, E, F>(entity: Entity, components: [CC<A>, CC, CC<C>, CC<D>, CC<E>, CC<F>], fn: function): void
usingComponentData<A, B, C, D, E, F, G>(entity: Entity, components: [CC<A>, CC, CC<C>, CC<D>, CC<E>, CC<F>, CC<G>], fn: function): void
usingComponentData<A, B, C, D, E, F, G, H>(entity: Entity, components: [CC<A>, CC, CC<C>, CC<D>, CC<E>, CC<F>, CC<G>, CC<H>], fn: function): void

- Defined in RuntimeFull.ts:162
Type parameters
- A
Parameters
- entity: Entity
- components: [CC<A>]
- fn: function
 - - (a: A): void
 - Parameters
 - a: A
 Returns void
Returns void
- Defined in RuntimeFull.ts:163
Type parameters
- A
- B
Parameters
- entity: Entity
- components: [CC<A>, CC]
- fn: function
 - - (a: A, b: B): void
 - Parameters
 - a: A
 - b: B
 Returns void
Returns void
- Defined in RuntimeFull.ts:164
Type parameters
- A
- B
- C
Parameters
- entity: Entity
- components: [CC<A>, CC, CC<C>]
- fn: function
 - - (a: A, b: B, c: C): void
 - Parameters
 - a: A
 - b: B
 - c: C
 Returns void
Returns void
- Defined in RuntimeFull.ts:165
Type parameters
- A
- B
- C
- D
Parameters
- entity: Entity
- components: [CC<A>, CC, CC<C>, CC<D>]
- fn: function
 - - (a: A, b: B, c: C, d: D): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 Returns void
Returns void
- Defined in RuntimeFull.ts:166
Type parameters
- A
- B
- C
- D
- E
Parameters
- entity: Entity
- components: [CC<A>, CC, CC<C>, CC<D>, CC<E>]
- fn: function
 - - (a: A, b: B, c: C, d: D, e: E): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 - e: E
 Returns void
Returns void
- Defined in RuntimeFull.ts:167
Type parameters
- A
- B
- C
- D
- E
- F
Parameters
- entity: Entity
- components: [CC<A>, CC, CC<C>, CC<D>, CC<E>, CC<F>]
- fn: function
 - - (a: A, b: B, c: C, d: D, e: E, f: F): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 - e: E
 - f: F
 Returns void
Returns void
- Defined in RuntimeFull.ts:168
Type parameters
- A
- B
- C
- D
- E
- F
- G
Parameters
- entity: Entity
- components: [CC<A>, CC, CC<C>, CC<D>, CC<E>, CC<F>, CC<G>]
- fn: function
 - - (a: A, b: B, c: C, d: D, e: E, f: F, g: G): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 - e: E
 - f: F
 - g: G
 Returns void
Returns void
- Defined in RuntimeFull.ts:169
Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- entity: Entity
- components: [CC<A>, CC, CC<C>, CC<D>, CC<E>, CC<F>, CC<G>, CC<H>]
- fn: function
 - - (a: A, b: B, c: C, d: D, e: E, f: F, g: G, h: H): void
 - Parameters
 - a: A
 - b: B
 - c: C
 - d: D
 - e: E
 - f: F
 - g: G
 - h: H
 Returns void
Returns void

world

world(): World

- Defined in RuntimeFull.ts:170
Returns World

Hierarchy

Index

Properties

Methods

Properties

Private tmpEntity

Methods

addComponent

Type parameters

T

Parameters

entity: Entity

ctype: ComponentClass<T> | T

Returns void

addComponentData

Type parameters

T

Parameters

entity: Entity

cdata: T

Returns void

addComponentRaw

Parameters

entity: Entity

type: ComponentTypeId

Returns void

addSharedComponent

Type parameters

T

Parameters

entity: Entity

ctype: ComponentClass<T> | T

Returns void

allocChunkIterator

Parameters

Rest ...specs: ComponentSpec[]

Returns ArchetypeChunkIterator

bufferDepth

Returns number

createArchetype

Parameters

Rest ...ctypes: any[]

Returns Archetype

createEntities

Parameters

archetype: Archetype

count: number

Returns Entity[]

createEntity

Parameters

Optional archetype: Archetype

Returns Entity

debugCheckEntities

Returns void

destroyEntities

Parameters

entities: Entity[]

Returns void

destroyEntity

Parameters

entity: Entity

Returns void

emptyArchetype

Returns Archetype

exists

Parameters

entity: Entity

Returns boolean

forEach

Type parameters

A

Parameters

components: [CSA<A>]

fn: function

Parameters

a: A

Returns void

Returns void

Type parameters

A