zelda.h File Reference

The Legend of Zelda: A Link to the Past - Data Structures and Constants. More...

#include <stdbool.h>
#include <stdint.h>

Include dependency graph for zelda.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	zelda3_version_pointers
	ROM data pointers for different game versions. More...
struct	zelda3_rom
	ROM data structure. More...
struct	zelda3_message
	In-game text message data. More...
struct	zelda3_overworld_map
	Overworld map data. More...
struct	zelda3_overworld
	Complete overworld data. More...
struct	dungeon_sprite
	Dungeon sprite definition. More...
struct	object_door
	Dungeon door object. More...
struct	staircase
	Staircase connection. More...
struct	chest
	Treasure chest. More...
struct	chest_data
	Legacy chest data structure. More...
struct	destination
	Room transition destination. More...
struct	zelda3_dungeon_room
	Complete dungeon room data. More...

Macros
#define	Off   ZELDA3_BG2_OFF
#define	Parallax   ZELDA3_BG2_PARALLAX
#define	Dark   ZELDA3_BG2_DARK
#define	OnTop   ZELDA3_BG2_ON_TOP
#define	Translucent   ZELDA3_BG2_TRANSLUCENT
#define	Addition   ZELDA3_BG2_ADDITION
#define	Normal   ZELDA3_BG2_NORMAL
#define	Transparent   ZELDA3_BG2_TRANSPARENT
#define	DarkRoom   ZELDA3_BG2_DARK_ROOM

Typedefs
typedef enum zelda3_version	zelda3_version
	Different versions of the game supported by YAZE.
typedef struct zelda3_version_pointers	zelda3_version_pointers
	ROM data pointers for different game versions.
typedef struct zelda3_rom	zelda3_rom
	ROM data structure.
typedef struct zelda3_message	zelda3_message
	In-game text message data.
typedef struct zelda3_overworld_map	zelda3_overworld_map
	Overworld map data.
typedef struct zelda3_overworld	zelda3_overworld
	Complete overworld data.
typedef struct dungeon_sprite	dungeon_sprite
	Dungeon sprite definition.
typedef enum zelda3_bg2_effect	zelda3_bg2_effect
	Background layer 2 effects.
typedef zelda3_bg2_effect	background2
typedef struct object_door	object_door
	Dungeon door object.
typedef struct staircase	staircase
	Staircase connection.
typedef struct chest	chest
	Treasure chest.
typedef struct chest_data	chest_data
	Legacy chest data structure.
typedef struct destination	destination
	Room transition destination.
typedef struct zelda3_dungeon_room	zelda3_dungeon_room
	Complete dungeon room data.

Enumerations
enum	zelda3_version {   ZELDA3_VERSION_UNKNOWN = 0 , ZELDA3_VERSION_US = 1 , ZELDA3_VERSION_JP = 2 , ZELDA3_VERSION_EU = 3 ,   ZELDA3_VERSION_PROTO = 4 , ZELDA3_VERSION_RANDOMIZER = 5 , US = ZELDA3_VERSION_US , JP = ZELDA3_VERSION_JP ,   SD = ZELDA3_VERSION_PROTO , RANDO = ZELDA3_VERSION_RANDOMIZER }
	Different versions of the game supported by YAZE. More...
enum	zelda3_bg2_effect {   ZELDA3_BG2_OFF = 0 , ZELDA3_BG2_PARALLAX = 1 , ZELDA3_BG2_DARK = 2 , ZELDA3_BG2_ON_TOP = 3 ,   ZELDA3_BG2_TRANSLUCENT = 4 , ZELDA3_BG2_ADDITION = 5 , ZELDA3_BG2_NORMAL = 6 , ZELDA3_BG2_TRANSPARENT = 7 ,   ZELDA3_BG2_DARK_ROOM = 8 }
	Background layer 2 effects. More...

Functions
zelda3_version	zelda3_detect_version (const uint8_t *rom_data, size_t size)
	Detect ROM version from header data.
const char *	zelda3_version_to_string (zelda3_version version)
	Get version name as string.
const zelda3_version_pointers *	zelda3_get_version_pointers (zelda3_version version)
	Get version-specific pointers.
zelda3_rom *	yaze_load_rom (const char *filename)
	Load a ROM file.
void	yaze_unload_rom (zelda3_rom *rom)
	Unload and free ROM data.
int	yaze_save_rom (zelda3_rom *rom, const char *filename)
	Save ROM to file.
zelda3_rom *	yaze_copy_rom (const zelda3_rom *rom)
	Create a copy of ROM data.

Detailed Description

The Legend of Zelda: A Link to the Past - Data Structures and Constants.

This header defines data structures and constants specific to The Legend of Zelda: A Link to the Past ROM format and game data.

Version

0.3.2

Author

YAZE Team

Definition in file zelda.h.

Typedef Documentation

zelda3_dungeon_room

typedef struct zelda3_dungeon_room zelda3_dungeon_room

Complete dungeon room data.

Contains all objects, sprites, and properties for a single dungeon room.