Class: Plugin

 | preUpdate*  |             |
 | update*     | render*     |
 | postUpdate* | postRender* |
 |             |             | destroy

Classes

PathManager

Members

active : boolean

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

Type:

• boolean

Source:

src/core/Plugin.js line 45

game : Phaser.Game

A reference to the currently running game.

Type:

• Phaser.Game

Source:

src/core/Plugin.js line 34

hasPostRender : boolean

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

Type:

• boolean

Source:

src/core/Plugin.js line 81

hasPostUpdate : boolean

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

Type:

• boolean

Source:

src/core/Plugin.js line 69

hasPreUpdate : boolean

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

Type:

• boolean

Source:

src/core/Plugin.js line 57

hasRender : boolean

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

Type:

• boolean

Source:

src/core/Plugin.js line 75

hasUpdate : boolean

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

Type:

• boolean

Source:

src/core/Plugin.js line 63

parent : any

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

Type:

• any

Source:

src/core/Plugin.js line 39

visible : boolean

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

Type:

• boolean

Source:

src/core/Plugin.js line 51

Methods

destroy()

Clear down this Plugin and null out references

Source:

src/core/Plugin.js line 122

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:

src/core/Plugin.js line 113

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:

src/core/Plugin.js line 86

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:

src/core/Plugin.js line 104

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:

src/core/Plugin.js line 95