map.h

Go to the documentation of this file.

 
#ifndef OPENSNES_MAP_H
#define OPENSNES_MAP_H
 
#include <snes/types.h>
 
/*============================================================================
 * Tile Property Constants
 *============================================================================*/

#define T_EMPTY     0x0000

#define T_SOLID     0xFF00

#define T_LADDER    0x0001

#define T_FIRES     0x0002

#define T_SPIKE     0x0004

#define T_PLATE     0x0008

#define T_SLOPEU1   0x0020

#define T_SLOPED1   0x0021

#define T_SLOPELU2  0x0022

#define T_SLOPELD2  0x0023

#define T_SLOPEUU2  0x0024

#define T_SLOPEUD2  0x0025
 
/*============================================================================
 * Action Constants (used by both map and object engines)
 *============================================================================*/
 
#define ACT_STAND   0x0000  
#define ACT_WALK    0x0001  
#define ACT_JUMP    0x0002  
#define ACT_FALL    0x0004  
#define ACT_CLIMB   0x2000  
#define ACT_DIE     0x4000  
#define ACT_BURN    0x8000  
 
/*============================================================================
 * Map Options
 *============================================================================*/

#define MAP_OPT_1WAY   0x01

#define MAP_OPT_BG2    0x02
 
/*============================================================================
 * Exported Variables
 *============================================================================*/
 
/* The camera position is read with mapGetCameraX() / mapGetCameraY() (below).
 * Until 2026-10-03 it was two exported globals, `x_pos` and `y_pos`: names a
 * game is likely to want for itself, and that no alias could have moved
 * later. Replace `x_pos` by `mapGetCameraX()` and `y_pos` by
 * `mapGetCameraY()`; assembly code reads `map_cam_x` / `map_cam_y`. */
 
/* --- Bank $7E SLOT 2 (NOT C-accessible, ASM-only) --- */
/* The map engine's bulk data lives in Bank $7E:
 *   metatiles[4096]     — metatile definitions (4 tile entries per metatile)
 *   metatilesprop[2048] — tile collision properties
 *   bg_L1[2048]         — BG1 tilemap buffer
 *   mapadrrowlut[1024]  — row address lookup table
 * These are managed internally by mapLoad/mapUpdate/mapVblank.
 * C code accesses map data through mapGetMetaTile/mapGetMetaTilesProp.
 */
 
/*============================================================================
 * Functions
 *============================================================================*/

void mapLoad(const u8 *layer1map, const u8 *layertiles, const u8 *tilesprop);

void mapUpdate(void);

void mapVblank(void);

void mapUpdateCamera(u16 xpos, u16 ypos);

u16 mapGetCameraX(void);

u16 mapGetCameraY(void);

u16 mapGetMetaTile(u16 xpos, u16 ypos);

u16 mapGetMetaTilesProp(u16 xpos, u16 ypos);

void mapSetMapOptions(u8 optmap);
 
#endif /* OPENSNES_MAP_H */