Class

GIFanim

GIFanim(filename)

Constructor

# new GIFanim(filename)

load a GIF animation.

Note: GIFanim module must be loaded by calling LoadLibrary("gifanim") before using!

Parameters:
Name Type Description
filename string

file name of the GIF to load

See:
  • LoadLibrary()

Members

number

# duration

duration of animation in milliseconds

string

# filename

name of gif

number

# frameCount

total frames in file

number

# height

height of GIF

number

# maxDelay

maximum frame delay

number

# minDelay

minimum frame delay

number

# width

width of GIF

Methods

# Close()

Close GIFanim after use

# GetComment() → {string}

get gif anim comment

the gif anim comment

string

# PlayFrame(x, y) → {number}

play the next frame of the animation. Frames are rendered consecutive with each call. It is not possible to directly render a specific frame except by using SkipFrame().

Parameters:
Name Type Description
x number

x position to render the left, upper edge of the animation

y number

y position to render the left, upper edge of the animation

-1 if this was the last frame, else the delay for the next frame.

number

# SkipFrame() → {number}

skip the rendering of a frame.

-1 if this was the last frame, else the delay for the next frame.

number