Internal representation of an animation. Do not call directly; use animate_create() instead. More...

#include <animate.h>

Data Fields
uint8_t	type
	Type of animation this is (See ANIMATE_CB_TABLE).

int16_t	x
	Left origin of animation on screen in pixels.

int16_t	y
	Top origin of animation on screen in pixels.

int16_t	w
	Width of animation on screen in pixels.

int16_t	h
	Height of animation on screen in pixels.

uint16_t	flags
	Bitfield indicating animation's Unilayer Animation Flags.

int8_t	tile [ANIMATE_TILE_SZ]
	Data specific to particular animation playing.

Related Functions
(Note that these are not member functions.)
#define	ANIMATE_FLAG_ACTIVE 0x0001
	ANIMATION::flags indicating animation is active and playing.

#define	ANIMATE_FLAG_INIT 0x0002
	ANIMATION::flags indicating animation has been initialized.

#define	ANIMATE_FLAG_CLEANUP 0x0004
	ANIMATION::flags indicating animation should black out previous frame's non-black pixels.

#define	ANIMATE_FLAG_PAUSED 0x0008
	ANIMATION::flags indicating animation has been temporarily paused and should not update or draw on-screen.

#define	ANIMATE_FLAG_BG 0x0400
	Indicates that an animation is behind tiles.

#define	ANIMATE_FLAG_FG 0x0800
	Indicates that an animation is in front of tiles.

#define	ANIMATE_FLAG_WEATHER 0x0200
	Indicates that an animation is being used for TILEMAP::weather.

#define	ANIMATE_FLAG_SCRIPT 0x0100
	Indicates that an animation was created by a SCRIPT.

Detailed Description

Internal representation of an animation. Do not call directly; use animate_create() instead.

Field Documentation

uint16_t ANIMATION::flags

Bitfield indicating animation's Unilayer Animation Flags.

Lower 8 bits are Unilayer-specified flags. Upper 8 bits are application- specific and will be ignored by Unilayer.

The documentation for this struct was generated from the following files: