alchemy-docs/menu__internal_8h_source.html

#ifndef ALCHEMY_MENU_INTERNAL_H

#define ALCHEMY_MENU_INTERNAL_H


/// @file

/// 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.


#include "render_placement.h"

#include "unit/menu/menu.h"

#include "unit/runtime/runtime.h"

#include "battle.h"

#include "debug.h"

#include "field.h"

#include "game.h"

#include "graphics.h"

#include "menu.h"

#include "minigame.h"

#include "sound.h"

#include "system.h"

#include "types.h"

#include "callback_scheduler.h"

#include "dma.h"

#include "inventory_menu.h"

#include "io_reg.h"

#include "uiwindow.h"

#include "mem.h"

#include "character_menu.h"

#include "battle_unit.h"

#include "item.h"

#include "edition.h"

#include "battle_system.h"

#include "ui.h"

#include "text/msg_ids.h"

#include "resource.h"

#include "vram_block.h"

#include "render_input.h"

#include "fixed_math.h"

#include "lib.h"

#include "psynergy_menu.h"

#include "animspr.h"

#include "scene.h"

#include "m7_interfaces.h"

#include "global_cells.h"

#include "keystate.h"

#include "window.h"

#include "menu_result.h"

#include "tbs_edition.h"

#include "game_state.h"

#include "songs.h"

#include "iwram_call.h"

#include "heap_state.h"

#include "menu_list.h"

#include "irq.h"

#include "object_factory.h"

#include "far_runtime.h"

#include "equipment_menu.h"

#include "owner_state.h"

#include "inventory.h"

#include "static_assert.h"

#include "battle_type.h"

#include "battle_calc.h"

#include "event_work.h"

#include "djinn_menu.h"

#include "a9_motion.h"

#include "battle_effect.h"

#include "four_object_motion.h"

#include "item_ids.h"

#include "macros.h"

#include "flags.h"


extern u8 IwramCopyWords[];


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


/// 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_FIELD 0x40

#define ACTION_USABLE_IN_BATTLE 0x80


/// Game flags of the menus. Start was pressed: every menu screen unwinds and

/// the whole menu closes.

#define FLAG_MENU_START_PRESSED 0x150

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

#define FLAG_MENU_INFO_KEPT 0x151


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

#define MENU_TARGET_WHOLE_PARTY 9


/// The bytes of the menu work, heap block HEAP_SLOT_MENU.

#define MENU_WORK_SIZE 0xa70


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

#define MENU_ITEM_GRID_COLUMNS 5


/// What Menu_DrawOwnerStatusPanel shows below the name and ailments: the low

/// byte of its mode.

enum StatusPanelKind {

  STATUS_PANEL_EXPERIENCE = 0, ///< class, HP, PP and experience

  STATUS_PANEL_EQUIP = 2,      ///< stats if the item were equipped

  STATUS_PANEL_LEARN = 4,      ///< the Psynergy a Psynergy item teaches

  STATUS_PANEL_CLASS = 6,      ///< class, HP and PP

  STATUS_PANEL_STATS = 8,      ///< Attack, Defense, Agility and Luck

};

#define STATUS_PANEL_KIND_MASK 0xff

/// Keeps the open window, the name and the ailments, and redraws only the

/// part below them.

#define STATUS_PANEL_LOWER_ONLY 0x100


// The revised information pane restores its tiles and draws directly into them.

#if TBS_PATCH_1

#define MENU_RESET_INFO_WINDOW RenderOutput_RedrawSavedRectFar

#define MENU_DRAW_INFO_TEXT UiText_DrawCharacterAtOffsetFar

#else

#define MENU_RESET_INFO_WINDOW RenderOutput_ClearListFar

#define MENU_DRAW_INFO_TEXT UiText_DrawResourceFar

#endif


// Status labels use the Latin font's pixel positions or the Japanese tile grid.

#if LANGUAGE == LANGUAGE_JAPANESE

#define MENU_DRAW_STATUS_LABEL UiText_DrawStringInWindowFar

#else

#define MENU_DRAW_STATUS_LABEL UiText_DrawStringAtOffsetFar

#endif


// Text colours of the status panel's numbers.

#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


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

#define ICON_SHOWN 1

#define ICON_HIDDEN 13


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

#define ICON_SPRITE_16X16 0x40000000


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

enum DjinnCompareOperation {

  DJINN_COMPARE_TRADE = 0,

  DJINN_COMPARE_GIVE = 1,

  DJINN_COMPARE_STANDBY = 2,

  DJINN_COMPARE_SET = 3

};


#endif

a9_motion.h
Declares nothing of its own: it only includes edition.h and render_input.h.

animspr.h
Animated sprites: their layers, frames and colour modes, and the resource slots they draw from.

battle_calc.h
The battle calculation tables: hit chances, HP and PP damage and recovery.

battle_effect.h
The battle effect argument and the rectangle-drawing routines effects call.

battle_system.h
BattleUnit_Recalculate, which recalculates a unit's stats.

battle_type.h
BattlePlan, an action planned for its targets: the hits, criticals and multipliers rolled.

battle_unit.h
BattleUnit, a party member's or enemy's battle state, with the elements, abilities and actions it use...

callback_scheduler.h
The task scheduler: tasks, their order and the scheduler's state.

character_menu.h
The character menu's state, and the ailments it shows.

debug.h
The engine calls the debug menus import, and their palette swatch tiles.

djinn_menu.h
The Djinn menu: its list tables, backdrop and work, and the fields of a Djinni's list entry.

dma.h
DMA channel registers, and the DMA and CPU fills.

edition.h
The edition's language, for C to compare (LANGUAGE == LANGUAGE_GERMAN).

equipment_menu.h
Declares nothing of its own: it only includes types.h.

event_work.h
EventWork, the running scene's event work.

far_runtime.h
Declares nothing: an empty header kept for the files that include it.

fixed_math.h
16.16 fixed-point constants, sine and cosine, and the library division.

flags.h
Game flags, named where their meaning is shown.

four_object_motion.h
FourObjectMotion, the row of four figures the Status and Djinn menus show.

game_state.h
GameState, the game's state: play time, coins, the scene and the leader's position,...

global_cells.h
The work slots of gWorkSlot, read through their own names.

graphics.h
The screen blend's globals and the graphics routines.

heap_state.h
The heap's work slots and HeapState.

inventory.h
gOverflowItem, an item slot the spoils code uses when items are handed out.

inventory_menu.h
The item menu's state and commands.

io_reg.h
The hardware's I/O registers and their bits, as pret names them.

irq.h
The hardware's interrupt sources and the interrupt handler table.

item.h
Items: their definitions, types, flags and effects.

item_ids.h
Item numbers, named from the English release.

iwram_call.h
The IWRAM call layer: the routines the game keeps resident in IWRAM, each at its fixed address,...

keystate.h
The keypad state the VBlank interrupt keeps.

lib.h
Declares nothing of its own: it only includes types.h and edition.h.

m7_interfaces.h
Declares nothing of its own: it only includes edition.h and render_input.h.

macros.h
Small statement macros both games use for positions, velocities and bounds.

mem.h
The heaps: allocating and freeing blocks.

IwramCopyWords
u8 IwramCopyWords[]

DjinnCompareOperation
DjinnCompareOperation
The preview loop's four operations, as its confirmation text describes them.
Definition menu_internal.h:140

DJINN_COMPARE_GIVE
@ DJINN_COMPARE_GIVE
Definition menu_internal.h:142

DJINN_COMPARE_STANDBY
@ DJINN_COMPARE_STANDBY
Definition menu_internal.h:143

DJINN_COMPARE_TRADE
@ DJINN_COMPARE_TRADE
Definition menu_internal.h:141

DJINN_COMPARE_SET
@ DJINN_COMPARE_SET
Definition menu_internal.h:144

StatusPanelKind
StatusPanelKind
What Menu_DrawOwnerStatusPanel shows below the name and ailments: the low byte of its mode.
Definition menu_internal.h:99

STATUS_PANEL_STATS
@ STATUS_PANEL_STATS
Attack, Defense, Agility and Luck.
Definition menu_internal.h:104

STATUS_PANEL_LEARN
@ STATUS_PANEL_LEARN
the Psynergy a Psynergy item teaches
Definition menu_internal.h:102

STATUS_PANEL_EQUIP
@ STATUS_PANEL_EQUIP
stats if the item were equipped
Definition menu_internal.h:101

STATUS_PANEL_EXPERIENCE
@ STATUS_PANEL_EXPERIENCE
class, HP, PP and experience
Definition menu_internal.h:100

STATUS_PANEL_CLASS
@ STATUS_PANEL_CLASS
class, HP and PP
Definition menu_internal.h:103

menu_list.h
Menu lists: sprites, cursors, the party status window and paged selections.

menu_result.h
MenuResult, what a menu returns.

minigame.h
The reel game's title lettering.

object_factory.h
Object_Create, which creates a field object.

owner_state.h
Declares nothing of its own: it only includes battle_system.h.

psynergy_menu.h
The Psynergy menu's state.

render_input.h
The sprite renderer's inputs and outputs: render inputs, OAM attributes and render output lists.

render_placement.h
A sprite's screen position and scale.

scene.h
FIELD_AT_OFFSET and the entity and camera views older scene code reads.

_call_via_r3
s32 _call_via_r3(s32, s32, s32, s32)

songs.h
Song and sound effect ids, indices into gSound_SongTable.

static_assert.h
STATIC_ASSERT, a compile-time check that emits nothing.

system.h
The system's routines and globals: interrupts, BIOS sound bias, random numbers and sleep.

tbs_edition.h
Values that differ by patch level or language, chosen once for their code.

types.h
The integer types, TRUE, UNUSED and the fixed-address macros.

s32
signed int s32
Definition types.h:14

u8
unsigned char u8
Definition types.h:11

ui.h
UiWork, the window system's work, and the status screen's cursors.

uiwindow.h
UiWindow, a window's work, and marking its tilemap rows for transfer.

menu.h

runtime.h

vram_block.h
Declares nothing of its own: it only includes the window, battle command, resource and VRAM table hea...

window.h
The window renderer's work.