object:getIsPaused()

Type Function
Return value Boolean
Revision Release 2024.3703
Keywords animation, tween, interpolation, getIsPaused
See also object:pause()
Tween
animation.*

Overview

Returns a boolean true if the Tween is paused, otherwise false.

Syntax

object:getIsPaused()

Example

local object1 = display.newRect( 50, 50, 100, 100 )

-- Move the object
local newTween = animation.to( object1, { x=150, y=400 }, { time=5000 } )

-- Sometime later, pause the tween
newTween:pause()

-- Check if tween is paused
local isPaused = newTween:getIsPaused()
print( isPaused )  --> true