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

1 line
10 KiB
JSON
Raw Normal View History

{"class":{"name":"Phaser.Time","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":" A reference to the currently running game.","optional":false,"default":null}],"help":"This is the core internal game clock.\\nIt manages the elapsed time and calculation of elapsed values, used for game object motion and tweens."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["Phaser.Timer"],"help":"The given Phaser.Timer object."},"help":"Adds an existing Phaser.Timer object to the Timer pool.","line":191,"public":true,"protected":false,"private":false,"parameters":[{"name":"timer","type":["Phaser.Timer"],"help":"An existing Phaser.Timer object.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"create","static":false,"returns":{"types":["Phaser.Timer"],"help":"The Timer object that was created."},"help":"Creates a new stand-alone Phaser.Timer object.","line":206,"public":true,"protected":false,"private":false,"parameters":[{"name":"autoDestroy","type":["boolean"],"help":"A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events).","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"elapsedSecondsSince","static":false,"returns":{"types":["number"],"help":"Duration between given time and now (in seconds)."},"help":"How long has passed since the given time (in seconds).","line":390,"public":true,"protected":false,"private":false,"parameters":[{"name":"since","type":["number"],"help":"The time you want to measure (in seconds).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"elapsedSince","static":false,"returns":{"types":["number"],"help":"The difference between the given time and now."},"help":"How long has passed since the given time.","line":379,"public":true,"protected":false,"private":false,"parameters":[{"name":"since","type":["number"],"help":"The time you want to measure against.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeAll","static":false,"returns":null,"help":"Remove all Timer objects, regardless of their state. Also clears all Timers from the Time.events timer.","line":223,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the private _started value to now and removes all currently running Timers.","line":399,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"totalElapsedSeconds","static":false,"returns":{"types":["number"],"help":"The number of seconds that have elapsed since the game was started."},"help":"The number of seconds that have elapsed since the game was started.","line":368,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"boot","static":false,"returns":null,"help":"Called automatically by Phaser.Game after boot. Should not be called directly.","line":177,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Updates the game clock and if enabled the advanced timing data. This is called automatically by Phaser.Game.","line":243,"public":false,"protected":true,"private":false,"parameters":[{"name":"time","type":["number"],"help":"The current timestamp.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"private":[{"name":"gamePaused","static":false,"returns":null,"help":"Called when the game enters a paused state.","line":323,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"gameResumed","static":false,"returns":null,"help":"Called when the game resumes from a paused state.","line":344,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],