Class ServerEngine

The main class for game servers. Binds together all the server-side parts of the engine.

Hierarchy

ServerEngine

Implements

Engine

Index

Constructors

constructor

new ServerEngine(authenticatePlayer: AuthCallback, options: Partial<ServerEngineOptions>): ServerEngine

- Defined in server-engine/src/server-engine.ts:51
Parameters
- authenticatePlayer: AuthCallback
- options: Partial<ServerEngineOptions>
Returns ServerEngine

Properties

Private classRegistry

classRegistry: ClassRegistry<Serializable> = ...

currentFrame

currentFrame: SimulationFrameData = ...

Private frameUpdateSenders

frameUpdateSenders: Map<PlayerId, FrameUpdateSender> = ...

Private inputHandler

inputHandler: ServerInputHandler = ...

Private networkServer

networkServer: NetworkServer = ...

onPlayerConnected

onPlayerConnected: BaseEvent<PlayerId> = ...

options

options: ServerEngineOptions

Private playerInfos

playerInfos: Map<PlayerId, PlayerInfo> = ...

Private presentTimeToSimulationTimeDeltaS

presentTimeToSimulationTimeDeltaS: number = 0

Private simulationEngine

simulationEngine: SimulationEngine = ...

Static defaultOptions

defaultOptions: ServerEngineOptions = ...

Methods

addSystem

addSystem(system: System): void

Implementation of Engine.addSystem
- Defined in server-engine/src/server-engine.ts:133
Parameters
- system: System
Returns void

getGameSimPeriodS

getGameSimPeriodS(): number

- Defined in server-engine/src/server-engine.ts:141
Returns number

getSimulationTimeS

getSimulationTimeS(): number

- Defined in server-engine/src/server-engine.ts:149
A continuous time that represents how far along the simulation should be. Not quantised to the frame timestamps, see frame time for that value.

Returns number

listen

listen(options: ListenOptions): Promise<AddressInfo>

- Defined in server-engine/src/server-engine.ts:162
Parameters
- options: ListenOptions
Returns Promise<AddressInfo>

registerComponentType

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

Implementation of Engine.registerComponentType
- Defined in server-engine/src/server-engine.ts:119
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

Implementation of Engine.registerContinuousInputType
- Defined in server-engine/src/server-engine.ts:112
Continuous input remains the same on the server if it doesnt get an update from client. Good for things like player movement instructions from inputs that are held down by the player.

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

removeSystem

removeSystem(system: System): void

Implementation of Engine.removeSystem
- Defined in server-engine/src/server-engine.ts:137
Parameters
- system: System
Returns void

start

start(): void

- Defined in server-engine/src/server-engine.ts:156
Returns void

Private updateLoop

updateLoop(): void

- Defined in server-engine/src/server-engine.ts:181
Returns void

Generated using TypeDoc