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

{"class":{"name":"Phaser.RequestAnimationFrame","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"forceSetTimeOut","type":["boolean"],"help":"Tell Phaser to use setTimeOut even if raf is available.","optional":true,"default":"false"}],"help":"Abstracts away the use of RAF or setTimeOut for the core game update loop."},"consts":[],"methods":{"public":[{"name":"isRAF","static":false,"returns":{"types":["boolean"],"help":""},"help":"Is the browser using requestAnimationFrame?","line":160,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"isSetTimeOut","static":false,"returns":{"types":["boolean"],"help":""},"help":"Is the browser using setTimeout?","line":151,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Starts the requestAnimationFrame running or setTimeout if unavailable in browser","line":74,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stops the requestAnimationFrame from running.","line":131,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateRAF","static":false,"returns":null,"help":"The update method for the requestAnimationFrame","line":107,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateSetTimeout","static":false,"returns":null,"help":"The update method for the setTimeout.","line":119,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"forceSetTimeOut","type":["boolean"],"help":"","inlineHelp":"Tell Phaser to use setTimeOut even if raf is available.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"The currently running game.","line":22,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"isRunning","type":["boolean"],"help":"","inlineHelp":"true if RequestAnimationFrame is running, otherwise false.","line":28,"default":"false","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_isSetTimeOut","type":["boolean"],"help":"","inlineHelp":"  - true if the browser is using setTimeout instead of raf.","line":52,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onLoop","type":["function"],"help":"","inlineHelp":"The function called by the update.","line":58,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_timeOutID","type":["number"],"help":"","inlineHelp":"The callback ID used when calling cancel.","line":64,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}