transition.loop()

Type Function
Library transition.*
Return value Object
Revision Release 2022.3683
Keywords easing, animation, transition, tween, interpolation

Overview

Moves an object to the specified x and y coordinates and back, creating a loop.

time is used for a full cycle and the easing is reversed in the second half of the transition.

Syntax

transition.loop( target, params )
target (required)

Table. Any object that behaves like a table, for example display objects.

params (required)

Table. A table that specifies the properties of the transition — see the next section for details.

Parameter Reference

time (optional)

Number. The time of the action.

tag (optional)

String. Specifies the transition tag. The transition library can pause, resume, or cancel transitions sharing the same tag.

transition (optional)

Function. Specifies the easing interpolation method. Default is linear.

iterations (optional)

Number. Specifies the number of iterations for which the transition will repeat. By default, the iteration value is 1.

delay (optional)

Number. Specifies the delay, in milliseconds, before the transition begins. Default is 0.

x (optional)

Number. Moves the target from its current x coordinate to another.

y (optional)

Number. Moves the target from its current y coordinate to another.

onStart (optional)

Listener. Listener function to be called before the transition begins. This function will receive a reference to the associated object as its sole argument.

onComplete (optional)

Listener. Listener function to be called after the transition completes. This function will receive a reference to the associated object as its sole argument.

onPause (optional)

Listener. Listener function to be called when the transition is paused. This function will receive a reference to the associated object as its sole argument.

onResume (optional)

Listener. Listener function to be called when the transition is resumed. This function will receive a reference to the associated object as its sole argument.

onCancel (optional)

Listener. Listener function to be called when the transition is cancelled. This function will receive a reference to the associated object as its sole argument.

Examples

local square = display.newRect( 0, 0, 100, 100 )

transition.loop( square, { time = 2000, y = 100, iterations = 20, transition = easing.inOutQuad } )