General

General API information. More...

Macros
#define	EZTR_MOD_ID_STR   "MM_EZ_Text_Replacer_API"
	The mod id string for EZTR.
#define	EZTR_MSG_HIGHEST_ID   0x354C
#define	EZTR_MSG_BUFFER_SIZE   1280
	The the full size of message buffer, in bytes.
#define	EZTR_MSG_BUFFER_WIDE_SIZE   640
	The maximum length of buffer in two-byte characters (wchar).
#define	EZTR_MSG_HEADER_SIZE   11
	The size of the message buffer's header region, in bytes.
#define	EZTR_MSG_CONTENT_SIZE   1269
	The size of the message buffer's content region, in bytes.
#define	EZTR_MSG_ENDING_CHAR   '\xBF'
#define	EZTR_PIPE_CHAR   '|'

Detailed Description

General API information.

Macro Definition Documentation

EZTR_MOD_ID_STR

#define EZTR_MOD_ID_STR   "MM_EZ_Text_Replacer_API"

The mod id string for EZTR.

The eztr_api.h imports all the functions and events needed for EZTR, so you probably won't need to use this directly.

EZTR_MSG_BUFFER_SIZE

#define EZTR_MSG_BUFFER_SIZE   1280

The the full size of message buffer, in bytes.

Also equivalent to maximum length of buffer in single-byte characters (char).

EZTR_MSG_BUFFER_WIDE_SIZE

#define EZTR_MSG_BUFFER_WIDE_SIZE   640

The maximum length of buffer in two-byte characters (wchar).

Not really used, but included for parity with the base game.

EZTR_MSG_CONTENT_SIZE

#define EZTR_MSG_CONTENT_SIZE   1269

The size of the message buffer's content region, in bytes.

Useful if you need to loop throught a buffer's content.

EZTR_MSG_HEADER_SIZE

#define EZTR_MSG_HEADER_SIZE   11

The size of the message buffer's header region, in bytes.

Also servers as the starting index of the message buffer's content region.