Tweener Documentation
Tweening parameters are properties that are available when creating a new tweening with the addTween or addCaller methods. Because both these methods rely on loose objects for their parameters, it's important to remember the name of the available parameters. For example:
// Slide a movieclip to a new position in 0.5 seconds (AS2) Tweener.addTween(myMovieClip, {_x:10, time:0.5, transition:"linear"});
On the above example, the highlighted part make up the parameters used - that is, the transition time is set to 0.5 seconds, and the current transition should be linear.
Many other parameters can be used, though, and all of them are optional. Use the reference below (or at the menu on the left) for an explanation of each parameter, and its uses, as well as examples.
| Parameter name | Type | Description | Methods in which it is used |
|---|---|---|---|
| base | Object or Array | An array OR an object containing properties and parameters to declare a new tweening. | addTween, addCaller |
| count | Number | How many times you want the onUpdate function of an addCaller tweening to be called. |
addCaller |
| delay | Number | How much time the transition must wait before it starts. | addTween, addCaller |
| onComplete | Function | A function that is called immediately after a tweening is completed. | addTween, addCaller |
| onCompleteParams | Array | A list of parameters (of any type) to be passed to the onComplete function. |
addTween, addCaller |
| onError | Function | A function that gets called when an error occurs when trying to run a tweening. | addTween, addCaller |
| onOverwrite | Function | A function that is called when tweening is overwritten. | addTween, addCaller |
| onOverwriteParams | Array | A list of parameters (of any type) to be passed to the onOverwrite function. |
addTween, addCaller |
| onStart | Function | A function that is called immediately before a tweening starts. | addTween, addCaller |
| onStartParams | Array | A list of parameters (of any type) to be passed to the onStart function. |
addTween, addCaller |
| onUpdate | Function | A function that is called every time a tweening updates its properties. | addTween, addCaller |
| onUpdateParams | Array | A list of parameters (of any type) to be passed to the onUpdate function. |
addTween, addCaller |
| overwrite | Boolean | Whether or not the new tween will overwrite other activate tweens that are applied to the same object, on the same property, and which overlap the time the new tween will take. | addTween |
| rounded | Boolean | Whether or not the values for this tweening must be rounded before being applied to their respective properties. | addTween, addCaller |
| skipUpdates | Number | How many updates must be skipped before an actual update is made. | addTween |
| time | Number | How long a transition will take. | addTween, addCaller |
| transition | String or Function | The type of transition to use. | addTween, addCaller |
| useFrames | Boolean | Whether the engine should use the a frame counter or a time counter for a given tweening. | addCaller |
| waitFrames | Boolean | Whether the engine should wait at least one frame before executing a new onUpdate function for an addCaller tweening or not. |
addTween, addCaller |