alchemy-docs/battle__internal_8h_source.html

#ifndef ALCHEMY_BATTLE_INTERNAL_H

#define ALCHEMY_BATTLE_INTERNAL_H


/// @file

/// What every part of the battle object shares: its includes, in their

/// original order, and the names two or more parts use. battle.c includes it

/// before the parts, and each part includes it too, so that a part read on

/// its own still resolves. It places no bytes.


#include "vram_tab.h"

#include "item_ids.h"

#include "window.h"

#include "unit/battle/battle.h"

#include "unit/object/object.h"

#include "unit/runtime/runtime.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 "types.h"

#include "owner_state.h"

#include "edition.h"

#include "io_reg.h"

#include "battle_unit.h"

#include "game_state.h"

#include "battle_system.h"

#include "text/msg_ids.h"

#include "mem.h"

#include "resource_ids.h"

#include "callback_scheduler.h"

#include "fixed_point_position.h"

#include "iwram_call.h"

#include "global_cells.h"

#include "battle_display.h"

#include "battle_message.h"

#include "battle_party.h"

#include "battle_intro.h"

#include "inventory.h"

#include "dma.h"

#include "scene.h"

#include "battle_work.h"

#include "battle_type.h"

#include "battle_summon.h"

#include "tbs_edition.h"

#include "serial_runtime.h"

#include "ram_buffer.h"

#include "party_state.h"

#include "battle_command.h"

#include "resource.h"

#include "heap_state.h"

#include "flags.h"

#include "ability_ids.h"

#include "menu_list.h"

#include "audio_engine_symbols.h"

#include "ui.h"

#include "battle_calc.h"

#include "objdisp.h"

#include "motobj.h"

#include "battle_status_icon.h"

#include "animspr.h"

#include "field_event.h"

#include "metadata_lookup.h"

#include "fixed_math.h"

#include "battle_motion.h"

#include "effect_step.h"

#include "battle_escape.h"

#include "battle_target.h"

#include "battle_obj.h"

#include "battle_event.h"

#include "project.h"

#include "battle_random.h"

#include "irqlock.h"

#include "transform.h"

#include "battle_effect.h"

#include "battle_effect_work.h"

#include "character.h"

#include "io_write_queue.h"

#include "item.h"

#include "irq.h"

#include "vram_block.h"

#include "owner_value.h"

#include "songs.h"

#include "ramcode.h"

#include "map_scroll.h"

#include "iowrite.h"

#include "battle_formation.h"

#include "b5_context.h"

#include "frame.h"

#include "unit/object/psynergy_effects.h"

#include "macros.h"


/// The battle's windows: window 0 shows BG0 to BG2, sprites and blending,

/// window 1 BG0, BG2, sprites and blending, and outside them only BG0 and

/// blending.

#define BATTLE_WININ                                                           \

  (WININ_WIN0_BG0 | WININ_WIN0_BG1 | WININ_WIN0_BG2 | WININ_WIN0_OBJ |         \

   WININ_WIN0_CLR | WININ_WIN1_BG0 | WININ_WIN1_BG2 | WININ_WIN1_OBJ |         \

   WININ_WIN1_CLR)

#define BATTLE_WINOUT (WINOUT_WIN01_BG0 | WINOUT_WIN01_CLR | WINOUT_WINOBJ_ALL)


/// The battle background's colours: BG palettes 6 to 13, filled from

/// BattleWork.palette, darkened or not.

#define BATTLE_BG_PALETTE ((u16 *)&BG_PLTT_COLOR(6, 0))


/// The opening curtain's tiles: 4-bit tiles 128 to 136 of character block 1,

/// which BG1 shows from its map in screen block 12.

#define CURTAIN_TILE(n) (BG_CHAR_BLOCK(1) + (128 + (n)) * TILE_SIZE_4BPP)


/// BG1 during a battle: 256 colours, priority 3, its map in screen block 31.

#define BATTLE_BG1CNT                                                          \

  (BGCNT_PRIORITY(3) | BGCNT_256_COLORS | BGCNT_SCREEN_BASE(31))


// The kinds of argument a message's placeholders take, for

// UiWork_PushValueSlotFar: a unit's name, an item's, a class's, an

// ability's, and a number.

#define VALUE_UNIT_NAME 1

#define VALUE_ITEM_NAME 2

#define VALUE_CLASS_NAME 3

#define VALUE_ABILITY_NAME 4

#define VALUE_NUMBER 5


/// Unit ids from 128 are the enemies'; in a link battle the opponent's party

/// takes the first three.

#define FIRST_ENEMY_UNIT 128

#define LINK_PARTY_SIZE 3


/// The party fights four at a time, three in a link battle; six enemies at

/// most, three in a link battle.

#define PARTY_BATTLE_SIZE 4

#define ENEMY_BATTLE_SIZE 6


#define ABILITY_ATTACK 1 ///< the ability "Attack"

#define ALLY_MAX 7       ///< the last party member's unit id


/// An enemy's class id is its row of enemies.tsv plus 8 (Enemy_GetDefinition);

/// class ids 0 to 7 are the party's. A formation lists its members by row.

#define ENEMY_CLASS_FIRST 8


/// The game flag of an enemy class the party has defeated, set by

/// BattleEnemy_RecordDefeat outside the monster battles; the monster battles

/// choose only formations of defeated enemies (BattleFormation_AverageLevel).

#define ENEMY_DEFEATED_FLAG(classId) ((classId) + 0x600)


/// The length of a unit's name, its terminator excluded.

#define UNIT_NAME_LENGTH 14


/// This console's number in a link session (SIOCNT bits 4 and 5, which the

/// hardware sets in multi-player mode): 0 for the parent, 1 for the child.

#define SIO_MULTI_PLAYER_ID() ((REG_SIOCNT << 26) >> 30)


/// gLinkStatus: both consoles are connected.

#define LINK_BOTH_CONNECTED 3


/// The frames a link battle tolerates without a connection before it gives

/// up.

#define LINK_MAX_MISSED_FRAMES 24


/// The Djinn recovery list's two tables (Djinn_GetRecoveryTableFar): the

/// party's and the link opponent's.

#define DJINN_RECOVERY_PARTY 0

#define DJINN_RECOVERY_OPPONENT 1


/// DjinnRecoveryEntry.turns of a Djinni waiting for the battle to end.

#define DJINN_RECOVERY_AFTER_BATTLE -1


#define DJINN_PER_ELEMENT 20


/// BattleWork.battleType, from the enemy formation

/// (BattleFormation_BuildEnemyList): the random formations stand left to right

/// in the order they were drawn, any other is laid out from the centre.

#define FORMATION_SHUFFLED 0

#define FORMATION_INTERLEAVED 1


/// The two battle sprites whose next sprite is loaded with them (into a

/// second free place), the pass after them loading animation + 1.

#define SPRITE_WITH_SECOND_PART_A 476

#define SPRITE_WITH_SECOND_PART_B 483


/// The inventory's weapon slot, for Inventory_FindEquippedFar.

#define EQUIP_WEAPON 1


// MotionObject.recordStorageKind's low four bits: no sprite, one sprite in

// records, or records pointing to a table of up to four.

#define RECORDS_NONE 0

#define RECORDS_SINGLE 1

#define RECORDS_TABLE 2

#define RECORDS_KIND_MASK 15

#define RECORDS_TABLE_SIZE 4


/// BattleUnit.poison: the poison takes a tenth of the maximum HP at the end of

/// each turn, deadly poison a fifth.

#define POISON_NORMAL 1

#define POISON_DEADLY 2


/// BattleUnit.guardLevel: Defend and Granite halve the damage, Total Defense

/// and Flash cut it to a tenth.

#define GUARD_DEFEND 1

#define GUARD_TOTAL_DEFENSE 2


/// BattlePlan.outcome: how BattlePresentation_DispatchAction shows the

/// action, set by BattleCommand_BuildPlan from the ability

/// (gBattle_ActionStatus where it gives one).

enum BattlePlanStaging {

  PLAN_SHOW_MESSAGES = 1,   ///< no animation: each target's events only

  PLAN_SHOW_ATTACK = 2,     ///< the actor runs up and strikes

  PLAN_SHOW_CAST = 3,       ///< Psynergy, and Venus, Mercury, Mars, Jupiter

  PLAN_SHOW_ITEM = 4,       ///< an item

  PLAN_SHOW_SUMMON = 5,     ///< the larger summons, the actor hidden

  PLAN_SHOW_DJINNI = 6,     ///< a Djinni with no attack (Granite, Quartz...)

  PLAN_SHOW_FLEE = 7,       ///< a unit runs

  PLAN_SHOW_ENEMY_CAST = 8, ///< an enemy's Psynergy

  PLAN_SHOW_FULL_SCREEN = 9 ///< Gaia, Rockfall, Procne and their kin

};


// BattlePlan.presentationFlags: the effect's kind in the low twelve bits and

// its strength (a double or triple blow) above them; then how the effect is

// staged.

#define STAGING_KIND_MASK 0xfff

#define STAGING_VARIANT_MASK 0x3000

#define STAGING_VARIANT_SHIFT 12

#define STAGING_BY_ID_RANGE 0x4000 ///< BattleFx_DispatchByIdRangeFar

#define STAGING_SCENE 0x8000       ///< BattleFx_RunSceneEffectFar, actor's view

#define STAGING_ON_DOWNED 0x10000  ///< shown on downed targets too (revivals)

#define STAGING_OTHER_SIDE 0x20000 ///< played from the other side


/// More of BattlePlan.presentationFlags: the camera takes the other side's

/// view (an enemy's cast a view of its own), or turns right round.

#define STAGING_VIEW_ACROSS 0x40000

#define STAGING_VIEW_REVERSED 0x80000


// ItemDefinition.useType: what using an item in battle does to it.

#define ITEM_USE_CONSUMED 1  ///< one is used up

#define ITEM_USE_MAY_BREAK 2 ///< breaks one time in eight

#define ITEM_USE_EMPTIES 4   ///< Hermes' Water leaves an Empty Bottle


// BattleAct.targetMode: whom an ability may target, from its user's view.

#define TARGET_MODE_NONE 0

#define TARGET_MODE_FOES 1

#define TARGET_MODE_ALLIES 2

#define TARGET_MODE_SELF 4


/// BattleActionRecord.target of an action that needs none: a held unit's

/// lost turn (the enemies' and the party's), and an enemy's attack in auto

/// battle, which picks a party place.

#define TARGET_NONE_ENEMY 0x100

#define TARGET_NONE_PARTY 0x180


/// The camera's yaw while a party member acts, and while an enemy does.

#define YAW_PARTY_TURN 0x2000

#define YAW_ENEMY_TURN -0x2000


/// REG_BLDCNT: blend the semi-transparent sprites (OBJ mode 1) over every

/// layer, to fade them.

#define BLEND_SPRITES_OVER_ALL (BLDCNT_EFFECT_BLEND | BLDCNT_TGT2_ALL)


/// The keys that take the player on past a message: A, B, L and R.

#define KEY_ADVANCE (KEY_A | KEY_B | KEYS_SHOULDERS)


#endif

ability_ids.h
Ability numbers, named from the English release.

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

audio_engine_symbols.h
The sound driver's command masks, cue controls and the routines and globals it shares with the engine...

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

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

battle_command.h
The battle command names: auto battle and the battle options (aliases of debug and key globals),...

battle_display.h
The battle camera and the presentation's transition, background and affine work.

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

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

battle_escape.h
Declares nothing of its own: it only includes edition.h, battle_session.h and types....

battle_event.h
The battle event queue: the events BattleEvPush queues and the playback phases that play them.

battle_formation.h
The enemy formation records.

BattlePlanStaging
BattlePlanStaging
BattlePlan.outcome: how BattlePresentation_DispatchAction shows the action, set by BattleCommand_Buil...
Definition battle_internal.h:209

PLAN_SHOW_ATTACK
@ PLAN_SHOW_ATTACK
the actor runs up and strikes
Definition battle_internal.h:211

PLAN_SHOW_CAST
@ PLAN_SHOW_CAST
Psynergy, and Venus, Mercury, Mars, Jupiter.
Definition battle_internal.h:212

PLAN_SHOW_ENEMY_CAST
@ PLAN_SHOW_ENEMY_CAST
an enemy's Psynergy
Definition battle_internal.h:217

PLAN_SHOW_FLEE
@ PLAN_SHOW_FLEE
a unit runs
Definition battle_internal.h:216

PLAN_SHOW_ITEM
@ PLAN_SHOW_ITEM
an item
Definition battle_internal.h:213

PLAN_SHOW_DJINNI
@ PLAN_SHOW_DJINNI
a Djinni with no attack (Granite, Quartz...)
Definition battle_internal.h:215

PLAN_SHOW_FULL_SCREEN
@ PLAN_SHOW_FULL_SCREEN
Gaia, Rockfall, Procne and their kin.
Definition battle_internal.h:218

PLAN_SHOW_MESSAGES
@ PLAN_SHOW_MESSAGES
no animation: each target's events only
Definition battle_internal.h:210

PLAN_SHOW_SUMMON
@ PLAN_SHOW_SUMMON
the larger summons, the actor hidden
Definition battle_internal.h:214

battle_intro.h
Who strikes first as a battle opens.

battle_message.h
Declares nothing of its own: it only includes types.h and text/msg_ids.h.

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

battle_obj.h
Actor_Place, which places a battle object for a unit.

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

battle_random.h
gBattleRandomSeed, the battle's random seed.

battle_status_icon.h
Declares nothing of its own: it only includes edition.h and battle_session.h.

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_target.h
Declares nothing of its own: it only includes edition.h, battle_session.h and types....

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.h
The definitions of characters, classes, Djinn and enemies, and a level up's result.

debug.h
The engine calls the debug menus import, and their palette swatch 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.

fixed_point_position.h
FixedPointPosition, a position in 16.16 fixed point.

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

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.

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.

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.

iowrite.h
Io_Write16, a 16-bit write to a register or memory.

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

irqlock.h
Saving, disabling and restoring the interrupt master enable.

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.

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.

metadata_lookup.h
Animation metadata and its lookup by resource.

minigame.h
The reel game's title lettering.

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

objdisp.h
The object dispatcher's forward declaration.

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

owner_value.h
Declares nothing of its own: it only includes types.h, edition.h and farcall.h.

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

project.h
The 3D projection.

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.

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

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

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

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

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.

transform.h
The 3D transform and its stack.

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

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

battle.h

object.h

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

window.h
The window renderer's work.