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:
Members
-
active
-
- Default Value:
- false
- Source:
Properties:
Name Type Description active
boolean A Plugin with active=true has its preUpdate and update methods called by the parent, otherwise they are skipped.
-
game
-
- Source:
Properties:
Name Type Description game
Phaser.Game A reference to the currently running game.
-
hasPostRender
-
- Default Value:
- false
- Source:
Properties:
Name Type Description hasPostRender
boolean A flag to indicate if this plugin has a postRender method.
-
hasPostUpdate
-
- Default Value:
- false
- Source:
Properties:
Name Type Description hasPostUpdate
boolean A flag to indicate if this plugin has a postUpdate method.
-
hasPreUpdate
-
- Default Value:
- false
- Source:
Properties:
Name Type Description hasPreUpdate
boolean A flag to indicate if this plugin has a preUpdate method.
-
hasRender
-
- Default Value:
- false
- Source:
Properties:
Name Type Description hasRender
boolean A flag to indicate if this plugin has a render method.
-
hasUpdate
-
- Default Value:
- false
- Source:
Properties:
Name Type Description hasUpdate
boolean A flag to indicate if this plugin has an update method.
-
parent
-
- Source:
Properties:
Name Type Description parent
Any The parent of this plugin. If added to the PluginManager the parent will be set to that, otherwise it will be null.
-
visible
-
- Default Value:
- false
- Source:
Properties:
Name Type Description visible
boolean A Plugin with visible=true has its render and postRender methods called by the parent, otherwise they are skipped.
Methods
-
destroy()
-
Clear down this Plugin and null out references
- Source:
-
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:
-
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:
-
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:
-
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: