transition.pause()

Type Function
Library transition.*
Return value none
Revision Release 2024.3703
Keywords easing, animation, transition, tween, interpolation
See also Transitions (guide)

Overview

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

Syntax

transition.pause()
transition.pause( transitionReference )
transition.pause( displayObject )
transition.pause( tagName )
transitionReference (optional)

The specific transition to pause.

displayObject (optional)

DisplayObject. The display object upon which all associated transitions will be paused.

tagName (optional)

String. The tag name; all transitions with this tag will be paused.

Examples

-- pause all running 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, pause all running transitions
transition.pause()
-- pause 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, pause a specific transition
transition.pause( transition1 )
-- pause 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, pause all transitions on the object 'otherTarget'
transition.pause( otherTarget )
-- pause 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, pause all transitions with the tag "transTag"
transition.pause( "transTag" )