Skip to content

1681-engine / index / FixedLoop

Class: FixedLoop ​

Defined in: src/engine/FixedLoop.ts:17

Constructors ​

Constructor ​

ts
new FixedLoop(options?): FixedLoop;

Defined in: src/engine/FixedLoop.ts:25

Parameters ​

ParameterType
optionsFixedLoopOptions

Returns ​

FixedLoop

Properties ​

stepMs ​

ts
readonly stepMs: number;

Defined in: src/engine/FixedLoop.ts:18


stepSeconds ​

ts
readonly stepSeconds: number;

Defined in: src/engine/FixedLoop.ts:19


tick ​

ts
tick: number = 0;

Defined in: src/engine/FixedLoop.ts:23

Steps taken since the loop started.

Methods ​

advance() ​

ts
advance(deltaMs, step): number;

Defined in: src/engine/FixedLoop.ts:37

Feeds one frame of deltaMs and runs step as many times as it owes. Returns the share of a step left over (0–1), for interpolating what is drawn between the last two steps.

Parameters ​

ParameterType
deltaMsnumber
step(tick) => void

Returns ​

number


reset() ​

ts
reset(): void;

Defined in: src/engine/FixedLoop.ts:53

Forgets any debt, e.g. after a scene change or a long load.

Returns ​

void

Released under the MIT License.