Class default

The Matter.Runner module is an optional utility which provides a game loop, that handles continuously updating a Matter.Engine for you within a browser. It is intended for development and debugging purposes, but may also be suitable for simple games. If you are using your own game loop instead, then you do not need the Matter.Runner module. Instead just call Engine.update(engine, delta) in your own loop.

See the included usage examples.

Hierarchy

  • default

Constructors

constructor

Properties

_cancelAnimationFrame _frameTimeout _requestAnimationFrame

Methods

create run start stop tick

Constructors

constructor

Properties

Static Protected _cancelAnimationFrame

_cancelAnimationFrame: ((handle) => void) & ((handle) => void) = ...

Type declaration

    • (handle): void

    • Parameters

      • handle: number

      Returns void

Type declaration

    • (handle): void

    • Parameters

      • handle: number

      Returns void

Static Protected _frameTimeout

_frameTimeout: Timeout

Static Protected _requestAnimationFrame

_requestAnimationFrame: ((callback) => number) & ((callback) => number) = ...

Type declaration

    • (callback): number

    • Parameters

      • callback: FrameRequestCallback

      Returns number

Type declaration

    • (callback): number

    • Parameters

      • callback: FrameRequestCallback

      Returns number

Methods

Static create

  • Creates a new Runner. The options parameter is an object that specifies any properties you wish to override the defaults.

    Parameters

    Returns IRunner

    Method

    create

Static run

Static start

Static stop

  • Ends execution of Runner.run on the given runner, by canceling the animation frame request event loop. If you wish to only temporarily pause the runner, see runner.enabled instead.

    Parameters

    Returns void

    Method

    stop

Static tick

  • A game loop utility that updates the engine and renderer by one step (a 'tick'). Features delta smoothing, time correction and fixed or dynamic timing. Consider just Engine.update(engine, delta) if you're using your own loop.

    Parameters

    Returns void

    Method

    tick

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc