Class: TWorld

Defined in: core/world.ts:77

Constructors

Constructor

new TWorld(engine, gameState): TWorld

Defined in: core/world.ts:112

Parameters

engine

TEngine

gameState

TGameState

Returns

TWorld

Properties

cameraSystem

cameraSystem: TCameraSystem

Defined in: core/world.ts:109

---

config

config: TWorldConfig

Defined in: core/world.ts:83

---

gameState

gameState: TGameState

Defined in: core/world.ts:114

---

physicsDebug

physicsDebug: boolean = false

Defined in: core/world.ts:106

---

systems

systems: TSystem[] = []

Defined in: core/world.ts:79

Methods

addComponent()

addComponent(entity, componentOrBundle): void

Defined in: core/world.ts:158

Parameters

entity

number

componentOrBundle

TComponent | TBundle

Returns

void

---

addComponents()

addComponents(entity, componentsOrBundles): void

Defined in: core/world.ts:165

Parameters

entity

number

componentsOrBundles

(TComponent | TBundle)[]

Returns

void

---

addSystem()

addSystem(system): void

Defined in: core/world.ts:187

Parameters

system

TSystem

Returns

void

---

addSystems()

addSystems(systems): void

Defined in: core/world.ts:182

Parameters

systems

TSystem[]

Returns

void

---

applyCentralForce()

applyCentralForce(entity, force): void

Defined in: core/world.ts:402

Parameters

entity

number

force

vec3

Returns

void

---

applyCentralImpulse()

applyCentralImpulse(entity, impulse): void

Defined in: core/world.ts:411

Parameters

entity

number

impulse

vec3

Returns

void

---

create()

create(): Promise<void>

Defined in: core/world.ts:225

Returns

Promise<void>

---

createEntity()

createEntity(componentsOrBundles?): number

Defined in: core/world.ts:128

Creates an entity with the given components or bundles Order of the components matters, if a component is added to an entity and then a bundle that also contains that component, the component in the bundle will override the component in the entity.

Parameters

componentsOrBundles?

(TComponent | TBundle)[]

The components or bundles to add to the entity

Returns

number

The entity id

---

createQuery()

createQuery(components): TEntityQuery

Defined in: core/world.ts:206

Parameters

components

TComponentConstructor[]

Returns

TEntityQuery

---

destroy()

destroy(): void

Defined in: core/world.ts:398

Returns

void

---

getComponent()

getComponent<T>(entity, componentClass): T | undefined

Defined in: core/world.ts:195

Type Parameters

T

T extends TComponent

Parameters

entity

number

componentClass

TComponentConstructor<T>

Returns

T | undefined

---

getComponents()

getComponents(entity): TComponentContainer | undefined

Defined in: core/world.ts:202

Parameters

entity

number

Returns

TComponentContainer | undefined

---

getLighting()

getLighting(): TSerializedLighting

Defined in: core/world.ts:365

Returns

TSerializedLighting

---

getRenderTasks()

getRenderTasks(): TSerializedRenderTask[]

Defined in: core/world.ts:369

Returns

TSerializedRenderTask[]

---

pause()

pause(): void

Defined in: core/world.ts:394

Called when a state is moved out of the active state so world updates should stop

Returns

void

---

queryArea()

queryArea(from, to, options?): Promise<TWorldQueryAreaResult[]>

Defined in: core/world.ts:476

Parameters

from

vec3

to

vec3

options?

TPhysicsQueryOptions

Returns

Promise<TWorldQueryAreaResult[]>

---

queryEntities()

queryEntities(components, excludedComponents?): number[]

Defined in: core/world.ts:210

Parameters

components

TComponentConstructor[]

excludedComponents?

TComponentConstructor[] = []

Returns

number[]

---

queryLine()

queryLine(from, to, options?): Promise<TWorldQueryLineResult[]>

Defined in: core/world.ts:453

Parameters

from

vec3

to

vec3

options?

TPhysicsQueryOptions

Returns

Promise<TWorldQueryLineResult[]>

---

registerRigidBody()

registerRigidBody(entity, body, transform): void

Defined in: core/world.ts:246

Parameters

entity

number

body

TRigidBodyComponent

transform

TTransform

Returns

void

---

removeComponent()

removeComponent(entity, componentClass): void

Defined in: core/world.ts:175

Parameters

entity

number

componentClass

TComponentConstructor

Returns

void

---

removeEntity()

removeEntity(entity): void

Defined in: core/world.ts:154

Parameters

entity

number

Returns

void

---

removeRigidBody()

removeRigidBody(entity): void

Defined in: core/world.ts:276

Parameters

entity

number

Returns

void

---

removeSystem()

removeSystem(system): void

Defined in: core/world.ts:191

Parameters

system

TSystem

Returns

void

---

simulateStep()

simulateStep(delta): Promise<TPhysicsSimulateStepResult>

Defined in: core/world.ts:316

Parameters

delta

number

Returns

Promise<TPhysicsSimulateStepResult>

---

start()

start(): void

Defined in: core/world.ts:387

Called when a state is entered so the world updates should continue

Returns

void

---

update()

update(_, delta, timingSegment?): Promise<void>

Defined in: core/world.ts:344

Called every frame with delta and triggers update on all actors

Parameters

_

TEngine

delta

number

timingSegment?

TSegmentTimingContext

Returns

Promise<void>

---

updateBodyOptions()

updateBodyOptions(entity, options): void

Defined in: core/world.ts:424

Parameters

entity

number

options

TPhysicsBodyOptions

Returns

void

---

updateTransform()

updateTransform(entity, transform): void

Defined in: core/world.ts:434

Parameters

entity

number

transform

TTransform

Returns

void