alchemy-docs/battle__command__internal_8h_source.html

#ifndef ALCHEMY_BATTLE_COMMAND_INTERNAL_H

#define ALCHEMY_BATTLE_COMMAND_INTERNAL_H


/// @file

/// What every part of the menu object shares: its includes, edition values,

/// macros and the link round state. battle_command.c includes it before the

/// parts, and each part includes it too, so that a part read on its own still

/// resolves.


#include "render_placement.h"

#include "unit/window/window.h"

#include "unit/window/battle_command.h"

#include "unit/object/object.h"

#include "unit/window/glyph_arm.h"

#include "unit/runtime/runtime.h"

#include "types.h"

#include "edition.h"

#include "window.h"

#include "battle.h"

#include "keystate.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 "mem.h"

#include "callback_scheduler.h"

#include "dma.h"

#include "tbs_edition.h"

#include "iwram_call.h"

#include "io_reg.h"

#include "global_cells.h"

#include "menu_list.h"

#include "render_input.h"

#include "resource.h"

#include "output.h"

#include "glyph.h"

#include "game_state.h"

#include "battle_work.h"

#include "heap_state.h"

#include "text_font.h"

#include "text_render_runtime.h"

#include "fixed_math.h"

#include "runtime_interfaces.h"

#include "resource_ids.h"

#include "ramcode.h"

#include "affine.h"

#include "battle_party.h"

#include "scene.h"

#include "text_reader.h"

#include "lib.h"

#include "battle_unit.h"

#include "battle_system.h"

#include "item.h"

#include "vram_block.h"

#include "select.h"

#include "node_chain.h"

#include "text/msg_ids.h"

#include "songs.h"

#include "flags.h"

#include "static_assert.h"

#include "field_event.h"

#include "b5_context.h"

#include "battle_type.h"

#include "uiflow.h"

#include "owner_state.h"

#include "workspace_options.h"

#include "ram_buffer.h"

#include "party_state.h"

#include "save_state.h"

#include "irq.h"

#include "character_menu.h"

#include "animspr.h"

#include "four_object_motion.h"

#include "uiwindow.h"

#include "io_write_queue.h"

#include "map_scroll.h"

#include "vram_tab.h"

#include "djinn_preview.h"

#include "ui.h"

#include "motobj.h"

#include "effect_step.h"

#include "resource_menu.h"

#include "battle_summon.h"

#include "serial_runtime.h"

#include "battle_effect_work.h"

#include "shop.h"

#include "display_transition.h"

#include "frame.h"

#include "unit/object/psynergy_effects.h"

#include "unit/window/scales.h"


#ifdef MODERN

// The menu object calls these window functions with no prototype in scope, as

// its bytes need (unit/window/window.h says why for each); a current GCC gets

// them here.

void RenderOutput_AppendToList(struct RenderOutputList *list,

                               struct RenderOutput *node);

struct UiChannelSlot *UiText_QueueRenderEntries(struct UiWindow *window,

                                                s32 entry, s32 x, s32 y,

                                                u16 *spacing, s32 flags);

void UiText_RenderWideStringInWindow(s16 *text, struct UiWindow *window, s32 x,

                                     s32 y);

void UiWindow_PutGlyph(struct UiWindow *win, u32 tile, u32 x, u32 y, s32 mode);

void UiText_DrawPrefixedNumberAtOffset(s32 value, const struct UiWindow *work,

                                       s32 offsetX, s32 offsetY, s32 variant);

#endif


// Edition-specific text and window layout values.

#if !TBS_PATCH_1

#define DJINN_PREVIEW_VITALS_X 4

#else

#define DJINN_PREVIEW_VITALS_X 5

#endif


#if !TBS_PATCH_1

#define DJINN_PREVIEW_STAT_DIGIT_OFFSET 7

#define DJINN_PREVIEW_STAT_X 4

#else

#define DJINN_PREVIEW_STAT_DIGIT_OFFSET 8

#define DJINN_PREVIEW_STAT_X 6

#endif


#if !TBS_PATCH_1

#define DJINN_PREVIEW_HELP_X 40

#else

#define DJINN_PREVIEW_HELP_X 24

#endif


#if (LANGUAGE == LANGUAGE_SPANISH) || (LANGUAGE == LANGUAGE_FRENCH) ||         \

    (LANGUAGE == LANGUAGE_ITALIAN)

#define PSYNERGY_COST_SECOND_TILE 0xf005

#else

#define PSYNERGY_COST_SECOND_TILE 0xf01e

#endif


#if (LANGUAGE == LANGUAGE_FRENCH)

#define OWNER_STATUS_LEVEL_X 51

#else

#define OWNER_STATUS_LEVEL_X 56

#endif


#if TBS_PATCH_1

#define SUMMON_MENU_WINDOW_X 13

#define SUMMON_MENU_WINDOW_WIDTH 17

#else

#define SUMMON_MENU_WINDOW_X 16

#define SUMMON_MENU_WINDOW_WIDTH 14

#endif


#if TBS_PATCH_1

#define BATTLE_CLASS_ICON_X 0

#else

#define BATTLE_CLASS_ICON_X 4

#endif


#if (LANGUAGE == LANGUAGE_FRENCH)

#define BATTLE_COMMAND_NAME_X 14

#else

#define BATTLE_COMMAND_NAME_X 16

#endif


#if TBS_PATCH_1

#define BATTLE_SUMMON_ICON_X 80

#else

#define BATTLE_SUMMON_ICON_X 104

#endif


#if TBS_PATCH_1

#define BATTLE_SUMMON_WINDOW_WIDTH 17

#else

#define BATTLE_SUMMON_WINDOW_WIDTH 14

#endif


#if TBS_PATCH_1

#define BATTLE_SUMMON_ELEMENT_COLUMN 13

#define BATTLE_SUMMON_COST_COLUMN 14

#else

#define BATTLE_SUMMON_ELEMENT_COLUMN 10

#define BATTLE_SUMMON_COST_COLUMN 11

#endif


#if (LANGUAGE == LANGUAGE_GERMAN) || (LANGUAGE == LANGUAGE_SPANISH) ||         \

    (LANGUAGE == LANGUAGE_FRENCH) || (LANGUAGE == LANGUAGE_ITALIAN)

#define BATTLE_ITEM_WINDOW_WIDTH 16

#else

#define BATTLE_ITEM_WINDOW_WIDTH 15

#endif


#if (LANGUAGE == LANGUAGE_ENGLISH) || (LANGUAGE == LANGUAGE_GERMAN) ||         \

    (LANGUAGE == LANGUAGE_ITALIAN)

#define RESOURCE_MODE0_WINDOW_X 7

#define RESOURCE_MODE0_WINDOW_WIDTH 17

#elif (LANGUAGE == LANGUAGE_SPANISH)

#define RESOURCE_MODE0_WINDOW_X 5

#define RESOURCE_MODE0_WINDOW_WIDTH 21

#elif (LANGUAGE == LANGUAGE_FRENCH)

#define RESOURCE_MODE0_WINDOW_X 5

#define RESOURCE_MODE0_WINDOW_WIDTH 22

#else

#define RESOURCE_MODE0_WINDOW_X 9

#define RESOURCE_MODE0_WINDOW_WIDTH 13

#endif


#if (LANGUAGE == LANGUAGE_GERMAN)

#define RESOURCE_MODE1_WINDOW_X 1

#define RESOURCE_MODE1_WINDOW_WIDTH 28

#else

#define RESOURCE_MODE1_WINDOW_X 3

#define RESOURCE_MODE1_WINDOW_WIDTH 25

#endif


#if (LANGUAGE == LANGUAGE_ENGLISH) || (LANGUAGE == LANGUAGE_GERMAN)

#define TRANSFER_METHOD_WINDOW_X 6

#define TRANSFER_METHOD_WINDOW_WIDTH 18

#elif (LANGUAGE == LANGUAGE_SPANISH)

#define TRANSFER_METHOD_WINDOW_X 4

#define TRANSFER_METHOD_WINDOW_WIDTH 21

#elif (LANGUAGE == LANGUAGE_FRENCH) || (LANGUAGE == LANGUAGE_ITALIAN)

#define TRANSFER_METHOD_WINDOW_X 5

#define TRANSFER_METHOD_WINDOW_WIDTH 20

#else

#define TRANSFER_METHOD_WINDOW_X 9

#define TRANSFER_METHOD_WINDOW_WIDTH 13

#endif


#if TBS_PATCH_1

#define TRANSFER_METHOD_LABEL_X 2

#else

#define TRANSFER_METHOD_LABEL_X 0

#endif


#if (LANGUAGE == LANGUAGE_ENGLISH) || (LANGUAGE == LANGUAGE_SPANISH) ||        \

    (LANGUAGE == LANGUAGE_FRENCH) || (LANGUAGE == LANGUAGE_ITALIAN)

#define TRANSFER_HELP_WINDOW_X 1

#define TRANSFER_HELP_WINDOW_WIDTH 28

#elif (LANGUAGE == LANGUAGE_GERMAN)

#define TRANSFER_HELP_WINDOW_X 0

#define TRANSFER_HELP_WINDOW_WIDTH 30

#else

#define TRANSFER_HELP_WINDOW_X 5

#define TRANSFER_HELP_WINDOW_WIDTH 21

#endif


#if (LANGUAGE == LANGUAGE_GERMAN)

#define ENTRY11_COMMAND_LABEL_WIDTH 8

#elif TBS_PATCH_1

#define ENTRY11_COMMAND_LABEL_WIDTH 7

#else

#define ENTRY11_COMMAND_LABEL_WIDTH 6

#endif


#if TBS_PATCH_1

#define ENTRY19_COMMAND_LABEL_WIDTH 10

#else

#define ENTRY19_COMMAND_LABEL_WIDTH 8

#endif


/// OAM attribute bits a sprite output is created with: the size field of

/// attribute 1 (bits 30-31 of the first word). A square sprite of size 1 is

/// 16x16 pixels, of size 2 32x32.

#define OUTPUT_SIZE_16X16 0x40000000

#define OUTPUT_SIZE_32X32 0x80000000


// The two portrait slots of the UI work, and the palette the first one uses

// (the second uses the next).

#define PORTRAIT_SLOT_COUNT 2

#define PORTRAIT_PALETTE 14

#define PORTRAIT_SLOT_EMPTY 999


// The battle menus' message buffers, in halfwords, and the copier that fills

// them.

#if TBS_PATCH_1

#define BATTLE_MENU_MESSAGE_CAPACITY 52

#define BATTLE_MENU_MESSAGE_COPY UiText_CopyMessageString

#else

#define BATTLE_MENU_MESSAGE_CAPACITY 32

#define BATTLE_MENU_MESSAGE_COPY UiText_DecodeMessage

#endif


/// Tiles the battle lists draw over their window's top edge: the page numbers

/// and arrows, and the summon list's element icon.

enum {

  SUMMON_ELEMENT_TILE = 0x5001,       ///< Element icon

  LIST_TILE_PAGE_NUMBER = 0xf301,     ///< Page number

  LIST_TILE_PAGE_NUMBER_LIT = 0xf30b, ///< Current page number

  LIST_TILE_PAGES_LEFT = 0xf334,      ///< Left arrow

  LIST_TILE_PAGES_RIGHT = 0xf335      ///< Right arrow

};


#define BATTLE_OK 0x80 ///< flags: usable in battle


/// The command icon row's work block and one of its icons: pictures.c loads

/// the icons, command_row.c runs the row.

struct SelectionEntry {

  struct MenuSprite sprite;

  u16 resource, unused;

  s32 posX, posY;

  s32 kind;

};


/// The command icon row's work block: the icons' shared palette, up to six

/// icons, the label window, the pulsing icon's transform and the selection.

struct SelectionWork {

  struct GlyphPalette palette;

  struct SelectionEntry entries[6];

  struct UiWindow *window;

  s32 iconCount;

  struct AffineTransform affine;

  s32 affineIndex, selectedIndex, drawnIndex;

  s32 commandKinds[6];

};


// The Djinn menu's blinking tile, and where each element's Djinn count sits in

// the party status window, in tiles, to blink while it has Djinn on standby

// (windata.s).

extern const u8 gDjinnMenu_BlinkTile[32];

extern const u8 gDjinnMenu_ElementXOffsets[4];

extern const u8 gDjinnMenu_ElementYOffsets[4];


#endif

affine.h
Sprite rotation and scale, and the affine matrices handed out each frame.

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

b5_context.h
B5Context, the object context a battle routine reads; most of its fields are still unnamed.

gDjinnMenu_BlinkTile
const u8 gDjinnMenu_BlinkTile[32]

LIST_TILE_PAGES_RIGHT
@ LIST_TILE_PAGES_RIGHT
Right arrow.
Definition battle_command_internal.h:291

SUMMON_ELEMENT_TILE
@ SUMMON_ELEMENT_TILE
Element icon.
Definition battle_command_internal.h:287

LIST_TILE_PAGE_NUMBER
@ LIST_TILE_PAGE_NUMBER
Page number.
Definition battle_command_internal.h:288

LIST_TILE_PAGES_LEFT
@ LIST_TILE_PAGES_LEFT
Left arrow.
Definition battle_command_internal.h:290

LIST_TILE_PAGE_NUMBER_LIT
@ LIST_TILE_PAGE_NUMBER_LIT
Current page number.
Definition battle_command_internal.h:289

gDjinnMenu_ElementYOffsets
const u8 gDjinnMenu_ElementYOffsets[4]

gDjinnMenu_ElementXOffsets
const u8 gDjinnMenu_ElementXOffsets[4]

battle_effect_work.h
BattleEffectWork, the running battle effect's work, and its animation objects.

battle_party.h
Which units are in a battle, and the Djinn recovery list.

battle_summon.h
Summons and the battle sprite definitions of the enemy classes.

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

battle_work.h
BattleWork, the battle's own work, and the battle display work.

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.

display_transition.h
The display transition's frames, windows and state.

djinn_preview.h
The Djinn preview's sprites and arrow tiles.

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

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

effect_step.h
EffectStep and EffectPosition, the positions effects move through.

field_event.h
The scene script layer: the engine services a scene's events call, declared once (Engine_EventBegin,...

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.

frame.h
The frame loop's globals: lag counts, the CPU load display and the VBlank flags.

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.

glyph.h
Font glyphs and their palettes.

glyph_arm.h

UiText_RenderWideStringInWindow
void UiText_RenderWideStringInWindow(s16 *text, struct UiWindow *window, s32 x, s32 y)
Draws a zero-terminated string of 16-bit character codes into a window's tilemap at tile (x,...
Definition glyphs.c:409

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

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

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

io_write_queue.h
The register write queue that VBlank carries out after each finished frame.

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

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

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.

map_scroll.h
The map layers' scroll work and the background scroll values.

mem.h
The heaps: allocating and freeing blocks.

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

minigame.h
The reel game's title lettering.

motobj.h
MotionObject, an effect object that moves and draws one sprite.

node_chain.h
NodeChain, a chain of menu nodes.

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

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

party_state.h
Declares nothing of its own: it only includes static_assert.h and game_state.h.

psynergy_effects.h

ram_buffer.h
The work pointers in the gWorkSlot table, by name.

ramcode.h
Copying ARM routines to RAM to run them there.

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.

resource_ids.h
Resource numbers, named where their contents are known.

resource_menu.h
The resource menu's entries and work.

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

save_state.h
The save workspace: slot headers and summaries.

scales.h

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

select.h
The selection screen's sprites and nodes.

serial_runtime.h
The link cable's runtime: serial packets, registers and transfer state.

shop.h
ShopRuntime, a shop's work, and the shop screen's tiles.

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

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

AffineTransform
A sprite's rotation and scale: scales in 8.8 fixed point (0x100 is full size), the angle in 1/65536 t...
Definition affine.h:13

GlyphPalette
A compact palette shared by a selection's command icons: the slot each icon colour was given,...
Definition glyph.h:19

MenuSprite
A menu sprite: a list link and its OAM attributes, as two words or as fields.
Definition menu_list.h:24

RenderOutputList
A list of render outputs: its first output and the link to append after.
Definition render_input.h:81

RenderOutput
A render output: a sprite in a window's output list (a character, an icon or a portrait),...
Definition render_input.h:62

SelectionEntry
The command icon row's work block and one of its icons: pictures.c loads the icons,...
Definition battle_command_internal.h:298

SelectionEntry::kind
s32 kind
Definition battle_command_internal.h:302

SelectionEntry::resource
u16 resource
Definition battle_command_internal.h:300

SelectionEntry::sprite
struct MenuSprite sprite
Definition battle_command_internal.h:299

SelectionEntry::posX
s32 posX
Definition battle_command_internal.h:301

SelectionEntry::unused
u16 unused
Definition battle_command_internal.h:300

SelectionEntry::posY
s32 posY
Definition battle_command_internal.h:301

SelectionWork
The command icon row's work block: the icons' shared palette, up to six icons, the label window,...
Definition battle_command_internal.h:307

SelectionWork::palette
struct GlyphPalette palette
Definition battle_command_internal.h:308

SelectionWork::commandKinds
s32 commandKinds[6]
Definition battle_command_internal.h:314

SelectionWork::iconCount
s32 iconCount
Definition battle_command_internal.h:311

SelectionWork::entries
struct SelectionEntry entries[6]
Definition battle_command_internal.h:309

SelectionWork::window
struct UiWindow * window
Definition battle_command_internal.h:310

SelectionWork::affineIndex
s32 affineIndex
Definition battle_command_internal.h:313

SelectionWork::drawnIndex
s32 drawnIndex
Definition battle_command_internal.h:313

SelectionWork::selectedIndex
s32 selectedIndex
Definition battle_command_internal.h:313

SelectionWork::affine
struct AffineTransform affine
Definition battle_command_internal.h:312

UiChannelSlot
A text channel, one of three, which types decoded text into a window a few characters a frame and run...
Definition uiwindow.h:43

UiChannelSlot::y
u16 y
pen, 8.8 fixed-point pixels
Definition uiwindow.h:46

UiChannelSlot::flags
u16 flags
nonzero keeps the window's size from page to page
Definition uiwindow.h:60

UiChannelSlot::x
u16 x
pen, 8.8 fixed-point pixels
Definition uiwindow.h:45

UiChannelSlot::spacing
u16 spacing[4]
Extra advance per line, in 1/256 pixels: after every character in Japanese, after a space in the othe...
Definition uiwindow.h:49

UiChannelSlot::work
struct UiWindow * work
the window typed into; NULL when free
Definition uiwindow.h:44

UiChannelSlot::entry
u16 entry
next code in UiRenderWork.entries
Definition uiwindow.h:51

UiWindow
A window: a framed rectangle of the tilemap with its sprite outputs, its opening or closing animation...
Definition uiwindow.h:11

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.

text_font.h
The kanji glyphs and the text marks drawn with characters.

text_reader.h
TextReader, a cursor through message text.

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

UiText_DrawPrefixedNumberAtOffset
void UiText_DrawPrefixedNumberAtOffset(s32 value, const struct UiWindow *work, s32 offsetX, s32 offsetY, s32 variant)
Draws a four-digit number after a two-glyph sign (window tiles 0x1d and 0x1e, or 0x1f and 0x1e with v...
Definition text_tiles.c:689

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

s32
signed int s32
Definition types.h:14

u32
unsigned int u32
Definition types.h:15

s16
signed short s16
Definition types.h:12

u16
unsigned short u16
Definition types.h:13

u8
unsigned char u8
Definition types.h:11

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

uiflow.h
Declares nothing of its own: it only includes edition.h and uiwindow.h.

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

object.h

runtime.h

battle_command.h

window.h

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

vram_tab.h
The sprite VRAM block cache and its owners.

UiWindow_PutGlyph
void UiWindow_PutGlyph(struct UiWindow *win, u32 tile, u32 x, u32 y, s32 mode)
Puts a character into a window's tilemap as a tile at tile (x, y) of its interior.
Definition sprites.c:187

window.h
The window renderer's work.

RenderOutput_AppendToList
void RenderOutput_AppendToList(struct RenderOutputList *list, struct RenderOutput *node)
Adds a render output to the end of a list; NULL lists are ignored.
Definition windows.c:478

UiText_QueueRenderEntries
struct UiChannelSlot * UiText_QueueRenderEntries(struct UiWindow *window, s32 entry, s32 x, s32 y, u16 *spacing, s32 flags)
Starts a free message channel typing the decoded text that begins at entry into window,...
Definition windows.c:515

workspace_options.h
The options screen's work and the selection work.