phaser/v2/resources/docgen/output/Phaser.Game.json

1 line
15 KiB
JSON
Raw Normal View History

{"class":{"name":"Phaser.Game","extends":"","static":false,"constructor":true,"parameters":[{"name":"width","type":["number","string"],"help":"The width of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage width of the parent container, or the browser window if no parent is given.","optional":true,"default":"800"},{"name":"height","type":["number","string"],"help":"The height of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage height of the parent container, or the browser window if no parent is given.","optional":true,"default":"600"},{"name":"renderer","type":["number"],"help":"Which renderer to use: Phaser.AUTO will auto-detect, Phaser.WEBGL, Phaser.CANVAS or Phaser.HEADLESS (no rendering at all).","optional":true,"default":"Phaser.AUTO"},{"name":"parent","type":["string","HTMLElement"],"help":"The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself.","optional":true,"default":"''"},{"name":"state","type":["object"],"help":"The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null.","optional":true,"default":"null"},{"name":"transparent","type":["boolean"],"help":"Use a transparent canvas background or not.","optional":true,"default":"false"},{"name":"antialias","type":["boolean"],"help":"Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art.","optional":true,"default":"true"},{"name":"physicsConfig","type":["object"],"help":"A physics configuration object to pass to the Physics world on creation.","optional":true,"default":"null"}],"help":"This is where the magic happens. The Game object is the heart of your game,\\nproviding quick access to common functions and handling the boot process.\\n\"Hell, there are no rules here - we're trying to accomplish something.\"\\nThomas A. Edison"},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Nukes the entire game from orbit.","line":752,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"disableStep","static":false,"returns":null,"help":"Disables core game loop stepping.","line":727,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"enableStep","static":false,"returns":null,"help":"Enable core game loop stepping. When enabled you must call game.step() directly (perhaps via a DOM button?)\\nCalling step will advance the game loop by one frame. This is extremely useful for hard to track down errors!","line":714,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"step","static":false,"returns":null,"help":"When stepping is enabled you must call this function directly (perhaps via a DOM button?) to advance the game loop by one frame.\\nThis is extremely useful to hard to track down errors! Use the internal stepCount property to monitor progress.","line":740,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"boot","static":false,"returns":null,"help":"Initialize engine sub modules and start the game.","line":421,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"focusGain","static":false,"returns":null,"help":"Called by the Stage visibility handler.","line":844,"public":false,"protected":true,"private":false,"parameters":[{"name":"event","type":["object"],"help":"The DOM event that caused the game to pause, if any.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"focusLoss","static":false,"returns":null,"help":"Called by the Stage visibility handler.","line":826,"public":false,"protected":true,"private":false,"parameters":[{"name":"event","type":["object"],"help":"The DOM event that caused t