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

{"class":{"name":"Phaser.TweenManager","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"Phaser.Game has a single instance of the TweenManager through which all Tween objects are created and updated.\\nTweens are hooked into the game clock and pause system, adjusting based on the game state.\\n\\nTweenManager is based heavily on tween.js by http:\/\/soledadpenades.com.\\nThe difference being that tweens belong to a games instance of TweenManager, rather than to a global TWEEN object.\\nIt also has callbacks swapped for Signals and a few issues patched with regard to properties and completion errors.\\nPlease see https:\/\/github.com\/sole\/tween.js for a full list of contributors."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":null,"help":"Add a new tween into the TweenManager.","line":79,"public":true,"protected":false,"private":false,"parameters":[{"name":"tween","type":["Phaser.Tween"],"help":"The tween object you want to add.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"create","static":false,"returns":null,"help":"Create a tween object for a specific object. The object can be any JavaScript object or Phaser object such as Sprite.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object"],"help":"Object the tween will be run on.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getAll","static":false,"returns":null,"help":"Get all the tween objects in an array.","line":51,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"isTweening","static":false,"returns":null,"help":"Checks to see if a particular Sprite is currently being tweened.","line":175,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object"],"help":"The object to check for tweens against.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pauseAll","static":false,"returns":null,"help":"Pauses all currently running tweens.","line":218,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":null,"help":"Remove a tween from this manager.","line":105,"public":true,"protected":false,"private":false,"parameters":[{"name":"tween","type":["Phaser.Tween"],"help":"The tween object you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeAll","static":false,"returns":null,"help":"Remove all tweens running and in the queue. Doesn't call any of the tween onComplete events.","line":61,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"resumeAll","static":false,"returns":null,"help":"Resumes all currently paused tweens.","line":232,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"update","static":false,"returns":null,"help":"Update all the tween objects you added to this manager.","line":131,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"_pauseAll","static":false,"returns":null,"help":"Private. Called by game focus loss. Pauses all currently running tweens.","line":189,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_resumeAll","static":false,"returns":null,"help":"Private. Called by game focus loss. Resumes all currently paused tweens.","line":204,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_add","type":["array Phaser.Tween"],"help":"","inlineHelp":"All of the tweens queued to be added in the next update.","line":37,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tweens","type":["array Phaser.Tween"],"help":"","inlineHelp":"All of the currently running tweens.","line":31,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}