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

{"class":{"name":"Phaser.PluginManager","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"The Plugin Manager is responsible for the loading, running and unloading of Phaser Plugins."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["Phaser.Plugin"],"help":"The Plugin that was added to the manager."},"help":"Add a new Plugin into the PluginManager.\\nThe Plugin must have 2 properties: game and parent. Plugin.game is set to the game reference the PluginManager uses, and parent is set to the PluginManager.","line":53,"public":true,"protected":false,"private":false,"parameters":[{"name":"plugin","type":["object","Phaser.Plugin"],"help":"The Plugin to add into the PluginManager. This can be a function or an existing object.","optional":false,"default":null},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the Plugin.init method.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Clear down this PluginManager, calls destroy on every plugin and nulls out references.","line":277,"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 only calls plugins who have visible=true.","line":258,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"postUpdate","static":false,"returns":null,"help":"PostUpdate is the last thing to be called before the world render.\\nIn particular, it is called after the world postUpdate, which means the camera has been adjusted.\\nIt only calls plugins who have active=true.","line":218,"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 only calls plugins who have active=true.","line":177,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":null,"help":"Remove a Plugin from the PluginManager. It calls Plugin.destroy on the plugin before removing it from the manager.","line":135,"public":true,"protected":false,"private":false,"parameters":[{"name":"plugin","type":["Phaser.Plugin"],"help":"The plugin to be removed.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeAll","static":false,"returns":null,"help":"Remove all Plugins from the PluginManager. It calls Plugin.destroy on every plugin before removing it from the manager.","line":157,"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 only calls plugins who have visible=true.","line":238,"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 only calls plugins who have active=true.","line":197,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"plugins","type":["array"],"help":"","inlineHelp":"An array of all the plugins being managed by this PluginManager.","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_i","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":38,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_len","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":32,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}