object:pause()

Type Function
Object SpriteObject
Library display.*
Return value none
Revision 2017.3110
Keywords sprite, pause
See also display.newSprite()
object:setSequence()
object:play()

Overview

Pauses the current animation, and frame remains on the currently shown frame. Playback can resume later with object:play().

Syntax

object:pause()

Example

spriteObj:setSequence( "running_man" )
spriteObj:play() 

-- some time later
spriteObj:pause()