TWorld

Index

Constructors

• constructor

Properties

• actors
• config
• gameState
• physicsDebug

Methods

• addActor
• applyCentralForce
• applyCentralImpulse
• create
• destroy
• getLighting
• getRenderTasks
• onEnterCollisionClass
• pause
• queryArea
• queryLine
• removeActor
• start
• update
• updateBodyOptions
• updateTransform

Constructors

constructor

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

• Parameters

  • engine: default

  • gameState: default

  Returns default

Properties

publicactors

actors: default[] = []

publicconfig

config: TWorldConfig = ...

publicgameState

gameState: default

publicphysicsDebug

physicsDebug: boolean = false

Methods

publicaddActor

• addActor(actor: default): void

• Adds actor to the world

  ---

  Parameters

  • actor: default

  Returns void

publicapplyCentralForce

• applyCentralForce(component: default, force: vec3): void

• Parameters

  • component: default

  • force: vec3

  Returns void

publicapplyCentralImpulse

• applyCentralImpulse(component: default, impulse: vec3): void

• Parameters

  • component: default

  • impulse: vec3

  Returns void

publiccreate

• create(): Promise<void>

• Returns Promise<void>

publicdestroy

• destroy(): void

• Returns void

publicgetLighting

• getLighting(): TSerializedLighting

• Returns TSerializedLighting

publicgetRenderTasks

• getRenderTasks(): TSerializedRenderTask[]

• Returns TSerializedRenderTask[]

publiconEnterCollisionClass

• onEnterCollisionClass(actor: default, collisionClass: string, handler: TCollisionCallback): void

• Adds a listener for when a collision occurs with a specific collision class

  @todo

  add support for removing listeners

  ---

  Parameters

  • actor: default

  • collisionClass: string

  • handler: TCollisionCallback

  Returns void

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[]>

publicqueryLine

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

• Parameters

  • from: vec3

  • to: vec3

  • optionaloptions: TPhysicsQueryOptions

  Returns Promise<TWorldQueryLineResult[]>

publicremoveActor

• removeActor(actor: default): void

• Parameters

  • actor: default

  Returns void

publicstart

• start(): void

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

  ---

  Returns void

publicupdate

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

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

  ---

  Parameters

  • _: default

  • delta: number

  Returns Promise<TWorldUpdateStats>

publicupdateBodyOptions

• updateBodyOptions(component: default, options: TPhysicsBodyOptions): void

• Parameters

  • component: default

  • options: TPhysicsBodyOptions

  Returns void

publicupdateTransform

• updateTransform(component: default): void

• Parameters

  • component: default

  Returns void