BANNER

Player's Bottom Banner User Interface. More...

Data Structures
struct	T_buttonCreateParms

Macros
#define	MANA_BACKCOLOR   225
#define	MAX_POTION_PICS   8
#define	NUM_AMMO_SLOTS   7
#define	NUMBER_BANNER_BUTTONS   11
#define	NUMBER_RUNE_BUTTONS   9

Functions
T_void	BannerAddSpellButton (T_byte8 slot)
E_Boolean	BannerAmmoWindowIsAt (T_word16 x, T_word16 y)
E_Boolean	BannerButtonsOk (T_void)
T_void	BannerCloseForm (T_void)
T_void	BannerCloseFormByButton (T_buttonID buttonID)
T_void	BannerCreateBottomButtons (T_void)
T_void	BannerDestroyBottomButtons (T_void)
T_void	BannerDisplayAmmoPage (T_void)
T_void	BannerDisplayFinancesPage (T_void)
E_Boolean	BannerFinancesWindowIsAt (T_word16 x, T_word16 y)
T_void	BannerFinish (T_void)
T_void	BannerFormControl (E_formObjectType objtype, T_word16 objstatus, T_word32 objID)
E_Boolean	BannerFormIsOpen (E_bannerFormType formtype)
E_equipBoltTypes	BannerGetSelectedAmmoType (T_void)
T_void	BannerInit (T_void)
T_void	BannerInitSoundOptions (T_void)
E_Boolean	BannerIsOpen (T_void)
T_void	BannerOpenForm (E_bannerFormType formtype)
T_void	BannerOpenFormByButton (T_buttonID buttonID)
T_void	BannerOpenLast (T_void)
T_void	BannerRedrawBottomButtons (T_void)
T_void	BannerRemoveSpellButton (T_byte8 slot)
T_void	BannerStatusBarFinish (T_void)
T_void	BannerStatusBarInit (T_void)
T_void	BannerStatusBarUpdate (T_void)
T_void	BannerUIModeOff (T_void)
T_void	BannerUIModeOn (T_void)
T_void	BannerUpdate (T_void)
T_void	BannerUpdateManaDisplay (T_void)
E_Boolean	BannerUseButtonIsDown (T_void)
T_void	PotionFinish (T_void)
T_void	PotionInit (T_void)
T_void	PotionUpdate (T_void)

Detailed Description

Player's Bottom Banner User Interface.

The Banner UI system is the top level system for handling the player's banner at the bottom of the screen. It tracks the current sub-window open as well as spells being cast.

See Also

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

Macro Definition Documentation

#define MANA_BACKCOLOR   225

#define MAX_POTION_PICS   8

#define NUM_AMMO_SLOTS   7

#define NUMBER_BANNER_BUTTONS   11

#define NUMBER_RUNE_BUTTONS   9

Function Documentation

T_void BannerAddSpellButton

(

T_byte8

slot)

E_Boolean BannerAmmoWindowIsAt	(	T_word16	x,
		T_word16	y
	)

E_Boolean BannerButtonsOk

(

T_void

)

T_void BannerCloseForm

(

T_void

)

Closes any current form displayed on the right side of the window Deletes main menu buttons

T_void BannerCloseFormByButton

(

T_buttonID

buttonID)

T_void BannerCreateBottomButtons

(

T_void

)

BannerCreateBottomButtons creates all the buttons that make up the banner at the bottom of the screen.

NOTE: Don't call if already created.

T_void BannerDestroyBottomButtons

(

T_void

)

BannerDestroyBottomButtons gets rid of all the buttons needed by the bottom banner.

NOTE: You can call this multiple times.

T_void BannerDisplayAmmoPage

(

T_void

)

T_void BannerDisplayFinancesPage

(

T_void

)

E_Boolean BannerFinancesWindowIsAt	(	T_word16	x,
		T_word16	y
	)

T_void BannerFinish

(

T_void

)

BannerFinish closes out all the stuff that makes up the banner.

T_void BannerFormControl	(	E_formObjectType	objtype,
		T_word16	objstatus,
		T_word32	objID
	)

FormCallBack routine set to control events for forms added to gaming window display area

E_Boolean BannerFormIsOpen

(

E_bannerFormType

formtype)

E_equipBoltTypes BannerGetSelectedAmmoType

(

T_void

)

T_void BannerInit

(

T_void

)

BannerInit sets up all the parts necessary to display the banner at the bottom of the screen.

T_void BannerInitSoundOptions

(

T_void

)

E_Boolean BannerIsOpen

(

T_void

)

T_void BannerOpenForm

(

E_bannerFormType

formtype)

BannerOpenForm changes the view to small screen and displays a form on the right side. Also, BannerOpenForm creates 6 buttons for the 'main menu'

NOTE: Currently only supports main menus (i.e. always adds main menu buttons on top of the form

T_void BannerOpenFormByButton

(

T_buttonID

buttonID)

Calls BannerOpenForm with the formtype specified by Button->data

T_void BannerOpenLast

(

T_void

)

T_void BannerRedrawBottomButtons

(

T_void

)

T_void BannerRemoveSpellButton

(

T_byte8

slot)

T_void BannerStatusBarFinish

(

T_void

)

Removes text boxes created for the mini status display

T_void BannerStatusBarInit

(

T_void

)

Sets up the mini-status bar displayed at the bottom of the 3d banner

T_void BannerStatusBarUpdate

(

T_void

)

Checks to see if stats have changed and updates the mini-status bar accordingly

T_void BannerUIModeOff

(

T_void

)

T_void BannerUIModeOn

(

T_void

)

T_void BannerUpdate

(

T_void

)

BannerUpdate updates all elements of the banner as necessary.

T_void BannerUpdateManaDisplay

(

T_void

)

This routine updates the mana available display

E_Boolean BannerUseButtonIsDown

(

T_void

)

T_void PotionFinish

(

T_void

)

PotionInit removes all pictures used by the potion display on the banner.

T_void PotionInit

(

T_void

)

PotionInit initializes all the pictures for the potion display on the banner.

T_void PotionUpdate

(

T_void

)

PotionUpdate animates the potion