phaser/resources/docgen/output/Phaser.Plugin.json

{"class":{"name":"Phaser.Plugin","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"parent","type":["any"],"help":"The object that owns this plugin, usually Phaser.PluginManager.","optional":false,"default":null}],"help":"This is a base Plugin template to use for any Phaser plugin development."},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Clear down this Plugin and null out references","line":111,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"postRender","static":false,"returns":null,"help":"Post-render is called after the Game Renderer and State.render have run.\\nIt is only called if visible is set to true.","line":104,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Pre-update is called at the very start of the update cycle, before any other subsystems have been updated (including Physics).\\nIt is only called if active is set to true.","line":80,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Render is called right after the Game Renderer completes, but before the State.render.\\nIt is only called if visible is set to true.","line":96,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Update is called after all the core subsystems (Input, Tweens, Sound, etc) and the State have updated, but before the render.\\nIt is only called if active is set to true.","line":88,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"active","type":["boolean"],"help":"","inlineHelp":"A Plugin with active=true has its preUpdate and update methods called by the parent, otherwise they are skipped.","line":33,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":22,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hasPostRender","type":["boolean"],"help":"","inlineHelp":"A flag to indicate if this plugin has a postRender method.","line":69,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"hasPostUpdate","type":["boolean"],"help":"","inlineHelp":"A flag to indicate if this plugin has a postUpdate method.","line":57,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"hasPreUpdate","type":["boolean"],"help":"","inlineHelp":"A flag to indicate if this plugin has a preUpdate method.","line":45,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"hasRender","type":["boolean"],"help":"","inlineHelp":"A flag to indicate if this plugin has a render method.","line":63,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"hasUpdate","type":["boolean"],"help":"","inlineHelp":"A flag to indicate if this plugin has an update method.","line":51,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["any"],"help":"","inlineHelp":"The parent of this plugin. If added to the PluginManager the parent will be set to that, otherwise it will be null.","line":27,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"","inlineHelp":"A Plugin with visible=true has its render and postRender methods called by the parent, otherwise they are skipped.","line":39,"default":"false","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}