PixiJS

Class: SystemManager

PIXI.SystemManager

The SystemManager is a class that provides functions for managing a set of systems This is a base class, that is generic (no render code or knowledge at all)

new PIXI.SystemManager ()

Extends

  • EventEmitter

Members

runners { [key: string]: PIXI.Runner } readonly

a collection of runners defined by the user

Methods

addRunners (…runnerIds) void

SystemManager.ts:51

Create a bunch of runners based of a collection of ids

Name Type Description
runnerIds string[]

the runner ids to add

addSystem (ClassRef, name) this

SystemManager.ts:63

Add a new system to the renderer.

Name Type Description
ClassRef ISystemConstructor<R>

Class reference
name string

Property name for system, if not specified will use a static name property on the class itself. This name will be assigned as s property on the Renderer so make sure it doesn't collide with properties on Renderer.
Returns:
Type Description
this Return instance of renderer

destroy () void

SystemManager.ts:140

destroy the all runners and systems. Its apps job to

emitWithCustomOptions (runner, options) void

SystemManager.ts:109

A function that will run a runner and call the runners function but pass in different options to each system based on there name.

E.g. If you have two systems added called systemA and systemB you could call do the following:

system.emitWithCustomOptions(init, {
    systemA: {...optionsForA},
    systemB: {...optionsForB},
});

init would be called on system A passing optionsForA and on system B passing optionsForB.

Name Type Description
runner PIXI.Runner

the runner to target
options Record<string, unknown>

key value options for each system

setup (config) void

SystemManager.ts:26

Set up a system with a collection of SystemClasses and runners. Systems are attached dynamically to this class when added.

Name Type Description
config ISystemConfig<R>

the config for the system manager