These archived docs are for Phaser 2.2.2 Phaser 3 docs can be found on newdocs.phaser.io.
Phaser CE docs can be found on the Phaser CE Documentation site.

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

Public Properties

active : boolean

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

Default Value
  • false
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.

Default Value
  • false
Source code: core/Plugin.js, line 69

hasPostUpdate : boolean

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

Default Value
  • false
Source code: core/Plugin.js, line 57

hasPreUpdate : boolean

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

Default Value
  • false
Source code: core/Plugin.js, line 45

hasRender : boolean

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

Default Value
  • false
Source code: core/Plugin.js, line 63

hasUpdate : boolean

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

Default Value
  • false
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.

Default Value
  • false
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