TWorld

Index

Constructors

• constructor

Properties

• cameraSystem
• config
• gameState
• physicsDebug
• systems

Methods

• addComponent
• addComponents
• addSystem
• applyCentralForce
• applyCentralImpulse
• create
• createEntity
• createQuery
• destroy
• getComponent
• getComponents
• getLighting
• getRenderTasks
• pause
• queryArea
• queryEntities
• queryLine
• registerRigidBody
• removeComponent
• removeEntity
• removeRigidBody
• removeSystem
• simulateStep
• start
• update
• updateBodyOptions
• updateTransform

Constructors

constructor

• new TWorld(engine: default, gameState: default): default

• Parameters

  • engine: default

  • gameState: default

  Returns default

Properties

publiccameraSystem

cameraSystem: default

publicconfig

config: TWorldConfig = ...

publicgameState

gameState: default

publicphysicsDebug

physicsDebug: boolean = false

publicsystems

systems: TSystem[] = []

Methods

publicaddComponent

• addComponent(entity: number, component: TComponent): void

• Parameters

  • entity: number

  • component: TComponent

  Returns void

publicaddComponents

• addComponents(entity: number, components: TComponent[]): void

• Parameters

  • entity: number

  • components: TComponent[]

  Returns void

publicaddSystem

• addSystem(system: TSystem): void

• Parameters

  • system: TSystem

  Returns void

publicapplyCentralForce

• applyCentralForce(entity: number, force: vec3): void

• Parameters

  • entity: number

  • force: vec3

  Returns void

publicapplyCentralImpulse

• applyCentralImpulse(entity: number, impulse: vec3): void

• Parameters

  • entity: number

  • impulse: vec3

  Returns void

publiccreate

• create(): Promise<void>

• Returns Promise<void>

publiccreateEntity

• createEntity(components?: TComponent[]): number

• Parameters

  • optionalcomponents: TComponent[]

  Returns number

publiccreateQuery

• createQuery(components: TComponentConstructor[]): TEntityQuery

• Parameters

  • components: TComponentConstructor[]

  Returns TEntityQuery

publicdestroy

• destroy(): void

• Returns void

publicgetComponent

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

• Type parameters

  • T: TComponent

  Parameters

  • entity: number

  • componentClass: TComponentConstructor<T>

  Returns undefined | T

publicgetComponents

• getComponents(entity: number): undefined | TComponentContainer

• Parameters

  • entity: number

  Returns undefined | TComponentContainer

publicgetLighting

• getLighting(): TSerializedLighting

• Returns TSerializedLighting

publicgetRenderTasks

• getRenderTasks(): TSerializedRenderTask[]

• Returns TSerializedRenderTask[]

publicpause

• pause(): void

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

  ---

  Returns void

publicqueryArea

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

• Parameters

  • from: vec3

  • to: vec3

  • optionaloptions: TPhysicsQueryOptions

  Returns Promise<TWorldQueryAreaResult[]>

publicqueryEntities

• queryEntities(components: TComponentConstructor[], excludedComponents?: TComponentConstructor[]): number[]

• Parameters

  • components: TComponentConstructor[]

  • excludedComponents: TComponentConstructor[] = []

  Returns number[]

publicqueryLine

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

• Parameters

  • from: vec3

  • to: vec3

  • optionaloptions: TPhysicsQueryOptions

  Returns Promise<TWorldQueryLineResult[]>

publicregisterRigidBody

• registerRigidBody(entity: number, body: TRigidBodyComponent, transform: default): void

• Parameters

  • entity: number

  • body: TRigidBodyComponent

  • transform: default

  Returns void

publicremoveComponent

• removeComponent(entity: number, componentClass: TComponentConstructor): void

• Parameters

  • entity: number

  • componentClass: TComponentConstructor

  Returns void

publicremoveEntity

• removeEntity(entity: number): void

• Parameters

  • entity: number

  Returns void

publicremoveRigidBody

• removeRigidBody(entity: number): void

• Parameters

  • entity: number

  Returns void

publicremoveSystem

• removeSystem(system: TSystem): void

• Parameters

  • system: TSystem

  Returns void

publicsimulateStep

• simulateStep(delta: number): Promise<TPhysicsSimulateStepResult>

• Parameters

  • delta: number

  Returns Promise<TPhysicsSimulateStepResult>

publicstart

• start(): void

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

  ---

  Returns void

publicupdate

• update(_: default, delta: number): Promise<void>

• Called every frame with delta and triggers update on all actors

  ---

  Parameters

  • _: default

  • delta: number

  Returns Promise<void>

publicupdateBodyOptions

• updateBodyOptions(entity: number, options: TPhysicsBodyOptions): void

• Parameters

  • entity: number

  • options: TPhysicsBodyOptions

  Returns void

publicupdateTransform

• updateTransform(entity: number, transform: default): void

• Parameters

  • entity: number

  • transform: default

  Returns void