menu_internal.h File Reference

What every part of the menu object shares: its includes, and the macros and types more than one part uses. More...

Go to the source code of this file.

Macros
#define	ACTION_USABLE_IN_FIELD   0x40
	BattleAct.flags: where an ability or item can be used, as the Psynergy list says ("Usable in the field", "Usable in battle").
#define	ACTION_USABLE_IN_BATTLE   0x80
#define	FLAG_MENU_START_PRESSED   0x150
	Game flags of the menus.
#define	FLAG_MENU_INFO_KEPT   0x151
	The info window holds a message the next selection must not draw over.
#define	MENU_TARGET_WHOLE_PARTY   9
	The target id of Psynergy or an item used on the whole party.
#define	MENU_WORK_SIZE   0xa70
	The bytes of the menu work, heap block HEAP_SLOT_MENU.
#define	MENU_ITEM_GRID_COLUMNS   5
	Inventory icons occupy five columns in the fifteen-slot list.
#define	STATUS_PANEL_KIND_MASK   0xff
#define	STATUS_PANEL_LOWER_ONLY   0x100
	Keeps the open window, the name and the ailments, and redraws only the part below them.
#define	MENU_RESET_INFO_WINDOW   RenderOutput_RedrawSavedRectFar
#define	MENU_DRAW_INFO_TEXT   UiText_DrawCharacterAtOffsetFar
#define	MENU_DRAW_STATUS_LABEL   UiText_DrawStringAtOffsetFar
#define	TEXT_COLOR_LOW_HP   4
	HP under a quarter of the maximum.
#define	TEXT_COLOR_NO_HP   2
	HP 0.
#define	TEXT_COLOR_NORMAL   15
#define	ICON_SHOWN   1
	RenderOutput.active as the menu sets it: shown, or hidden but kept.
#define	ICON_HIDDEN   13
#define	ICON_SPRITE_16X16   0x40000000
	RenderOutput_CreateFar's sprite attributes for the menu's 16x16 icons.

Enumerations
enum	StatusPanelKind {   STATUS_PANEL_EXPERIENCE = 0 , STATUS_PANEL_EQUIP = 2 , STATUS_PANEL_LEARN = 4 , STATUS_PANEL_CLASS = 6 ,   STATUS_PANEL_STATS = 8 }
	What Menu_DrawOwnerStatusPanel shows below the name and ailments: the low byte of its mode. More...
enum	DjinnCompareOperation { DJINN_COMPARE_TRADE = 0 , DJINN_COMPARE_GIVE = 1 , DJINN_COMPARE_STANDBY = 2 , DJINN_COMPARE_SET = 3 }
	The preview loop's four operations, as its confirmation text describes them. More...

Functions
s32	_call_via_r3 (void *, void *, s32, void *)

Variables
u8	IwramCopyWords []

Detailed Description

What every part of the menu object shares: its includes, and the macros and types more than one part uses.

menu.c includes it before the parts, and each part includes it too, so that a part read on its own resolves. It places no bytes.

Definition in file menu_internal.h.

Macro Definition Documentation

ACTION_USABLE_IN_FIELD

#define ACTION_USABLE_IN_FIELD   0x40

BattleAct.flags: where an ability or item can be used, as the Psynergy list says ("Usable in the field", "Usable in battle").

Definition at line 79 of file menu_internal.h.

Referenced by Item_ClassifyUseMode(), PsynergyMenu_CollectActions(), PsynergyMenu_DrawRangePage(), and PsynergyMenu_IsActionRestricted().

ACTION_USABLE_IN_BATTLE

#define ACTION_USABLE_IN_BATTLE   0x80

Definition at line 80 of file menu_internal.h.

Referenced by BattleMenu_RunActionSelection(), Item_ClassifyUseMode(), PsynergyMenu_DrawRangePage(), and PsynergyMenu_IsActionRestricted().

FLAG_MENU_START_PRESSED

#define FLAG_MENU_START_PRESSED   0x150

Game flags of the menus.

Start was pressed: every menu screen unwinds and the whole menu closes.

Definition at line 84 of file menu_internal.h.

Referenced by CharacterMenu_SelectCommand(), CharacterSelector_RunRearrange(), DjinnMenu_ShowCurrentList(), ItemMenu_ChooseCommand(), ItemMenu_ConfirmDrop(), ItemMenu_ConfirmEquip(), ItemMenu_RunCommands(), ItemMenu_RunList(), ItemMenu_RunOwnerSelection(), ItemMenu_SelectGiveQuantity(), ItemMenu_SelectItem(), ItemMenu_SelectTarget(), Menu_CancelSoundReset(), Menu_CancelSoundTick(), Menu_EnsureCancelSound(), Menu_ResolveSelectedAction(), Menu_RunActionFlow(), Menu_SelectQuantity(), PsynergyMenu_RunList(), PsynergyMenu_SelectAction(), PsynergyMenu_SelectMember(), and PsynergyMenu_SelectTarget().

FLAG_MENU_INFO_KEPT

#define FLAG_MENU_INFO_KEPT   0x151

The info window holds a message the next selection must not draw over.

Definition at line 86 of file menu_internal.h.

Referenced by InventoryMenu_ShowModalMessage(), ItemMenu_SelectTarget(), PsynergyMenu_DrawDetailPage(), PsynergyMenu_SelectMember(), and PsynergyMenu_SelectTarget().

MENU_TARGET_WHOLE_PARTY

#define MENU_TARGET_WHOLE_PARTY   9

The target id of Psynergy or an item used on the whole party.

Definition at line 89 of file menu_internal.h.

Referenced by BattleEffect_ApplyToTargets(), and Menu_ResolveSelectedAction().

MENU_WORK_SIZE

#define MENU_WORK_SIZE   0xa70

The bytes of the menu work, heap block HEAP_SLOT_MENU.

Definition at line 92 of file menu_internal.h.

Referenced by DjinnMenu_Run(), ItemMenu_Run(), Menu_OpenCharacterSelector(), PsynergyMenu_Run(), StatusMenu_Run(), and UiWindow_InitializeWork().

MENU_ITEM_GRID_COLUMNS

#define MENU_ITEM_GRID_COLUMNS   5

Inventory icons occupy five columns in the fifteen-slot list.

Definition at line 95 of file menu_internal.h.

Referenced by ItemMenu_HidePageIcons(), and ItemMenu_RefreshEntry().

STATUS_PANEL_KIND_MASK

#define STATUS_PANEL_KIND_MASK   0xff

Definition at line 106 of file menu_internal.h.

Referenced by Menu_DrawOwnerStatusPanel().

STATUS_PANEL_LOWER_ONLY

#define STATUS_PANEL_LOWER_ONLY   0x100

Keeps the open window, the name and the ailments, and redraws only the part below them.

Definition at line 109 of file menu_internal.h.

Referenced by ItemMenu_DrawEquipPreview(), and Menu_DrawOwnerStatusPanel().

MENU_RESET_INFO_WINDOW

#define MENU_RESET_INFO_WINDOW   RenderOutput_RedrawSavedRectFar

Definition at line 113 of file menu_internal.h.

Referenced by ItemMenu_ChooseCommand(), ItemMenu_DrawItemDetailPage(), ItemMenu_SelectTarget(), PsynergyMenu_DrawDetailPage(), and PsynergyMenu_SelectTarget().

MENU_DRAW_INFO_TEXT

#define MENU_DRAW_INFO_TEXT   UiText_DrawCharacterAtOffsetFar

Definition at line 114 of file menu_internal.h.

Referenced by ItemMenu_ChooseCommand(), ItemMenu_DrawEquipPage(), ItemMenu_DrawItemDetailPage(), ItemMenu_SelectTarget(), PsynergyMenu_DrawDetailPage(), PsynergyMenu_DrawRangePage(), and PsynergyMenu_SelectTarget().

MENU_DRAW_STATUS_LABEL

#define MENU_DRAW_STATUS_LABEL   UiText_DrawStringAtOffsetFar

Definition at line 124 of file menu_internal.h.

Referenced by CharacterMenu_DrawStatusAilments(), ItemMenu_DrawOwnerStatus(), and Menu_DrawOwnerStatusPanel().

TEXT_COLOR_LOW_HP

#define TEXT_COLOR_LOW_HP   4

HP under a quarter of the maximum.

Definition at line 128 of file menu_internal.h.

Referenced by PsynergyMenu_DrawActionPage(), Ui_DrawValuePairRows(), and UiPalette_SetColor4().

TEXT_COLOR_NO_HP

#define TEXT_COLOR_NO_HP   2

HP 0.

Definition at line 129 of file menu_internal.h.

Referenced by PsynergyMenu_DrawActionPage(), Ui_DrawValuePairRows(), and UiPalette_SetColor2().

TEXT_COLOR_NORMAL

#define TEXT_COLOR_NORMAL   15

Definition at line 130 of file menu_internal.h.

Referenced by CharacterMenu_DrawStatusAilments(), DjinnMenu_DrawElementList(), DjinnMenu_DrawStatPreview(), ItemMenu_DrawCommands(), ItemMenu_DrawOwnerStatus(), OwnerAction_RunCompareLoop(), PsynergyMenu_DrawActionPage(), PsynergyMenu_DrawShortcuts(), Ui_DrawValuePairRows(), and UiPalette_SetColor15().

ICON_SHOWN

#define ICON_SHOWN   1

RenderOutput.active as the menu sets it: shown, or hidden but kept.

Definition at line 133 of file menu_internal.h.

Referenced by CharacterMenu_DrawStatusAilments(), CharacterMenu_SelectCommand(), CharacterMenu_SelectOwner(), DjinnMenu_RunScreen(), DjinnMenu_SelectDjinn(), DjinnMenu_ShowCurrentList(), InventoryMenu_ShowModalMessage(), ItemMenu_DrawItemHead(), ItemMenu_DrawOwnerStatus(), ItemMenu_RunCommands(), ItemMenu_SelectItem(), Menu_SelectQuantity(), Menu_SetPageIcons(), OwnerAction_RunCompareLoop(), PsynergyMenu_RunList(), PsynergyMenu_SelectAction(), PsynergyMenu_SelectPartySlot(), UiIcon_CreateStatChangeArrow(), UiIcon_DrawVariantWithTileOffset(), and UiIcon_PrepareObject().

ICON_HIDDEN

#define ICON_HIDDEN   13

Definition at line 134 of file menu_internal.h.

Referenced by DjinnMenu_RunScreen(), DjinnMenu_ShowCurrentList(), DjinnMenu_ShowOwnerStatus(), InventoryMenu_ShowModalMessage(), ItemMenu_Close(), ItemMenu_HideAllIcons(), ItemMenu_HidePageIcons(), ItemMenu_RunCommands(), ItemMenu_RunList(), ItemMenu_RunOwnerSelection(), ItemMenu_SelectGiveQuantity(), ItemMenu_SelectTarget(), Menu_HideEmptyEntryIcons(), Menu_RunActionFlow(), Menu_SelectQuantity(), Menu_SetPageIcons(), OwnerAction_RunCompareLoop(), PsynergyMenu_CreateEntryGrid(), PsynergyMenu_RunList(), PsynergyMenu_SelectMember(), PsynergyMenu_SelectPartySlot(), PsynergyMenu_SelectTarget(), and UiMenu_CreateCursor().

ICON_SPRITE_16X16

#define ICON_SPRITE_16X16   0x40000000

RenderOutput_CreateFar's sprite attributes for the menu's 16x16 icons.

Definition at line 137 of file menu_internal.h.

Referenced by UiIcon_CreateStatChangeArrow(), UiIcon_CreateWithLoadedResource(), UiIcon_CreateWithResource(), UiIcon_CreateWithResourceVariant(), and UiIcon_DrawVariantWithTileOffset().

Enumeration Type Documentation

StatusPanelKind

enum StatusPanelKind

What Menu_DrawOwnerStatusPanel shows below the name and ailments: the low byte of its mode.

Enumerator
STATUS_PANEL_EXPERIENCE	class, HP, PP and experience
STATUS_PANEL_EQUIP	stats if the item were equipped
STATUS_PANEL_LEARN	the Psynergy a Psynergy item teaches
STATUS_PANEL_CLASS	class, HP and PP
STATUS_PANEL_STATS	Attack, Defense, Agility and Luck.

Definition at line 99 of file menu_internal.h.

DjinnCompareOperation

enum DjinnCompareOperation

The preview loop's four operations, as its confirmation text describes them.

Enumerator
DJINN_COMPARE_TRADE
DJINN_COMPARE_GIVE
DJINN_COMPARE_STANDBY
DJINN_COMPARE_SET

Definition at line 140 of file menu_internal.h.

Function Documentation

_call_via_r3()

s32 _call_via_r3	(	void *	,
		void *	,
		s32	,
		void *	)

Variable Documentation

IwramCopyWords

u8 IwramCopyWords[]

extern

Referenced by Owner_Copy().