Module

flic

Members

# inner FLIC_HEIGHT

Properties:
Name Type Description
FLIC_HEIGHT number

height of the currently open FLIC.

# inner FLIC_WIDTH

Properties:
Name Type Description
FLIC_WIDTH number

width of the currently open FLIC.

Methods

# inner FlicClose()

close FLIC file.

# inner FlicOpen(fname)

Open a FLIC file. Only one FLIC can be open at a given time. FLIC files can NOT be read from ZIP files.

Parameters:
Name Type Description
fname string

file name to open.

# inner FlicPlay(x, y, loop) → {number}

Display the next frame from the currently open FLIC.

Parameters:
Name Type Description
x number

the top left point where the FLIC shall be rendered

y number

the top left point where the FLIC shall be rendered

loop boolean

true to loop the animation, false to only play it once.

if 'loop' is false this function returns '-1' after the last frame was decoded. In all other cases the current frame number is returned.

number