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

{"class":{"name":"Phaser.State","extends":"","static":false,"constructor":true,"parameters":[],"help":"This is a base State class which can be extended if you are creating your own game.\\nIt provides quick access to common functions such as the camera, cache, input, match, sound and more."},"consts":[],"methods":{"public":[{"name":"create","static":false,"returns":null,"help":"create is called once preload has completed, this includes the loading of any assets from the Loader.\\nIf you don't have a preload method then create is the first method called in your State.","line":138,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"loadRender","static":false,"returns":null,"help":"loadRender is called during the Loader process. This only happens if you've set one or more assets to load in the preload method.\\nThe difference between loadRender and render is that any objects you render in this method you must be sure their assets exist.","line":129,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"loadUpdate","static":false,"returns":null,"help":"loadUpdate is called during the Loader process. This only happens if you've set one or more assets to load in the preload method.","line":120,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"pauseUpdate","static":false,"returns":null,"help":"pauseUpdate is called while the game is paused instead of preUpdate, update and postUpdate.","line":182,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"paused","static":false,"returns":null,"help":"This method will be called if the core game loop is paused.","line":174,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preload","static":false,"returns":null,"help":"preload is called first. Normally you'd use this to load your game assets (or those needed for the current State)\\nYou shouldn't create any objects in this method that require assets that you're also loading in this method, as\\nthey won't yet be available.","line":112,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Nearly all display objects in Phaser render automatically, you don't need to tell them to render.\\nHowever the render method is called AFTER the game renderer and plugins have rendered, so you're able to do any\\nfinal post-processing style effects here. Note that this happens before plugins postRender takes place.","line":158,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"resize","static":false,"returns":null,"help":"If your game is set to Scalemode RESIZE then each time the browser resizes it will call this function, passing in the new width and height.","line":166,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"shutdown","static":false,"returns":null,"help":"This method will be called when the State is shutdown (i.e. you switch to another state from this one).","line":190,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"The update method is left empty for your own use.\\nIt is called during the core game loop AFTER debug, physics, plugins and the Stage have had their preUpdate methods called.\\nIf is called BEFORE Stage, Tweens, Sounds, Input, Physics, Particles and Plugins have had their postUpdate methods called.","line":148,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"add","type":["Phaser.GameObjectFactory"],"help":"","inlineHelp":"A reference to the GameObjectFactory which can be used to add new objects to the World.","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cache","type":["Phaser.Cache"],"help":"","inlineHelp":"A reference to the game cache which contains any loaded or generated assets, such as images, sound and more.","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"camera","type":["Phaser.Camera"],"help":"","inlineHelp":"A handy reference to World.camera.","line":34,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"This is a reference to the currently running Game.","line":19,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"input","type":["Phaser.Input"],"help":"","inlineHelp":"A reference to the Input Manager.","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"load","type":["Phaser.Loader"],"help":"","inlineHelp":"A reference to the Loader, which you mostly use in the preload method of your state to load external assets.","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"make","type":["Phaser.GameObjectCreator"],"help":"","inlineHelp":"A reference to the GameObjectCreator which can be used to make new objects.","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"math","type":["Phaser.Math"],"help":"","inlineHelp":"A reference to Math class with lots of helpful functions.","line":54,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"particles","type":["Phaser.Particles"],"help":"","inlineHelp":"The Particle Manager. It is called during the core gameloop and updates any Particle Emitters it has created.","line":89,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"physics","type":["Phaser.Physics"],"help":"","inlineHelp":"A reference to the physics manager which looks after the different physics systems available within Phaser.","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rnd","type":["Phaser.RandomDataGenerator"],"help":"","inlineHelp":"A reference to the seeded and repeatable random data generator.","line":99,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.ScaleManager"],"help":"","inlineHelp":"A reference to the Scale Manager which controls the way the game scales on different displays.","line":64,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sound","type":["Phaser.SoundManager"],"help":"","inlineHelp":"A reference to the Sound Manager which can create, play and stop sounds, as well as adjust global volume.","line":59,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["Phaser.Stage"],"help":"","inlineHelp":"A reference to the Stage.","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"time","type":["Phaser.Time"],"help":"","inlineHelp":"A reference to the game clock and timed events system.","line":74,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tweens","type":["Phaser.TweenManager"],"help":"","inlineHelp":"A reference to the tween manager.","line":79,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.World"],"help":"","inlineHelp":"A reference to the game world. All objects live in the Game World and its size is not bound by the display resolution.","line":84,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}