completed documentation of vola flags

This commit is contained in:
mariob92
2024-09-08 18:58:43 +02:00
parent f451eae4e2
commit f85116d50c
5 changed files with 76 additions and 67 deletions

View File

@@ -242,33 +242,31 @@ enum volatile_flags_e {
VOLATILE_FLAG_9_HAS_SEEN_ZUBBAS_FF_MINIGAME,
VOLATILE_FLAG_A_HAS_SEEN_TIPTUP_FF_MINIGAME,
VOLATILE_FLAG_B_HAS_SEEN_SANDCASTLE_FF_MINIGAME,
VOLATILE_FLAG_C,
VOLATILE_FLAG_D,
VOLATILE_FLAG_E,
VOLATILE_FLAG_F,
VOLATILE_FLAG_10,
VOLATILE_FLAG_11,
VOLATILE_FLAG_12,
VOLATILE_FLAG_C_HAS_SEEN_SPRING_PAD,
VOLATILE_FLAG_D_HAS_SEEN_FLIGHT_PAD,
VOLATILE_FLAG_E, // related to chxmastree, GV waterctrl and RBB anchorswitch
VOLATILE_FLAG_F_HAS_MEET_TURBO_SHOES,
VOLATILE_FLAG_10_HAS_MEET_WADING_BOOTS,
VOLATILE_FLAG_11, // unused
VOLATILE_FLAG_12, // unused
VOLATILE_FLAG_13_HAS_TRIGGERED_MUMBO_VACATION_TEXT,
VOLATILE_FLAG_14,
VOLATILE_FLAG_15,
VOLATILE_FLAG_16,
VOLATILE_FLAG_17,
VOLATILE_FLAG_18,
VOLATILE_FLAG_14, // unused
VOLATILE_FLAG_15, // unused
VOLATILE_FLAG_16, // related to beta function "return to lair"
VOLATILE_FLAG_17, // 17 and 18: related to 50 note door and demo mode (?)
VOLATILE_FLAG_18, // 17 and 18: related to 50 note door and demo mode (?)
VOLATILE_FLAG_19_CURRENT_LEVEL_ID, // 4 bits for current level ID
VOLATILE_FLAG_1D = 0x1D,
VOLATILE_FLAG_1E,
VOLATILE_FLAG_1F_IN_CHARACTER_PARADE = 0x1F,
// VOLATILE_FLAG_1A to VOLATILE_FLAG_1C belong to VOLATILE_FLAG_19_CURRENT_LEVEL_ID
VOLATILE_FLAG_1D = 0x1D, // unused
VOLATILE_FLAG_1E, // related to warp cauldron or dingpot
VOLATILE_FLAG_1F_IN_CHARACTER_PARADE,
VOLATILE_FLAG_20_BEGIN_CHARACTER_PARADE,
VOLATILE_FLAG_21,
VOLATILE_FLAG_22,
VOLATILE_FLAG_23_FINAL_BOSS_PHASE = 0x23, // 3 bits for current phase in final boss fight
VOLATILE_FLAG_21, // related to FF
VOLATILE_FLAG_22, // related to baddies escape text
VOLATILE_FLAG_23_FINAL_BOSS_PHASE, // 3 bits for current phase in final boss fight
// VOLATILE_FLAG_24 to VOLATILE_FLAG_25 belong to VOLATILE_FLAG_23_FINAL_BOSS_PHASE
VOLATILE_FLAG_26_FF_GRUNTY_QUESTIONS = 0x26, // 60 bits FFQ Grunty Question related (two bits for every question)
// VOLATILE_FLAG_27 to VOLATILE_FLAG_61 belong to VOLATILE_FLAG_26_FF_GRUNTY_QUESTIONS
VOLATILE_FLAG_62_FF_GRUNTY_QUESTIONS_INITIALIZED = 0x62,
VOLATILE_FLAG_63, // related to demo mode
VOLATILE_FLAG_64, // related to demo mode
@@ -290,10 +288,13 @@ enum volatile_flags_e {
VOLATILE_FLAG_74_SANDCASTLE_INFINITE_EGGS,
VOLATILE_FLAG_75_SANDCASTLE_INFINITE_RED_FEATHERS,
VOLATILE_FLAG_76_SANDCASTLE_INFINITE_GOLD_FEATHERS,
VOLATILE_FLAG_78_SANDCASTLE_NO_BONUS = 0x78,
VOLATILE_FLAG_7D_SANDCASTLE_RAISE_PIPES_TO_CC = 0x7D,
VOLATILE_FLAG_77, // unused
VOLATILE_FLAG_78_SANDCASTLE_NO_BONUS,
VOLATILE_FLAG_79, // unused
VOLATILE_FLAG_7A, // unused
VOLATILE_FLAG_7B, // unused
VOLATILE_FLAG_7C, // unused
VOLATILE_FLAG_7D_SANDCASTLE_RAISE_PIPES_TO_CC,
VOLATILE_FLAG_7E_SANDCASTLE_RAISE_PIPE_TO_BRENTILDA,
VOLATILE_FLAG_7F_SANDCASTLE_OPEN_CC,
VOLATILE_FLAG_80_SANDCASTLE_REMOVE_GRILL_NEAR_BGS_JIGGY,
@@ -345,23 +346,29 @@ enum volatile_flags_e {
VOLATILE_FLAG_AE_BGS_WALKWAY_JIGGY_MISSED,
VOLATILE_FLAG_AF_BGS_MAZE_JIGGY_MISSED,
VOLATILE_FLAG_B0_NOT_ENOUGH_NOTES,
VOLATILE_FLAG_B2 = 0xB2,
VOLATILE_FLAG_B3,
VOLATILE_FLAG_B4,
VOLATILE_FLAG_B5,
VOLATILE_FLAG_BB = 0xBB,
VOLATILE_FLAG_BC,
VOLATILE_FLAG_BD,
VOLATILE_FLAG_BE,
VOLATILE_FLAG_BF,
VOLATILE_FLAG_C0_BEGIN_FINAL_CHARACTER_PARADE = 0xC0,
VOLATILE_FLAG_B1, // unused
VOLATILE_FLAG_B2, // ccw related
VOLATILE_FLAG_B3, // boggy2 related
VOLATILE_FLAG_B4, // fp related
VOLATILE_FLAG_B5, // ccw related
VOLATILE_FLAG_B6_WITCH_SWITCH_PRESSED_MM,
VOLATILE_FLAG_B7_WITCH_SWITCH_PRESSED_MMM,
VOLATILE_FLAG_B8_WITCH_SWITCH_PRESSED_TTC,
VOLATILE_FLAG_B9_WITCH_SWITCH_PRESSED_RBB,
VOLATILE_FLAG_BA_WITCH_SWITCH_PRESSED_CCW,
VOLATILE_FLAG_BB_WITCH_SWITCH_PRESSED_FP,
VOLATILE_FLAG_BC_WITCH_SWITCH_PRESSED_CC,
VOLATILE_FLAG_BD_WITCH_SWITCH_PRESSED_BGS,
VOLATILE_FLAG_BE_WITCH_SWITCH_PRESSED_GV,
VOLATILE_FLAG_BF, // witch switch related
VOLATILE_FLAG_C0_BEGIN_FINAL_CHARACTER_PARADE,
VOLATILE_FLAG_C1_IN_FINAL_CHARACTER_PARADE,
VOLATILE_FLAG_C2_NOBONUS_TEXT,
VOLATILE_FLAG_C3, // SNS picture related
VOLATILE_FLAG_C4_WOZZA_HIDE_IN_SNS_PARADE,
VOLATILE_FLAG_C5_WISHYWASHYBANJO_TEXT
VOLATILE_FLAG_C5_WISHYWASHYBANJO_TEXT,
VOLATILE_FLAG_NUM_FLAGS
};
enum level_flags_e