transition.cancel()

Overview

The transition.cancel() function will cancel one of the following, depending on the passed parameter:

• All transitions in progress, when called with no parameters.
• A specific transition, when called with a transition reference.
• All transitions on a specific display object, when called with a display object reference.
• All transitions with a specific tag, when called with a string parameter representing a tag.

Syntax

transition.cancel()
transition.cancel( transitionReference )
transition.cancel( displayObject )
transition.cancel( tagName )

Examples

-- cancel all running (and paused) transitions

local transition1 = transition.to( currentTarget, { time=400, y=y+100, iterations=5, tag="transTag" } )
local transition2 = transition.to( otherTarget, { time=200, y=y-200, tag="transTag" } )

-- later, cancel all running transitions
transition.cancel()

-- cancel a specific transition

local transition1 = transition.to( currentTarget, { time=400, y=y+100, iterations=5, tag="transTag" } )
local transition2 = transition.to( otherTarget, { time=200, y=y-200, tag="transTag" } )

-- later, cancel a specific transition
transition.cancel( transition1 )

-- cancel all transitions on a display object

local transition1 = transition.to( currentTarget, { time=400, y=y+100, iterations=5, tag="transTag" } )
local transition2 = transition.to( otherTarget, { time=200, y=y-200, tag="transTag" } )

-- later, cancel all transitions on the object 'otherTarget'
transition.cancel( otherTarget )

-- cancel all transitions with a specific tag

local transition1 = transition.to( currentTarget, { time=400, y=y+100, iterations=5, tag="transTag" } )
local transition2 = transition.to( otherTarget, { time=200, y=y-200, tag="transTag" } )

-- later, cancel all transitions with the tag "transTag"
transition.cancel( "transTag" )