Tween Functions

Functions to start tweens for visual effects.

startTween

startTween(twnTag:String, objTag:String, values:Any, duration:Float, ?options:Any = null):String

Starts a complex tween and call function "onTweenCompleted" when it ends.
Returns the formatted Tween tag.

twnTag - Tween tag for the "onTweenCompleted" function, it should be unique or it will overwrite the previous one with the same name.
objTag - Sprite variable name or Lua Sprite nametag.
values - A table with the properties to change and its target values at the end of the tween.
duration - Tween duration.
options (Optional) - Tween options, it's a table with all optional values you can set: "type", "ease", "startDelay", "loopDelay", "onUpdate", "onStart", "onComplete".

Examples:

startTween('someBFtween', 'boyfriend.scale', {x = 1.5, y = 1.5}, 0.5, {ease = 'sineOut'}) - Starts a tween for Player's Scale.
startTween('mySpriteTween', 'mySprite', {x = 1000, y = 500}, 0.5, {ease = 'quadOut', onComplete = 'myTween'}) - Starts a tween on the Position of "mySprite" Lua Sprite, calls function myTween('mySpriteTween', 'mySprite') on complete.

Note: For optimization sake, if you're changing a single value, you should use the other tween functions when possible.

doTweenX

doTweenX(twnTag:String, objTag:String, value:Dynamic, duration:Float, ?ease:String = 'linear'):String

Starts a simple tween to change the Sprite's X and call function "onTweenCompleted" when it ends.
Returns the formatted Tween tag.

twnTag - Tween tag for the "onTweenCompleted" function, it should be unique or it will overwrite the previous one with the same name.
objTag - Sprite variable name or Lua Sprite nametag.
value - Target value at the end of the tween.
duration - Tween duration.
ease (Optional) - Tween ease, defaults to "linear".

Examples:

doTweenX('mySpriteTween', 'mySprite', 1000, 0.5, 'quadOut') - Starts a tween on the X Position of "mySprite" Lua Sprite.

doTweenY

doTweenY(twnTag:String, objTag:String, value:Dynamic, duration:Float, ?ease:String = 'linear'):String

Starts a simple tween to change the Sprite's Y and call function "onTweenCompleted" when it ends.
Returns the formatted Tween tag.

twnTag - Tween tag for the "onTweenCompleted" function, it should be unique or it will overwrite the previous one with the same name.
objTag - Sprite variable name or Lua Sprite nametag.
value - Target value at the end of the tween.
duration - Tween duration.
ease (Optional) - Tween ease, defaults to "linear".

Examples:

doTweenY('mySpriteTween', 'mySprite', 500, 0.5, 'quadOut') - Starts a tween on the Y Position of "mySprite" Lua Sprite.

doTweenAngle

doTweenAngle(twnTag:String, objTag:String, value:Dynamic, duration:Float, ?ease:String = 'linear'):String

Starts a simple tween to change the Sprite's Angle and call function "onTweenCompleted" when it ends.
Returns the formatted Tween tag.

twnTag - Tween tag for the "onTweenCompleted" function, it should be unique or it will overwrite the previous one with the same name.
objTag - Sprite variable name or Lua Sprite nametag.
value - Target value at the end of the tween.
duration - Tween duration.
ease (Optional) - Tween ease, defaults to "linear".

Examples:

doTweenAngle('mySpriteTween', 'mySprite', 90, 0.5, 'quadOut') - Starts a tween on Angle of "mySprite" Lua Sprite to set it to 90°.

doTweenAlpha

doTweenAlpha(twnTag:String, objTag:String, value:Dynamic, duration:Float, ?ease:String = 'linear'):String

Starts a simple tween to change the Sprite's Alpha and call function "onTweenCompleted" when it ends.
Returns the formatted Tween tag.

twnTag - Tween tag for the "onTweenCompleted" function, it should be unique or it will overwrite the previous one with the same name.
objTag - Sprite variable name or Lua Sprite nametag.
value - Target value at the end of the tween, ranges from 0 to 1.
duration - Tween duration.
ease (Optional) - Tween ease, defaults to "linear".

Examples:

doTweenAlpha('mySpriteTween', 'mySprite', 0.25, 0.5, 'quadOut') - Starts a tween on the Alpha of "mySprite" Lua Sprite.

doTweenColor

doTweenColor(twnTag:String, objTag:String, targetColor:String, duration:Float, ?ease:String = 'linear'):String

Starts a simple tween to change the Sprite's Color and call function "onTweenCompleted" when it ends.
Returns the formatted Tween tag.

twnTag - Tween tag for the "onTweenCompleted" function, it should be unique or it will overwrite the previous one with the same name.
objTag - Sprite variable name or Lua Sprite nametag.
targetColor - Color hexadecimal string or color name.
duration - Tween duration.
ease (Optional) - Tween ease, defaults to "linear".

Examples:

doTweenColor('mySpriteTween', 'mySprite', 'FF0000', 0.5, 'sineOut') - Starts a tween on "mySprite" Lua Sprite to make it red.
doTweenColor('mySpriteTween', 'mySprite', 'blue', 0.5, 'sineOut') - Starts a tween on "mySprite" Lua Sprite to make it blue.

doTweenZoom

doTweenZoom(twnTag:String, camera:String, value:Dynamic, duration:Float, ?ease:String = 'linear'):String

Starts a simple tween to change the Camera's Zoom and call function "onTweenCompleted" when it ends.
Returns the formatted Tween tag.

twnTag - Tween tag for the "onTweenCompleted" function, it should be unique or it will overwrite the previous one with the same name.
camera - Can be "game", "hud" or "other".
value - Target value at the end of the tween.
duration - Tween duration.
ease (Optional) - Tween ease, defaults to "linear".

Examples:

doTweenZoom('testZoomTween', 'game', 1.5, 0.5, 'linear')

Note: Use "setProperty('camZooming', false)" to disable the camera automatic zoom-in.

noteTweenX

noteTweenX(twnTag:String, note:Int, value:Dynamic, duration:Float, ?ease:String = 'linear'):String

Starts a simple tween to change a Strum Note's X and call function "onTweenCompleted" when it ends.
Returns the formatted Tween tag.

twnTag - Tween tag for the "onTweenCompleted" function, it should be unique or it will overwrite the previous one with the same name.
note - Strum Note ID (0-3 = Opponent, 4-7 = Player).
value - Target value at the end of the tween.
duration - Tween duration.
ease (Optional) - Tween ease, defaults to "linear".

Examples:

noteTweenX('mySpriteTween', 2, 600, 0.5, 'quadOut') - Moves the Opponent's Up note.
noteTweenX('mySpriteTween', 7, 600, 0.5, 'quadOut') - Moves the Player's Right note.

noteTweenY

noteTweenY(twnTag:String, note:Int, value:Dynamic, duration:Float, ?ease:String = 'linear'):String

Starts a simple tween to change a Strum Note's Y and call function "onTweenCompleted" when it ends.
Returns the formatted Tween tag.

twnTag - Tween tag for the "onTweenCompleted" function, it should be unique or it will overwrite the previous one with the same name.
note - Strum Note ID (0-3 = Opponent, 4-7 = Player).
value - Target value at the end of the tween.
duration - Tween duration.
ease (Optional) - Tween ease, defaults to "linear".

Examples:

noteTweenY('mySpriteTween', 2, 300, 0.5, 'quadOut') - Moves the Opponent's Up note.
noteTweenY('mySpriteTween', 7, 300, 0.5, 'quadOut') - Moves the Player's Right note.

noteTweenAngle

noteTweenAngle(twnTag:String, note:Int, value:Dynamic, duration:Float, ?ease:String = 'linear'):String

Starts a simple tween to change a Strum Note's Angle and call function "onTweenCompleted" when it ends.
Returns the formatted Tween tag.

twnTag - Tween tag for the "onTweenCompleted" function, it should be unique or it will overwrite the previous one with the same name.
note - Strum Note ID (0-3 = Opponent, 4-7 = Player).
value - Target value at the end of the tween.
duration - Tween duration.
ease (Optional) - Tween ease, defaults to "linear".

Examples:

noteTweenAngle('mySpriteTween', 2, 90, 0.5, 'quadOut') - Moves the Opponent's Up note.
noteTweenAngle('mySpriteTween', 7, 150, 0.5, 'quadOut') - Moves the Player's Right note.

noteTweenAlpha

noteTweenAlpha(twnTag:String, note:Int, value:Dynamic, duration:Float, ?ease:String = 'linear'):String

Starts a simple tween to change a Strum Note's Alpha and call function "onTweenCompleted" when it ends.
Returns the formatted Tween tag.

twnTag - Tween tag for the "onTweenCompleted" function, it should be unique or it will overwrite the previous one with the same name.
note - Strum Note ID (0-3 = Opponent, 4-7 = Player).
value - Target value at the end of the tween, ranges from 0 to 1.
duration - Tween duration.
ease (Optional) - Tween ease, defaults to "linear".

Examples:

noteTweenAlpha('mySpriteTween', 2, 0.25, 0.5, 'quadOut') - Lowers opacity of the Opponent's Up note.
noteTweenAlpha('mySpriteTween', 7, 0.25, 0.5, 'quadOut') - Lowers opacity of the Player's Right note.

noteTweenDirection

noteTweenDirection(twnTag:String, note:Int, value:Dynamic, duration:Float, ?ease:String = 'linear'):String

Starts a simple tween to change a Strum Note's Direction and call function "onTweenCompleted" when it ends.
Returns the formatted Tween tag.

twnTag - Tween tag for the "onTweenCompleted" function, it should be unique or it will overwrite the previous one with the same name.
note - Strum Note ID (0-3 = Opponent, 4-7 = Player).
value - Target value at the end of the tween, ranges from 0 to 1.
duration - Tween duration.
ease (Optional) - Tween ease, defaults to "linear".

Examples:

noteTweenAlpha('mySpriteTween', 2, 180, 0.5, 'quadOut') - Makes notes come sideways from the Opponent's Up note.
noteTweenAlpha('mySpriteTween', 7, 0, 0.5, 'quadOut') - Makes notes come sideways from the Player's Right note.

cancelTween

cancelTween(twnTag:String):Void

Cancels a Tween created with any of the Tween functions.

twnTag - Tween's tag.

Examples:

cancelTween('myTween') - Cancels the tween created with the Tween tag "myTween".