Class WorldBase

Hierarchy

WorldBase
- World

Methods

addComponentRaw

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

- Defined in RuntimeFull.ts:511
Parameters
- entity: Entity
- type: ComponentTypeId
Returns void

bufferDepth

bufferDepth(): number

- Defined in RuntimeFull.ts:491
Returns number

createEntity

createEntity(archetype?: Archetype): Entity

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

Parameters
- Optional archetype: Archetype
Returns Entity

debugCheckEntities

debugCheckEntities(): void

- Defined in RuntimeFull.ts:472
Returns void

destroyEntity

destroyEntity(entity: Entity): void

- 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

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

Returns Archetype

exists

exists(entity: Entity): boolean

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

Parameters
- entity: Entity
Returns boolean

fromJSON

fromJSON(json: string): void

- Defined in RuntimeFull.ts:490
Parameters
- json: string
Returns void

getArchetype

getArchetype(entity: Entity): Archetype

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

Parameters
- entity: Entity
Returns Archetype

getConfigEntity

getConfigEntity(): Entity

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

Returns Entity

getEntityByName

getEntityByName(name: string): Entity

- 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

- Defined in RuntimeFull.ts:474
Parameters
- entity: Entity
Returns string

hasComponentRaw

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

- Defined in RuntimeFull.ts:510
Parameters
- entity: Entity
- type: ComponentTypeId
Returns boolean

instantiateEntity

instantiateEntity(proto: Entity): Entity

- 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

removeComponentRaw

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

- Defined in RuntimeFull.ts:512
Parameters
- entity: Entity
- type: ComponentTypeId
Returns void

run

run(): void

- Defined in RuntimeFull.ts:488
Runs the default scheduler.

Returns void

scheduler

scheduler(): SchedulerBase

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

Returns SchedulerBase

setEntityName

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

- Defined in RuntimeFull.ts:473
Parameters
- entity: Entity
- name: string
Returns void

startBuffering

startBuffering(): void

- Defined in RuntimeFull.ts:492
Returns void

stopBuffering

stopBuffering(): void

- Defined in RuntimeFull.ts:493
Returns void

toJSON

toJSON(): string

- Defined in RuntimeFull.ts:489
Returns string

Generated using TypeDoc