alchemy-docs/farcall_8h_source.html

#ifndef ALCHEMY_FARCALL_H

#define ALCHEMY_FARCALL_H


/// @file

/// Public interfaces to the engine's code banks. Each bank exposes a stable

/// jump table, so another bank can reach its routines beyond Thumb's call

/// range. These headers declare ordinary functions; the ordered assembly tables

/// in src/system/far_call own the entry names and the routines they jump to.

/// For example, UiText_DrawNumberAtOffsetFar is the window bank's entry for

/// UiText_DrawNumberAtOffset. Overlays bind their imported names to these

/// entries in src/system/overlay.inc, using the same 8-byte jump mechanism.

/// A file with a local declaration defines `OWN_<name>` before including this

/// header to keep that declaration in scope.


#include "callback_scheduler.h"

#include "effect_slot.h"

#include "irq.h"

#include "types.h"

#include "edition.h"


struct AffineTransform;

struct AnimationEntry;

struct AnimationMetadata;

struct AnimationObject;

struct BattleActionRecord;

struct BattleEffectArgument;

struct BattleAct;

struct BattleObj;

struct BattleUnit;

struct DispatchObject;

struct EffectLaunch;

struct EffectPosition;

struct EffectSlot;

struct EffectVector;

struct EnemyDefinition;

struct FieldActor;

struct FieldPosition;

struct FxObject;

struct ItemDefinition;

struct LevelUpResult;

struct MenuSprite;

struct MotionObject;

struct ObjectRuntime;

struct PolarOffsetOutput;

struct RenderInput;

struct RenderOutput;

struct SceneEvent;

struct ScenePlacement;

struct ScriptObjectEntry;

struct ShopCursor;

struct SpritePlacement;

struct SpriteScale;

struct SummonDefinition;

struct TransitionActorList;

struct UiWindow;

struct WorldPosition;


// Entries have their target's parameters. Seven keep empty parameter lists

// (no prototype): their callers pass different arguments than the target

// takes, which C89 accepts with no prototype in scope. They are the

// blank-display runners (the entrance in r0), Unit_LearnPsynergyFar (called

// with none), Party_ShowJoinedMessageFar (two), UiTimedNotice_CreateFar,

// Menu_RunWorkspaceResultLoopFar and Runtime_GetBuildStampTimeFar (one

// each). The near call UiWork_ResetCounters is declared the same way in

// unit/window/window.h (UiWindow_Create passes it one).

#include "farcall/runtime.h"

#include "farcall/field.h"

#include "farcall/window.h"

#include "farcall/game.h"

#include "farcall/object.h"

#include "farcall/menu.h"

#include "farcall/shop.h"

#include "farcall/battle.h"

#include "farcall/effect.h"

#include "farcall/scroll.h"

#include "farcall/palette.h"

#include "farcall/blank_run.h"

#include "farcall/blank_load.h"

#include "farcall/sound.h"

#include "farcall/resource.h"


#endif

blank_load.h
The reel-game entry point.

blank_run.h
The display-blanked callback runner.

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

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

effect_slot.h
Effect slots: the particles Psynergy effects move and draw.

battle.h
Battle state, unit motion and presentation services.

effect.h
Battle-effect dispatch, drawing and presentation setup.

field.h
Field actors, movement, map drawing and scene services.

game.h
Party members, items, Djinn and game-state operations.

menu.h
Party menus and their interactive selection screens.

object.h
Scene events, field Psynergy, objects and effect lifecycles.

resource.h
Resource animation metadata lookup.

runtime.h
Frame scheduling, memory, resources and core runtime services.

scroll.h
The scrolling slideshow entry point.

shop.h
Shops, inns and the cursors used by their screens.

sound.h
Audio mixing, playback commands and music-player updates.

window.h
Window construction, text drawing and selection interfaces.

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

palette.h
Title, introduction and splash-screen presentation.

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

AnimationEntry
One animation layer of a sprite: its animation id, frames, running script and timer.
Definition animspr.h:37

AnimationMetadata
An animation's metadata: the sprite's size, scale and offsets, how its frames are drawn and decoded,...
Definition metadata_lookup.h:14

AnimationObject
An animated sprite: its image and shadow, scale, rotation, size and up to four animation layers.
Definition animspr.h:108

BattleAct
An ability's definition, a row of gBattleAction_DefinitionTable: its targeting, kind,...
Definition battle_unit.h:151

BattleActionRecord
A unit's chosen action for the turn: its command, the command's parameter, its target and range,...
Definition battle_session.h:54

BattleEffectArgument
The command shared by an effect's caller, dispatcher and handlers.
Definition battle_effect_argument.h:12

BattleObj
A unit's place on the battlefield: its sprite object, resources and animations, its anchor spot and s...
Definition battle_session.h:16

BattleUnit
A unit in battle: a party member's or an enemy's stats, Psynergy, items, Djinn and ailments.
Definition battle_unit.h:178

DispatchObject
A field object as the object dispatcher's far calls take it.
Definition object_dispatch.h:12

EffectPosition
A point projected onto the screen, with its depth.
Definition effect_step.h:46

EffectSlot
A particle a Psynergy effect moves and draws: its sprite, its position and target,...
Definition effect_slot.h:18

EffectVector
A world position, as Camera_WorldToScreen converts it to the screen.
Definition battle.h:73

EnemyDefinition
An enemy's definition: its level and stats, items, element preset, the actions it chooses from and it...
Definition character.h:89

FieldActor
A field actor: a person or thing on the field with a position, motion toward a target,...
Definition field_obj.h:30

FieldPosition
A position on the field.
Definition field_runtime.h:195

ItemDefinition
An item's definition: its price, type, who can equip it, its bonuses and unleash, its effects and the...
Definition item.h:104

LevelUpResult
A level up's result: the level reached, an ability learned and the gain in each stat.
Definition character.h:136

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

MotionObject
An effect object that moves and draws one sprite: its position, scale, velocity and target,...
Definition motobj.h:20

ObjectRuntime
One of the 64 field objects in the object pool (heap slot 5): its script, position,...
Definition object_runtime.h:14

RenderInput
A 16-byte record of a rectangle.
Definition render_input.h:15

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

SceneEvent
A scene event: its kind and detail, the trigger it answers, its condition and its value (a message or...
Definition field_scene.h:118

ScenePlacement
An actor a scene places: its sprite, the condition for placing it, how it behaves,...
Definition field_scene.h:81

ScriptObjectEntry
A field object as the script commands' overlap checks see it.
Definition script_object_entry.h:12

ShopCursor
Cursor that approaches its target, shared by shop, name entry and settings.
Definition cursor.h:13

SpritePlacement
A sprite's screen position and its two vertical offsets, in 16.16 pixels.
Definition render_placement.h:11

SpriteScale
Horizontal and vertical sprite scale; 0x10000 is the original size.
Definition render_placement.h:52

SummonDefinition
A summon: its name's message and the Djinn of each element it needs.
Definition battle_summon.h:38

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

WorldPosition
A position on the world map, as its walkability check reads it.
Definition map.h:74

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