mirror of
https://github.com/photonstorm/phaser
synced 2024-12-23 19:43:28 +00:00
1 line
16 KiB
JSON
1 line
16 KiB
JSON
|
{"class":{"name":"Phaser.Tween","extends":"","static":false,"constructor":true,"parameters":[{"name":"object","type":["object"],"help":"Target object will be affected by this tween.","optional":false,"default":null},{"name":"game","type":["Phaser.Game"],"help":"Current game instance.","optional":false,"default":null},{"name":"manager","type":["Phaser.TweenManager"],"help":"The TweenManager responsible for looking after this Tween.","optional":false,"default":null}],"help":"Tween constructor\\nCreate a new <code>Tween<\/code>."},"consts":[],"methods":{"public":[{"name":"chain","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"You can chain tweens together by passing a reference to the chain function. This enables one tween to call another on completion.\\nYou can pass as many tweens as you like to this function, they will each be chained in sequence.","line":557,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"delay","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"Sets a delay time before this tween will start.","line":478,"public":true,"protected":false,"private":false,"parameters":[{"name":"amount","type":["number"],"help":"The amount of the delay in ms.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"easing","static":false,"returns":{"types":["Phaser.Tween"],"help":"Itself."},"help":"Set easing function this tween will use, i.e. Phaser.Easing.Linear.None.","line":528,"public":true,"protected":false,"private":false,"parameters":[{"name":"easing","type":["function"],"help":"The easing function this tween will use, i.e. Phaser.Easing.Linear.None.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"from","static":false,"returns":{"types":["Phaser.Tween"],"help":"This Tween object."},"help":"Sets this tween to be a `from` tween on the properties given. A `from` tween starts at the given value and tweens to the current values.\\nFor example a Sprite with an `x` coordinate of 100 could be tweened from `x: 200` by giving a properties object of `{ x: 200 }`.","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"properties","type":["object"],"help":"Properties you want to tween from.","optional":false,"default":null},{"name":"duration","type":["number"],"help":"Duration of this tween in ms.","optional":true,"default":"1000"},{"name":"ease","type":["function"],"help":"Easing function. If not set it will default to Phaser.Easing.Linear.None.","optional":true,"default":"null"},{"name":"autoStart","type":["boolean"],"help":"Whether this tween will start automatically or not.","optional":true,"default":"false"},{"name":"delay","type":["number"],"help":"Delay before this tween will start, defaults to 0 (no delay). Value given is in ms.","optional":true,"default":"0"},{"name":"repeat","type":["number"],"help":"Should the tween automatically restart once complete? If you want it to run forever set as Number.MAX_VALUE. This ignores any chained tweens.","optional":true,"default":"0"},{"name":"yoyo","type":["boolean"],"help":"A tween that yoyos will reverse itself and play backwards automatically. A yoyo'd tween doesn't fire the Tween.onComplete event, so listen for Tween.onLoop instead.","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"generateData","static":false,"returns":{"types":["array"],"help":"An array of tweened values."},"help":"This will generate an array populated with the tweened object values from start to end.\\nIt works by running the tween simulation at the given frame rate based on the values set-up in Tween.to and similar functions.\\nIt ignores delay and repeat counts and any chained tweens. Just one play through of tween data is returned, including yoyo if set.","line":345,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameRate","type":["number"],"help":"The speed in frames per second that the data should be generated at. The higher the value, the large
|