currentFrame

Typeproperty
DictionaryLCS
LibraryLiveCode Script
Syntax
set the currentFrame of <image> to <frameNumber>
Associationsimage
Summary

Specifies the current frame of an animated GIF.

Introduced1.0
OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Example
set the currentFrame of image "Process" to 1 -- back to the beginning
Values
NameTypeDescription
Value

The currentFrame of an image is a positive integer. By default, the currentFrame property of newly created images is set to 1.

RelatedKeyword: image, integer
Property: repeatCount, frameCount, endFrame, startFrame, currentTime, palindromeFrames
Object: image
Glossary: frame, animated GIF, property
Description

Use the currentFrame property to check where an animated GIF image is in its sequence. Set this property in order to change the current frame of an animated GIF: for example, to examine the animation frame by frame.

If the image is not a GIF, the currentFrame property always reports 1, and setting it has no effect.

Tagsmultimedia