save_menu

Contains data related to Game Over / F6 / Save menus

Variables

const int	ID
int	CursorTile
int	CursorCSet
int	BGColor
int	BGTile
int	BGCSet
int	BGTileWidth
int	BGTileHeight
int	SFXCursor
int	SFXChoose
int	HSpace
int	VSpace
int	X
int	Y
TextAlignment	TextAlign
TextAlignment	TextBoxAlign
int	CloseFrames
int	CloseFlashRate
int	MIDI
const int	NumOptions
bool[]	Flags
SaveMenuOptionFlags[]	OptionFlags
int[]	Colors
int[]	PickedColors
int[]	Fonts
int[]	FrozenScripts

Functions

int	Open()
void	GetName(char32[] buffer)
void	SetName(char32[] buffer)
void	RemoveOption(int index)
void	AddOption(int index = -1)
void	SwapOptions(int index_1, int index_2)
void	GetString(int index, char32[] buffer)
void	SetString(int index, char32[] buffer)

Enumerations

enum SaveMenuFlags: 🔗 Source

Used with save_menu::Flags[].

SaveMenuFlags SMENU_CONFIRM_A = 0

If checked, the A button can confirm, in addition to START.

SaveMenuFlags SMENU_CANCEL_B = 1

If checked, the B button can cancel. (Does not work on ‘Game Over’ menu)

SaveMenuFlags SMENU_DONT_KILL_MUSIC = 2

If checked, the menu opening will not change the music. (save_menu::MIDI)

SaveMenuFlags SMENU_REPEAT_BG = 3

If checked, the save_menu::BGTile will be repated to fill the screen

SaveMenuFlags SMENU_DONT_KILL_SFX = 4

If checked, the menu opening will not stop SFX that are playing.

---

enum SaveMenuOptionFlags: 🔗 Source

Used with save_menu::OptionFlags[].

SaveMenuOptionFlags SMENU_OPT_EXIT = 1

When this option is selected, the game will be exited to the save select. SMENU_OPT_RELOAD takes priority if set.

SaveMenuOptionFlags SMENU_OPT_CONTINUE = 2

When this option is selected, the player will ‘Continue’ from their continue point. SMENU_OPT_RELOAD and SMENU_OPT_EXIT take priority if set.

SaveMenuOptionFlags SMENU_OPT_RELOAD = 4

When this option is selected, the game will be reloaded from the previous save.

SaveMenuOptionFlags SMENU_OPT_SAVE = 8

When this option is selected, the game will be saved.

SaveMenuOptionFlags SMENU_OPT_CANCEL = 16

When this option is selected, the save menu will close. (Does not work on ‘Game Over’ menu)

---

Variable descriptions

const int ID 🔗 Source

Returns the ID of the menu.

---

int CursorTile 🔗 Source

The tile used by this save menu for the cursor

---

int CursorCSet 🔗 Source

The cset used by this save menu for the cursor

---

int BGColor 🔗 Source

The color filling the background of the menu. Color 0 is NOT transparent here.

---

int BGTile 🔗 Source

The upper-left tile used for the menu background. If 0, no tiles will be drawn (leaving only the BGColor)

---

int BGCSet 🔗 Source

The cset the BGTile is drawn in.

---

int BGTileWidth 🔗 Source

The number of tiles wide to draw the BGTile. Also see SMENU_REPEAT_BG.

---

int BGTileHeight 🔗 Source

The number of tiles tall to draw the BGTile. Also see SMENU_REPEAT_BG.

---

int SFXCursor 🔗 Source

The SFX played when moving the cursor.

---

int SFXChoose 🔗 Source

The SFX played when choosing an option.

---

int HSpace 🔗 Source

The space, in pixels, horizontally between the options and the cursor.

---

int VSpace 🔗 Source

The space, in pixels, vertically between each option.

---

int X 🔗 Source

The X value of the options.

---

int Y 🔗 Source

The Y value of the first option

---

TextAlignment TextAlign 🔗 Source

The alignment of the text within the textbox

---

TextAlignment TextBoxAlign 🔗 Source

The alignment of the textbox relative to X

---

int CloseFrames 🔗 Source

The duration, in frames, it takes to close the menu after an option is selected.

---

int CloseFlashRate 🔗 Source

The rate, in frames, that the ‘selected’ option blinks while the menu is closing.

---

int MIDI 🔗 Source

The MIDI to play.

---

const int NumOptions 🔗 Source

The number of options currently in the list.

---

bool[] Flags 🔗 Source

index SaveMenuFlags (SMENU_)

The flags for the whole menu.

---

SaveMenuOptionFlags[] OptionFlags 🔗 Source

The SaveMenuOptionFlags (SMENU_OPT_) for each option.

---

int[] Colors 🔗 Source

The text colors for each option.

---

int[] PickedColors 🔗 Source

The text colors for each option which are used when the option is selected.

---

int[] Fonts 🔗 Source

The Font IDs for each option.

---

int[] FrozenScripts 🔗 Source

The generic frozen script for each option.

---

Function descriptions

int Open() 🔗 Source

Runs the menu. Returns the selected index. If the menu is canceled via SMENU_CANCEL_B, returns -1.

---

void GetName(char32[] buffer) 🔗 Source

Fills the buffer with the name of this save menu

---

void SetName(char32[] buffer) 🔗 Source

Sets the name of this save menu to the buffer contents.

---

void RemoveOption(int index) 🔗 Source

Deletes the option at index.

---

void AddOption(int index = -1) 🔗 Source

Adds a new option at index. Negative index adds at the end.

---

void SwapOptions(int index_1, int index_2) 🔗 Source

Swaps the options at index_1 and index_2.

---

void GetString(int index, char32[] buffer) 🔗 Source

Fills the buffer with the string for option index

---

void SetString(int index, char32[] buffer) 🔗 Source

Sets the string for option index to the contents of the buffer