Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Runner

The 'Runner' is a class that provides a loop.

Events:

  • before-update
  • update
  • after-update
  • before-render
  • render
  • after-render

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

delta

delta: number = 0

deltaAccumulator

deltaAccumulator: number = 0

deltas

deltas: number[] = []

deltasSize

deltasSize: number = 40

enabled

enabled: boolean = false

enabledRender

enabledRender: boolean = false

Private event

event: { delta: number; time: number; tps: number } = ...

Type declaration

  • delta: number
  • time: number
  • tps: number

fps

fps: number = 0

lag

lag: number = 0

options

options: { correction: boolean; fixedDelta: number; fixedTps: number; timescale: number; type: RunnerType }

Type declaration

  • correction: boolean
  • fixedDelta: number
  • fixedTps: number
  • timescale: number
  • type: RunnerType

renderDelta

renderDelta: number = 0.01

Private renderEvent

renderEvent: { delta: number; time: number } = ...

Type declaration

  • delta: number
  • time: number

Private renderRequestId

renderRequestId: number = 0

renderTime

renderTime: number = ...

Private tickRequestId

tickRequestId: number = 0

time

time: number = ...

tps

tps: number = 0

worldTime

worldTime: number = 0

Static AVERAGE_C

AVERAGE_C: number = 0.3

Static DELTA_C

DELTA_C: number = 0.4

Static LAG_C

LAG_C: number = 0.1

Static MIN_C

MIN_C: number = ...

Methods

clear

  • clear(): void

off

  • off(id: number): boolean

  • Unsubscribes the callback function from the given event name.

    Parameters

    • id: number

    Returns boolean

    True if the event was successfully unsubscribed, otherwise false

on

  • on(name: string, callback: (...args: any[]) => void): number

  • Subscribes the callback function to the given event name.

    Parameters

    • name: string
    • callback: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

    The id of the event

once

  • once(name: string, callback: (...args: any[]) => void): void

  • Subscribes the callback function to the given event name for one time.

    Parameters

    • name: string
    • callback: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

render

  • render(): void

run

  • run(): void

runRender

  • runRender(): void

setTps

  • setTps(tps: number): void

singleStep

  • singleStep(delta?: number): void

stop

  • stop(): void

stopRender

  • stopRender(): void

tick

  • tick(): void

trigger

  • trigger(name: string, args?: any[]): void

  • Triggers all the callbacks subscribed to the given name.

    Parameters

    • name: string
    • args: any[] = []

    Returns void

Generated using TypeDoc