Document main_menu state machine, name window constants

The new names for the constants (and newly named functions) give a much
better understanding of what the window system is trying to do.
This commit is contained in:
Phlosioneer
2019-02-11 00:05:20 -05:00
parent 6f1d2b870c
commit d979ac3bf3
69 changed files with 480 additions and 334 deletions

View File

@@ -26,11 +26,11 @@ void sub_8197200(void);
u16 RunTextPrintersAndIsPrinter0Active(void);
void sub_81973A4(void);
void NewMenuHelpers_DrawDialogueFrame(u8, u8);
void sub_819746C(u8 windowId, bool8 copyToVram);
void ClearWindowAndBorder(u8 windowId, bool8 copyToVram);
u16 AddTextPrinterParameterized2(u8 windowId, u8 fontId, const u8 *str, u8 speed, void (*callback)(struct TextPrinterTemplate *, u16), u8 fgColor, u8 bgColor, u8 shadowColor);
void PrintPlayerNameOnWindow(u8, const u8*, u16, u16);
void DisplayItemMessageOnField(u8 taskId, const u8 *src, TaskFunc callback);
void sub_8197434(u8 windowId, bool8 copyToVram);
void ClearWindowAndWideBorder(u8 windowId, bool8 copyToVram);
void SetStandardWindowBorderStyle(u8 a0, u8 a1);
void DisplayYesNoMenu(void);
u32 GetPlayerTextSpeed(void);

View File

@@ -1,6 +1,13 @@
#ifndef GUARD_WINDOW_H
#define GUARD_WINDOW_H
// The tile ID for a transparent tile in the window tilesheet
#define TRANSPARENT_TILE_NUMBER 0
#define PIXEL_BUFFER_TRANSPARENT 0x00
#define PIXEL_BUFFER_WHITE 0x11
#define PIXEL_BUFFER_UNKNOWN 0xFF
enum
{
WINDOW_BG,
@@ -73,6 +80,7 @@ extern u32 filler_03002F58;
extern u32 filler_03002F5C;
extern u32 filler_03002F64;
extern u8 gUnknown_03002F60;
// This global is set to TRANSPARENT_TILE_NUMBER and never changed.
extern u8 gTransparentTileNumber;
#endif // GUARD_WINDOW_H