yaze_overworld.h File Reference

Overworld data helpers for the YAZE public API. More...

#include "zelda.h"

Include dependency graph for yaze_overworld.h:

Go to the source code of this file.

Functions
zelda3_overworld *	yaze_load_overworld (const zelda3_rom *rom)
	Load the overworld from ROM.
void	yaze_free_overworld (zelda3_overworld *overworld)
	Free overworld data.
const zelda3_overworld_map *	yaze_get_overworld_map (const zelda3_overworld *overworld, int map_index)
	Get overworld map by index.
int	yaze_get_overworld_map_count (const zelda3_overworld *overworld)
	Get total number of overworld maps.

Detailed Description

Overworld data helpers for the YAZE public API.

Definition in file yaze_overworld.h.

Function Documentation

yaze_load_overworld()

zelda3_overworld * yaze_load_overworld

(

const zelda3_rom *

rom

)

Load the overworld from ROM.

Loads and parses the overworld data from the ROM, including all maps, sprites, and related data structures.

Parameters

rom	The ROM to load the overworld from

Returns

Pointer to overworld structure, or NULL on error

Note

Caller must free the returned pointer when done

Definition at line 213 of file yaze.cc.

References zelda3_overworld_map::id, zelda3_overworld::impl, and zelda3_overworld::maps.

yaze_free_overworld()

void yaze_free_overworld

(

zelda3_overworld *

overworld

)

Free overworld data.

Parameters

overworld

Pointer to overworld to free

yaze_get_overworld_map()

const zelda3_overworld_map * yaze_get_overworld_map	(	const zelda3_overworld *	overworld,
		int	map_index )

Get overworld map by index.

Parameters

overworld	Overworld data
map_index	Map index (0-159 for most ROMs)

Returns

Pointer to map data, or NULL if invalid index

yaze_get_overworld_map_count()

int yaze_get_overworld_map_count

(

const zelda3_overworld *

overworld

)

Get total number of overworld maps.

Parameters

overworld

Overworld data

Returns

Number of maps available