yaze_messages.h File Reference

Message system helpers for the YAZE public API. More...

#include "yaze_errors.h"
#include "zelda.h"

Include dependency graph for yaze_messages.h:

Go to the source code of this file.

Functions
yaze_status	yaze_load_messages (const zelda3_rom *rom, zelda3_message **messages, int *message_count)
	Load all text messages from ROM.
const zelda3_message *	yaze_get_message (const zelda3_rom *rom, int message_id)
	Get a specific message by ID.
void	yaze_free_messages (zelda3_message *messages, int message_count)
	Free message data.

Detailed Description

Message system helpers for the YAZE public API.

Definition in file yaze_messages.h.

Function Documentation

yaze_load_messages()

yaze_status yaze_load_messages	(	const zelda3_rom *	rom,
		zelda3_message **	messages,
		int *	message_count )

Load all text messages from ROM.

Loads and parses all in-game text messages from the ROM.

Parameters

rom	The ROM to load messages from
messages	Pointer to store array of messages
message_count	Pointer to store number of messages loaded

Returns

YAZE_OK on success, error code on failure

Note

Caller must free the messages array when done

Definition at line 256 of file yaze.cc.

References yaze::Rom::data(), zelda3_message::id, yaze::editor::ReadAllTextData(), YAZE_ERROR_INVALID_ARG, YAZE_ERROR_MEMORY, YAZE_ERROR_NOT_INITIALIZED, and YAZE_OK.

Here is the call graph for this function:

yaze_get_message()

const zelda3_message * yaze_get_message	(	const zelda3_rom *	rom,
		int	message_id )

Get a specific message by ID.

Parameters

rom	ROM to load from
message_id	Message ID to retrieve

Returns

Pointer to message data, or NULL if not found

yaze_free_messages()

void yaze_free_messages	(	zelda3_message *	messages,
		int	message_count )

Free message data.

Parameters

messages	Array of messages to free
message_count	Number of messages in array