Type Function Return value Boolean Revision Release 2025.3721 Keywords animation, timeline, interpolation, getIsPaused See also object:pause() Timeline animation.*
Returns a boolean true if the Timeline is paused, otherwise false.
object:getIsPaused()
local object1 = display.newRect( 50, 50, 100, 100 )
-- Create a timeline object
local timelineParams = {
tweens = {
{ startTime=0, tween={ object1, { x=400 }, { time=4000, iterations=5 } } },
{ startTime=1000, tween={ object1, { y=400 }, { time=4000, easing=easing.outQuad } } }
}
}
local newTimeline = animation.newTimeline( timelineParams )
-- Set the timeline playing
newTimeline:resume()
-- Sometime later, pause the timeline
newTimeline:pause()
-- Check if timeline is paused
local isPaused = newTimeline:getIsPaused()
print( isPaused ) --> true