PixiJS

Class: Runner

PIXI.Runner

A Runner is a highly performant and simple alternative to signals. Best used in situations where events are dispatched to many objects at high frequency (say every frame!)

Like a signal:

import { Runner } from '@pixi/runner';

const myObject = {
    loaded: new Runner('loaded'),
};

const listener = {
    loaded: function() {
        // Do something when loaded
    }
};

myObject.loaded.add(listener);

myObject.loaded.emit();

Or for handling calling the same function on many items:

import { Runner } from '@pixi/runner';

const myGame = {
    update: new Runner('update'),
};

const gameObject = {
    update: function(time) {
        // Update my gamey state
    },
};

myGame.update.add(gameObject);

myGame.update.emit(time);

Type safety:


import { Runner } from '@pixi/runner';

let runner: Runner<'update', [number]>;

// This won't work because the function name 'update' is expected
runner = new Runner('destroy');

// This is fine
runner = new Runner('update');

// This won't work because the number is expected
runner.emit("10");

// This is fine
runner.emit(10);

// This won't work because provided object does not contain 'update' key
runner.add({
    destroy: function() {
        // Destroy the game
    },
});

// This is fine
runner.add({
    update: function(time) {
        // Update my gamey state
    },
    destroy: function() {
        // Destroy the game
    },
});

new PIXI.Runner (name)

Runner.ts:107
Name Type Description
name string

The function name that will be executed on the listeners added to this Runner.

Members

empty boolean readonly

true if there are no this Runner contains no listeners

name string

The name of the runner.

Methods

add (item) this

Runner.ts:157

Add a listener to the Runner

Runners do not need to have scope or functions passed to them. All that is required is to pass the listening object and ensure that it has contains a function that has the same name as the name provided to the Runner when it was created.

E.g. A listener passed to this Runner will require a 'complete' function.

import { Runner } from '@pixi/runner';

const complete = new Runner('complete');

The scope used will be the object itself.

Name Type Description
item any

The object that will be listening.
Returns:
Type Description
this

contains (item) boolean

Runner.ts:204

Check to see if the listener is already in the Runner

Name Type Description
item any

The listener that you would like to check.
Returns:
Type Description
boolean

destroy () void

Runner.ts:222

Remove all references, don't use after this.

dispatch ()

Runner.ts:250

Alias for emit

See:

emit (params) this

Runner.ts:118

Dispatch/Broadcast Runner to all listeners added to the queue.

Name Type Attributes Description
params any <optional>

(optional) parameters to pass to each listener
Returns:
Type Description
this

remove (item) this

Runner.ts:187

Remove a single listener from the dispatch queue.

Name Type Description
item any

The listener that you would like to remove.
Returns:
Type Description
this

removeAll () this

Runner.ts:213

Remove all listeners from the Runner

Returns:
Type Description
this

run ()

Runner.ts:257

Alias for emit

See: