Class SimulationEngine

Provides simulation management that is shared by both client and server

Hierarchy

SimulationEngine

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SimulationEngine(classRegistry: ClassRegistry<Serializable>): SimulationEngine

- Defined in base-engine/dist/simulation-engine.d.ts:18
Parameters
- classRegistry: ClassRegistry<Serializable>
  
  A ClassRegistrythat will be used for serialization and typeIds, should be synced between server and client for state to be networked correctly.
Returns SimulationEngine

Properties

Private classRegistry

classRegistry: any

Private componentTypes

componentTypes: any

Private continuousInputTypes

continuousInputTypes: any

Private systems

systems: any

Methods

addSystem

addSystem(system: System): void

- Defined in base-engine/dist/simulation-engine.d.ts:41
Parameters
- system: System
Returns void

cloneSimulationFrame

cloneSimulationFrame(src: SimulationFrameData): SimulationFrameData

- Defined in base-engine/dist/simulation-engine.d.ts:26
Parameters
- src: SimulationFrameData
Returns SimulationFrameData

constructComponentData

constructComponentData(componentTypeId: ShortTypeId): Serializable

- Defined in base-engine/dist/simulation-engine.d.ts:39
Parameters
- componentTypeId: ShortTypeId
Returns Serializable

copyInputFrame

copyInputFrame(src: InputFrame, dst: InputFrame): void

- Defined in base-engine/dist/simulation-engine.d.ts:37
Parameters
- src: InputFrame
- dst: InputFrame
Returns void

copySimulationState

copySimulationState(src: EntityComponentState, dst: EntityComponentState): void

- Defined in base-engine/dist/simulation-engine.d.ts:40
Parameters
- src: EntityComponentState
- dst: EntityComponentState
Returns void

createInputFrame

createInputFrame(): InputFrame

- Defined in base-engine/dist/simulation-engine.d.ts:36
TODO Implement evented input Evented input has reliable and ordered delivery, and does not persist beyond the frame it is processed in. Good for things like shooting a single projectile in a target direction, putting points in a stat.

Returns InputFrame

createSimulationFrame

createSimulationFrame(): SimulationFrameData

- Defined in base-engine/dist/simulation-engine.d.ts:25
Returns SimulationFrameData

registerComponentType

registerComponentType<T>(componentType: new () => T, componentTypeName: string): void

- Defined in base-engine/dist/simulation-engine.d.ts:38
Type parameters
- T: Serializable
Parameters
- componentType: new () => T
  - - new (): T
    - Returns T
- componentTypeName: string
Returns void

registerContinuousInputType

registerContinuousInputType<T>(inputType: new () => T, inputTypeName: string): void

- Defined in base-engine/dist/simulation-engine.d.ts:30
See Engine.registerContinuousInputType

Type parameters
- T: Serializable
Parameters
- inputType: new () => T
  - - new (): T
    - Returns T
- inputTypeName: string
Returns void

removeSystem

removeSystem(system: System): void

- Defined in base-engine/dist/simulation-engine.d.ts:42
Parameters
- system: System
Returns void

stepSimulation

stepSimulation(timeDeltaS: number, previousFrame: SimulationFrameData, nextFrame: SimulationFrameData): void

- Defined in base-engine/dist/simulation-engine.d.ts:47
Runs 1 simulation step with duration of timeDeltaS to produce nextFrame from previousFrame using the simulation provided by the registered systems.

Parameters
- timeDeltaS: number
- previousFrame: SimulationFrameData
- nextFrame: SimulationFrameData
Returns void

Generated using TypeDoc