alchemy-docs/window__internal_8h_source.html

#ifndef ALCHEMY_WINDOW_INTERNAL_H

#define ALCHEMY_WINDOW_INTERNAL_H


/// @file

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

/// macros and the codes of decoded text. window.c includes it before the

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

/// resolves.


#include "unit/window/scales.h"

#include "unit/window/articles.h"

#include "unit/window/text_speed.h"

#include "unit/window/window.h"

#include "unit/window/battle_command.h"

#include "unit/object/object.h"

#include "unit/object/psynergy_effects.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 "text/msg_ids.h"

#include "songs.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 "macros.h"

#include "flags.h"


// Edition-specific text and window layout values.

#if (LANGUAGE == LANGUAGE_SPANISH)

#define ITEM_POSSESSIVE_TEXT_COUNT 2

#else

#define ITEM_POSSESSIVE_TEXT_COUNT 4

#endif


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

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

#define TEXT_ARGUMENT_SPACE ' '

#else

#define TEXT_ARGUMENT_SPACE 143

#endif


#if (LANGUAGE == LANGUAGE_JAPANESE)

#define UI_SPRITE_SPACE_WIDTH 7

#else

#define UI_SPRITE_SPACE_WIDTH 5

#endif


#ifdef MODERN

// In the matching build these calls precede their declarations. Prototypes

// reorder three argument moves for ClearTileAttributesInRect and two for

// PutGlyph in the English image.

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

void UiWindow_ClearTileAttributesInRect(s32 x, s32 y, u32 width, u32 height);

#endif


/// A glyph resource id meaning no glyph resource is loaded.

#define NO_GLYPH_RESOURCE 99


// UiRenderWork owns three message channels, each with four line gaps.

#define UI_MESSAGE_CHANNEL_COUNT 3

#define UI_MESSAGE_LINE_COUNT 4

#define UI_TEXT_DEFAULT_COLOUR 15

#define UI_TEXT_DEFAULT_LINE_SPACING 10

#define UI_TILEMAP_PALETTE 15


// Window animation lengths and the palette slot's unused marker.

#define UI_WINDOW_OPEN_FRAMES 8

#define UI_WINDOW_CLOSE_FRAMES 4

#define UI_PALETTE_SLOT_FREE 999

#define UI_CANVAS_BACKGROUND_WORD 0x44444444


// Scratch capacities are in bytes unless the name says halfwords.

#define UI_NUMBER_BUFFER_SIZE 16

#define UI_BYTE_STRING_BUFFER_SIZE 0x200

#define UI_MESSAGE_NAME_HALFWORDS 24

#define UI_ARGUMENT_SLOT_COUNT 8

#define UI_SELECTION_ENTRY_LIMIT 16

#define UI_AREA_NOTICE_FRAMES 90


/// The control codes of decoded message text (UiRenderWork.entries). Codes

/// from TEXT_SPACE up are characters.

enum {

  TEXT_END = 0,

  TEXT_PAGE = 1, ///< wait for a button, then clear the window for a new page

  TEXT_WAIT_KEY = 2, ///< wait for a button, then close the window

  TEXT_NEWLINE = 3,

  TEXT_PAUSE_LONG = 4,    ///< a 60-frame pause

  TEXT_PAUSE_SHORT = 5,   ///< a 20-frame pause a button can cut short

  TEXT_PAUSE_LONGEST = 6, ///< a 120-frame pause a button can cut short

  TEXT_COLOURS_RESET = 7,

  TEXT_COLOUR = 8,        ///< the next entry is the text colour

  TEXT_OUTLINE = 9,       ///< the next entry is the outline colour

  TEXT_LINE_SPACING = 10, ///< the next entry is the line spacing

  TEXT_WINDOW_STATE = 15, ///< the next entry is the window effect to run

  TEXT_END_ALT = 30,

  TEXT_COMMANDS = 31,

  TEXT_SPACE = 32,

  TEXT_VOICED_MARK = 222,    ///< dakuten

  TEXT_SEMIVOICED_MARK = 223 ///< handakuten

};


// The kana mark drawn with a character, in the top two bits of its code (the

// index into gUiText_MarkGlyphCodes).

#define TEXT_CODE_MARK_SHIFT 14

#define TEXT_CODE_VOICED (1 << TEXT_CODE_MARK_SHIFT)

#define TEXT_CODE_SEMIVOICED (2 << TEXT_CODE_MARK_SHIFT)


/// The window effect a message can start (TEXT_WINDOW_STATE): the window's

/// frame grows by a tile and its text sprites pulse, for the channel's

/// countdown.

#define UI_WINDOW_EFFECT_SWELL 4


/// The heap slot of the battle display's work block (struct BattleDisplayWork),

/// whose window is the battle message window.

enum { HEAP_SLOT_BATTLE_DISPLAY = 37 };


/// The heap block the message decoder routine is copied into to run.

#define TEXT_WORK_BLOCK 50


/// The glyph transfer work in IWRAM (system/iwram.s), which icons are built in.

extern GlyphTransfer *gGlyphWork;


/// Each message context bank's Huffman models and their offsets, which the

/// message catalog built from games/tbs/text defines.

extern const void *const Text_MessageContexts[][2];


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

articles.h

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

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

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.

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

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.

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.

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.

GlyphTransfer
Definition glyph.h:38

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.

text_speed.h

UiWindow_ClearTileAttributesInRect
void UiWindow_ClearTileAttributesInRect(s32 x, s32 y, u32 width, u32 height)
Marks the text tiles under a tilemap rectangle (x, y, width and height in tiles) as no longer shown,...
Definition text_tiles.c:276

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

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.

TEXT_SPACE
@ TEXT_SPACE
Definition window_internal.h:166

TEXT_PAUSE_SHORT
@ TEXT_PAUSE_SHORT
a 20-frame pause a button can cut short
Definition window_internal.h:157

TEXT_WINDOW_STATE
@ TEXT_WINDOW_STATE
the next entry is the window effect to run
Definition window_internal.h:163

TEXT_END
@ TEXT_END
Definition window_internal.h:152

TEXT_PAUSE_LONGEST
@ TEXT_PAUSE_LONGEST
a 120-frame pause a button can cut short
Definition window_internal.h:158

TEXT_OUTLINE
@ TEXT_OUTLINE
the next entry is the outline colour
Definition window_internal.h:161

TEXT_WAIT_KEY
@ TEXT_WAIT_KEY
wait for a button, then close the window
Definition window_internal.h:154

TEXT_COLOURS_RESET
@ TEXT_COLOURS_RESET
Definition window_internal.h:159

TEXT_COMMANDS
@ TEXT_COMMANDS
Definition window_internal.h:165

TEXT_VOICED_MARK
@ TEXT_VOICED_MARK
dakuten
Definition window_internal.h:167

TEXT_PAGE
@ TEXT_PAGE
wait for a button, then clear the window for a new page
Definition window_internal.h:153

TEXT_SEMIVOICED_MARK
@ TEXT_SEMIVOICED_MARK
handakuten
Definition window_internal.h:168

TEXT_END_ALT
@ TEXT_END_ALT
Definition window_internal.h:164

TEXT_NEWLINE
@ TEXT_NEWLINE
Definition window_internal.h:155

TEXT_COLOUR
@ TEXT_COLOUR
the next entry is the text colour
Definition window_internal.h:160

TEXT_LINE_SPACING
@ TEXT_LINE_SPACING
the next entry is the line spacing
Definition window_internal.h:162

TEXT_PAUSE_LONG
@ TEXT_PAUSE_LONG
a 60-frame pause
Definition window_internal.h:156

Text_MessageContexts
const void *const Text_MessageContexts[][2]
Each message context bank's Huffman models and their offsets, which the message catalog built from ga...

HEAP_SLOT_BATTLE_DISPLAY
@ HEAP_SLOT_BATTLE_DISPLAY
Definition window_internal.h:184

gGlyphWork
GlyphTransfer * gGlyphWork
The glyph transfer work in IWRAM (system/iwram.s), which icons are built in.

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