alchemy-docs/field_8c_source.html

/// @file

/// The field object: the engine of the field and the world map. It draws and

/// animates sprites, keeps the 64 field objects and runs their scripts, moves

/// the player by the keys, loads, draws and scrolls the maps, and answers what

/// the ground is like under a point. field_internal.h holds what the parts

/// share; the parts under field/ are included here in the order their code has

/// in the ROM. Camelot's own files are not recoverable: the ROM shows one

/// object, and these parts are ours, cut where one family ends and the next

/// begins.

///

/// README.md in this folder gives the words, prefixes and spellings the parts

/// use. Where to start:

///

///   Sprites         sprite_draw.c: Sprite_ComposeAnimationFrame,

///                   Render_PlaceProjectedSprite; animation.c:

///                   ResourceObject_Create, AnimationObjects_SelectAnimation

///   Objects         objects.c: FieldObject_Create, ObjectSystem_Initialize;

///                   object_motion.c: Object_UpdateAllThumb,

///                   Object_SetMoveTarget

///   Object scripts  script_commands.c (the SC_ commands of objcmd.h);

///                   player_control.c: FieldObject_UpdatePlayerControl

///   Maps            map_layers.c: Map_LoadLayeredScene,

///                   Map_UpdateLayerScroll; world_map.c:

///                   Map_InitializePerspectiveScene, WorldMap_UpdateView

///   Ground          terrain.c: Map_GetTerrainHeight, Map_CheckObjectStep,

///                   GetWorldMapCollision


#include "field_internal.h"


// The field object's code, in ROM order. Each part is compiled here, as part

// of this one object, never on its own: the order of these includes is the

// order of the code in the ROM.

#include "field/decompress.c"

#include "field/sprite_draw.c"

#include "field/animation.c"

#include "field/objects.c"

#include "field/object_camera.c"

#include "field/object_motion.c"

#include "field/script_commands.c"

#include "field/player_control.c"

#include "field/map_layers.c"

#include "field/world_map.c"

#include "field/map_animation.c"

#include "field/terrain.c"

#include "field/view.c"

#include "field/sprite_viewer.c"

animation.c
Sprites, their animation layers and the resource slots they draw from.

decompress.c
LZ decompression.

objects.c
Field objects: the object pool, dissolving sprites, starting scripts.

view.c
Screen shake, the copied BG row drawer and the ground plane scanlines.

world_map.c
The world map: its perspective view, its tiles, and the still picture of the view BG1 shows while a m...

field_internal.h
What every part of the field object shares: its includes and the few names more than one part uses.

map_animation.c
Timed map effects: tile animation, the blend script, palette cycles.

map_layers.c
Layered maps: loading, drawing and scrolling, and copying cells.

object_camera.c
The object cameras, which place every object's sprite each frame.

object_motion.c
Object motion, each frame, and the first object script commands.

player_control.c
Player control: the configured keys and moving objects by the pad.

script_commands.c
Object script commands: waits, jumps, flags, moves and work values.

sprite_draw.c
Drawing sprites: composing their layers and placing them on screen.

sprite_viewer.c
A debug sprite viewer.

terrain.c
Terrain: ground heights and the collision of cells and the world map.