Phaser API Documentation



By default this is an empty method hook that you can override and use in your own custom pipelines.

This method is called every time a Game Object asks the Pipeline Manager to use this pipeline, even if the pipeline is already active.

Unlike the onActive method, which is only called when the Pipeline Manager makes this pipeline active, this hook is called for every Game Object that requests use of this pipeline, allowing you to perform per-object set-up, such as loading shader uniform data.


name type arguments description
gameObject Phaser.GameObjects.GameObject <optional>

The Game Object that invoked this pipeline, if any.

Since: 3.50.0