OVERLAY

Overlay Animation. More...

Data Structures
struct	T_animationFrame
struct	T_overlayAnimation

Macros
#define	ANIMATION_IMAGE_NONE   0xFF
#define	ANIMATION_IMAGE_TRANSLUCENT   0x01
#define	MAX_IMAGE_LENGTH   140
#define	MAX_IMAGES   32
#define	MAX_LAYERS   3

Functions
T_void	OverlayAnimate (T_word32 speed)
T_void	OverlayDraw (T_word16 left, T_word16 top, T_word16 right, T_word16 bottom, T_sword16 xOffset, T_sword16 yOffset)
T_void	OverlayFinish (T_void)
T_void	OverlayInitialize (T_void)
E_Boolean	OverlayIsDone (T_void)
T_void	OverlaySetAnimation (T_word16 animationNumber)
T_void	OverlaySetCallback (T_overlayCallback p_callback)
T_void	OverlaySetTranslucencyMode (E_Boolean mode)
T_void	OverlayUpdate (E_Boolean isPaused)

Detailed Description

Overlay Animation.

The player's weapon and hands are shown using the Overlay system. It also handles the animation as an attack sequence is performed. There is one animation per weapon type.

See Also

http://www.amuletsandarmor.com/AALicense.txt

Macro Definition Documentation

#define ANIMATION_IMAGE_NONE   0xFF

#define ANIMATION_IMAGE_TRANSLUCENT   0x01

#define MAX_IMAGE_LENGTH   140

#define MAX_IMAGES   32

#define MAX_LAYERS   3

Function Documentation

T_void OverlayAnimate

(

T_word32

speed)

OverlayAnimate starts an animation cycle.

Parameters

speed

– Speed of animation where 65536 is normal speed, 32768 is half, and 131072 is double.

T_void OverlayDraw	(	T_word16	left,
		T_word16	top,
		T_word16	right,
		T_word16	bottom,
		T_sword16	xOffset,
		T_sword16	yOffset
	)

OverlayDraw is called to draw the current frame on the screen at the given offset and with the give bounds.

Parameters

left	– Upper left of bounding view
top	– Upper left of bounding view
right	– Lower right of bounding view
bottom	– Lower right of bounding view
xOffset	– X Offset of picture
yOffset	– Y Offset of picture

T_void OverlayFinish

(

T_void

)

OverlayFinish cleans up the overlay module afterwards.

T_void OverlayInitialize

(

T_void

)

OverlayInitialize sets up the basics for the overlay manager.

E_Boolean OverlayIsDone

(

T_void

)

T_void OverlaySetAnimation

(

T_word16

animationNumber)

OverlaySetAnimation declares the animation to be used for the next overlay cycle and the overlay at the beginning.

Parameters

animationNumber

– Number of the animation to use

T_void OverlaySetCallback

(

T_overlayCallback

p_callback)

OverlaySetCallback declares the function to call when the overlay has completed the animation.

Parameters

p_callback

– Callback to call when done

T_void OverlaySetTranslucencyMode

(

E_Boolean

mode)

T_void OverlayUpdate

(

E_Boolean

isPaused)

OverlayUpdate updates the animation of the overlay (if there is one).