These docs are for an outdated version of Phaser The documentation on this page is for Phaser 2.6.2. The latest release is 2.9.3.

Constructor

Phaser. Plugin

new Plugin(game, parent)

This is a base Plugin template to use for any Phaser plugin development.

Parameters
Name Type Description
game Phaser.Game

A reference to the currently running game.

parent any

The object that owns this plugin, usually Phaser.PluginManager.

Source code: core/Plugin.js (Line 15)

Classes

PathManager

Public Properties

active : boolean

A Plugin with active=true has its preUpdate and update methods called by the parent, otherwise they are skipped.

Source code: core/Plugin.js (Line 33)

game : Phaser.Game

A reference to the currently running game.

Source code: core/Plugin.js (Line 22)

hasPostRender : boolean

A flag to indicate if this plugin has a postRender method.

Source code: core/Plugin.js (Line 69)

hasPostUpdate : boolean

A flag to indicate if this plugin has a postUpdate method.

Source code: core/Plugin.js (Line 57)

hasPreUpdate : boolean

A flag to indicate if this plugin has a preUpdate method.

Source code: core/Plugin.js (Line 45)

hasRender : boolean

A flag to indicate if this plugin has a render method.

Source code: core/Plugin.js (Line 63)

hasUpdate : boolean

A flag to indicate if this plugin has an update method.

Source code: core/Plugin.js (Line 51)

parent :any

The parent of this plugin. If added to the PluginManager the parent will be set to that, otherwise it will be null.

Source code: core/Plugin.js (Line 27)

visible : boolean

A Plugin with visible=true has its render and postRender methods called by the parent, otherwise they are skipped.

Source code: core/Plugin.js (Line 39)

Public Methods

destroy()

Clear down this Plugin and null out references

Source code: core/Plugin.js (Line 107)

postRender()

Post-render is called after the Game Renderer and State.render have run.
It is only called if visible is set to true.

Source code: core/Plugin.js (Line 99)

preUpdate()

Pre-update is called at the very start of the update cycle, before any other subsystems have been updated (including Physics).
It is only called if active is set to true.

Source code: core/Plugin.js (Line 75)

render()

Render is called right after the Game Renderer completes, but before the State.render.
It is only called if visible is set to true.

Source code: core/Plugin.js (Line 91)

update()

Update is called after all the core subsystems (Input, Tweens, Sound, etc) and the State have updated, but before the render.
It is only called if active is set to true.

Source code: core/Plugin.js (Line 83)