image_framecyclemode

declaration:

::lua
function image_framecyclemode(vid, mode) => nil

If mode is = 0, the active frame will never be cycled.
If mode is < 0, then the active frame will change every mode ticks.
if mode is > 0, then the active frame will change every mode frames.

caveats:

Only effective if there is a frameset allocated and other frames associated with the frameset.

If this is used on a frameserver, each frame has to have a matching storage size (can be achieved with the two optional arguments to [fill_surface] and be reset/rebuilt whenever the frameserver signals a resize. See the [frameset_frameserver_multitexture] special pattern.

related functions:

[set_image_as_frame] [image_active_frame] [image_framecyclemode]