Added a cheat that allows the player to lock all GSWFs, LSWFs, and GFs

Also did the following:
1. Renamed CheatsForceItemDropAreas,  CheatsForceItemDropAreasFullNames, and CheatsForceItemDropAreasSize to CheatsClearAreaFlagsAreas, CheatsClearAreaFlagsAreasFullNames, and CheatsClearAreaFlagsAreasSize respectively.

2. Updated the order of the bools set in setInitialSettings, as well as added in some missing entries to it.

Author: Zephiles

ttyd-tools/rel/include/codes.h

@@ -19,6 +19,7 @@ void lockMarioHPToMax();
 void bobberyEarly();
 void spawnItem();
 void checkIfAreaFlagsShouldBeCleared();
+void lockFlags();
 
 void displaySequenceInPauseMenu();
 void displayOnScreenTimer();

ttyd-tools/rel/include/draw.h

@@ -94,6 +94,7 @@ void drawButtonCombo(uint32_t buttonCombo, int32_t posY, const char *description
 void drawChangeButtonCombo(uint16_t &currentButtonCombo);
 void drawCheatsForcedDropItem();
 void drawCheatsResolveFades();
+void drawCheatsLockFlags();
 void drawCheatsManageFlagsMain(uint32_t currentMenu);
 void drawCheatsClearArea();
 void drawWarpsOptions();

ttyd-tools/rel/include/global.h

@@ -23,6 +23,7 @@ enum MENU_NAMES
 	CHEATS_NO_BUTTON_COMBO,
 	CHEATS_NPC_FORCE_DROP,
 	CHEATS_RESOLVE_FADES,
+	CHEATS_LOCK_FLAGS,
 	CHEATS_MANAGE_FLAGS,
 	CHEATS_MANAGE_FLAGS_MAIN,
 	CHEATS_CLEAR_AREA_FLAGS,
@@ -86,6 +87,7 @@ enum CHEATS_OPTIONS
 	BOBBERY_EARLY,
 	FORCE_ITEM_DROP,
 	RESOLVE_FADES,
+	LOCK_FLAGS,
 	MANAGE_FLAGS,
 	CLEAR_AREA_FLAGS,
 };
@@ -114,6 +116,13 @@ enum CHEATS_RESOLVE_FADES_RETURN_VALUES
 	FADE_RESOLVE_SUCCESS = 1,
 };
 
+
+enum CHEATS_LOCK_FLAGS_SELECTION
+{
+	LOCK_CURRENT_FLAGS = 1,
+	SET_NEW_AREA,
+};
+
 enum CHEATS_MANAGE_FLAGS_SELECTION
 {
 	SET_GSW = 1,
@@ -589,6 +598,12 @@ struct ClearCacheForBattlesStruct
 	bool PartnerStatsShouldBeCleared;
 };
 
+struct LockFlagsStruct
+{
+	uint8_t *FlagsToLockMemory;
+	char AreaLocked[4]; // 3 bytes for the area, 1 byte for NULL
+};
+
 struct TrickDisplay
 {
 	uint32_t MainTimer;
@@ -747,8 +762,8 @@ struct MenuPrevMenuAndOption
 };
 
 extern MenuVars MenuVar;
-extern Menus Menu[29];
-extern Cheats Cheat[23];
+extern Menus Menu[30];
+extern Cheats Cheat[24];
 extern bool Displays[12];
 extern char DisplayBuffer[256];
 extern char HeapBuffer[512];
@@ -766,6 +781,7 @@ extern ReloadRoomStruct ReloadRoom;
 extern SpawnItems SpawnItem;
 extern ClearAreaFlagsStruct ClearAreaFlags;
 extern ClearCacheForBattlesStruct ClearCacheForBattles;
+extern LockFlagsStruct LockFlags;
 extern TrickDisplay YoshiSkip;
 extern TrickDisplay PalaceSkip;
 extern BlimpTicketSkipStruct BlimpTicketSkip;
@@ -783,8 +799,8 @@ extern uint8_t DisplaysOrder[];
 
 extern const char *VersionNumber;
 extern const char *CheatsLines[];
-extern const char *CheatsForceItemDropAreas[];
-extern const char *CheatsForceItemDropAreasFullNames[];
+extern const char *CheatsClearAreaFlagsAreas[];
+extern const char *CheatsClearAreaFlagsAreasFullNames[];
 extern const char *CheatsManageGlobalWordsOptions[];
 extern const char *CheatsManageGlobalFlagsOptions[];
 extern const char *StatsMarioOptionsLines[];
@@ -804,7 +820,7 @@ extern const char *WarpDescriptions[];
 
 extern uint8_t CheatsManageGlobalWordsOptionsSize;
 extern uint8_t CheatsManageGlobalFlagsOptionsSize;
-extern uint8_t CheatsForceItemDropAreasSize;
+extern uint8_t CheatsClearAreaFlagsAreasSize;
 extern uint8_t StatsMarioOptionsLinesSize;
 extern uint8_t MarioStatsSpecialMovesOptionsSize;
 extern uint8_t StatsPartnerOptionsLinesSize;

ttyd-tools/rel/source/codes.cpp

@@ -831,6 +831,38 @@ void checkIfAreaFlagsShouldBeCleared()
 	}
 }
 
+void lockFlags()
+{
+	if (!Cheat[LOCK_FLAGS].Active)
+	{
+		return;
+	}
+	
+	uint8_t *tempFlagsToLockMemory = LockFlags.FlagsToLockMemory;
+	if (!tempFlagsToLockMemory)
+	{
+		return;
+	}
+	
+	uint32_t GlobalWorkPtrRaw = reinterpret_cast<uint32_t>(ttyd::mariost::globalWorkPointer);
+	
+	// Restore the GSWFs
+	void *GSWFsAddresses = reinterpret_cast<void *>(GlobalWorkPtrRaw + 0x178);
+	memcpy(GSWFsAddresses, tempFlagsToLockMemory, 0x400);
+	
+	// Restore the GFs
+	ttyd::evtmgr::EvtWork *EventWork = ttyd::evtmgr::evtGetWork();
+	memcpy(EventWork->gfData, &tempFlagsToLockMemory[0x440], sizeof(EventWork->gfData));
+	
+	// Restore the LSWFs
+	// Only restore if currently in the original area where the code was enabled
+	if (compareStrings(LockFlags.AreaLocked, ttyd::seq_mapchange::NextArea))
+	{
+		void *LSWFsAddresses = reinterpret_cast<void *>(GlobalWorkPtrRaw + 0xD78);
+		memcpy(LSWFsAddresses, &tempFlagsToLockMemory[0x400], 0x40);
+	}
+}
+
 void displaySequenceInPauseMenu()
 {
 	uint32_t SystemLevel = ttyd::mariost::marioStGetSystemLevel();

ttyd-tools/rel/source/draw.cpp

@@ -3069,6 +3069,49 @@ void drawCheatsResolveFades()
 	}
 }
 
+void drawCheatsLockFlags()
+{
+	// Draw the text indicating which area has its flags locked
+	uint32_t Color = 0xFFFFFFFF;
+	uint8_t Alpha = 0xFF;
+	int32_t PosX = -232;
+	int32_t PosY = 60;
+	float Scale = 0.6;
+	
+	const char *String = "Current Area Local Flags Locked";
+	drawText(String, PosX, PosY, Alpha, Color, Scale);
+	PosY -= 20;
+	
+	// Get the text for which area has its flags locked
+	char CurrentAreaLockedText[64];
+	char *tempAreaLockedText = LockFlags.AreaLocked;
+	
+	// Make sure the current area with its flags locked is valid
+	if (!Cheat[LOCK_FLAGS].Active || tempAreaLockedText[0] == '\0')
+	{
+		strcpy(CurrentAreaLockedText, "None");
+	}
+	else
+	{
+		strcpy(CurrentAreaLockedText, tempAreaLockedText);
+		
+		// Check to see if the current area is one that can have its flags cleared
+		const char **tempAreaText = CheatsClearAreaFlagsAreas;
+		uint32_t Size = CheatsClearAreaFlagsAreasSize;
+		for (uint32_t i = 0; i < Size; i++)
+		{
+			if (compareStrings(tempAreaLockedText, tempAreaText[i]))
+			{
+				strcpy(CurrentAreaLockedText, CheatsClearAreaFlagsAreasFullNames[i]);
+				break;
+			}
+		}
+	}
+	
+	// Draw the text for which area has its flags locked
+	drawText(CurrentAreaLockedText, PosX, PosY, Alpha, Color, Scale);
+}
+
 void drawCheatsManageFlagsMain(uint32_t currentMenu)
 {
 	bool ChangingWord = false;
@@ -3228,13 +3271,13 @@ void drawCheatsManageFlagsMain(uint32_t currentMenu)
 void drawCheatsClearArea()
 {
 	// Draw the main text
-	uint32_t tempCheatsForceItemDropAreasSize 	= CheatsForceItemDropAreasSize;
-	const char **tempCheatsForceItemDropAreas 	= CheatsForceItemDropAreas;
+	uint32_t tempCheatsClearAreaFlagsAreasSize 	= CheatsClearAreaFlagsAreasSize;
+	const char **tempCheatsClearAreaFlagsAreas 	= CheatsClearAreaFlagsAreas;
 
 	int32_t PosX 								= -232;
 	int32_t PosY 								= 120;
-	uint32_t Size 								= tempCheatsForceItemDropAreasSize;
-	uint32_t MaxOptionsPerPage 					= tempCheatsForceItemDropAreasSize;
+	uint32_t Size 								= tempCheatsClearAreaFlagsAreasSize;
+	uint32_t MaxOptionsPerPage 					= tempCheatsClearAreaFlagsAreasSize;
 	uint32_t MaxOptionsPerRow 					= 4;
 	uint32_t PosXIncrementAmount 				= 50;
 	uint32_t tempPage 							= 0;
@@ -3252,22 +3295,22 @@ void drawCheatsClearArea()
 
 	drawMultipleColumnsVertical(PosX, PosY, tempSecondaryMenuOption, tempPage, 
 		Size, MaxOptionsPerPage, MaxOptionsPerRow, CurrentlySelectingOption, 
-			PosXIncrementAmount, tempCheatsForceItemDropAreas);
+			PosXIncrementAmount, tempCheatsClearAreaFlagsAreas);
 
 	// Draw the description for the current option
 	if (CurrentlySelectingOption)
 	{
 		PosY -= 140;
 		drawSingleLineFromArray(PosX, PosY, tempSecondaryMenuOption, 
-			CheatsForceItemDropAreasFullNames);
+			CheatsClearAreaFlagsAreasFullNames);
 	}
 
 	// Draw the current area selected
 	PosX = 0;
 	PosY = 160;
 	const char *String = "Current Area: ";
 	drawSingleLineFromStringAndArray(PosX, PosY, MenuVar.MenuSecondaryValue, 
-		String, tempCheatsForceItemDropAreas);
+		String, tempCheatsClearAreaFlagsAreas);
 }
 
 void drawWarpsOptions()

ttyd-tools/rel/source/global.cpp

@@ -58,6 +58,7 @@ const char *CheatsLines[] =
 	"Bobbery Early",
 	"Force NPC Item Drop",
 	"Resolve Fades",
+	"Lock Flags",
 	"Manage Flags",
 	"Clear Area Flags",
 };
@@ -1014,6 +1015,12 @@ const char *CheatsManageGlobalWordsOptions[]
 	"Set New Value",
 };
 
+const char *CheatsLockFlagsOptions[]
+{
+	"Toggle Value",
+	"Set New Area",
+};
+
 const char *CheatsManageGlobalFlagsOptions[]
 {
 	"Toggle Value",
@@ -1025,7 +1032,7 @@ const char *CheatsClearAreaFlags[] =
 	"Clear Flags",
 };
 
-const char *CheatsForceItemDropAreas[] = 
+const char *CheatsClearAreaFlagsAreas[] = 
 {
 	"gor",
 	"tik",
@@ -1051,7 +1058,7 @@ const char *CheatsForceItemDropAreas[] =
 	"jon",
 };
 
-const char *CheatsForceItemDropAreasFullNames[] = 
+const char *CheatsClearAreaFlagsAreasFullNames[] = 
 {
 	"Rogueport",
 	"Rogueport Sewers",
@@ -1646,7 +1653,7 @@ const char ButtonInputDisplay[] =
 
 uint8_t CheatsManageGlobalWordsOptionsSize 	= sizeof(CheatsManageGlobalWordsOptions) / sizeof(CheatsManageGlobalWordsOptions[0]);
 uint8_t CheatsManageGlobalFlagsOptionsSize 	= sizeof(CheatsManageGlobalFlagsOptions) / sizeof(CheatsManageGlobalFlagsOptions[0]);
-uint8_t CheatsForceItemDropAreasSize 		= sizeof(CheatsForceItemDropAreas) / sizeof(CheatsForceItemDropAreas[0]);
+uint8_t CheatsClearAreaFlagsAreasSize 		= sizeof(CheatsClearAreaFlagsAreas) / sizeof(CheatsClearAreaFlagsAreas[0]);
 uint8_t StatsMarioOptionsLinesSize 			= sizeof(StatsMarioOptionsLines) / sizeof(StatsMarioOptionsLines[0]);
 uint8_t MarioStatsSpecialMovesOptionsSize 	= sizeof(MarioStatsSpecialMovesOptions) / sizeof(MarioStatsSpecialMovesOptions[0]);
 uint8_t StatsPartnerOptionsLinesSize 		= sizeof(StatsPartnerOptionsLines) / sizeof(StatsPartnerOptionsLines[0]);
@@ -1786,6 +1793,7 @@ uint8_t CheatsOrder[] =
 	MANAGE_FLAGS,
 	RESOLVE_FADES,
 	FALL_THROUGH_FLOORS,
+	LOCK_FLAGS,
 };
 
 uint8_t DisplaysOrder[] = 
@@ -1805,8 +1813,8 @@ uint8_t DisplaysOrder[] =
 };
 
 struct MenuVars MenuVar;
-struct Menus Menu[29];
-struct Cheats Cheat[23];
+struct Menus Menu[30];
+struct Cheats Cheat[24];
 bool Displays[12];
 char DisplayBuffer[256];
 char HeapBuffer[512];
@@ -1824,6 +1832,7 @@ struct ReloadRoomStruct ReloadRoom;
 struct SpawnItems SpawnItem;
 struct ClearAreaFlagsStruct ClearAreaFlags;
 struct ClearCacheForBattlesStruct ClearCacheForBattles;
+struct LockFlagsStruct LockFlags;
 struct TrickDisplay YoshiSkip;
 struct TrickDisplay PalaceSkip;
 struct BlimpTicketSkipStruct BlimpTicketSkip;
@@ -1868,6 +1877,10 @@ void initMenuVars()
 	Menu[CHEATS_NPC_FORCE_DROP].ColumnSplitAmount 		= Menu[CHEATS_NPC_FORCE_DROP].TotalMenuOptions;
 	Menu[CHEATS_NPC_FORCE_DROP].Line 					= CheatsForceItemDropOptionsLines;
 
+	Menu[CHEATS_LOCK_FLAGS].TotalMenuOptions 			= sizeof(CheatsLockFlagsOptions) / sizeof(CheatsLockFlagsOptions[0]);
+	Menu[CHEATS_LOCK_FLAGS].ColumnSplitAmount 			= Menu[CHEATS_LOCK_FLAGS].TotalMenuOptions;
+	Menu[CHEATS_LOCK_FLAGS].Line 						= CheatsLockFlagsOptions;
+	
 	Menu[CHEATS_MANAGE_FLAGS].TotalMenuOptions 			= sizeof(CheatsManageFlagsOptions) / sizeof(CheatsManageFlagsOptions[0]);
 	Menu[CHEATS_MANAGE_FLAGS].ColumnSplitAmount 		= Menu[CHEATS_MANAGE_FLAGS].TotalMenuOptions;
 	Menu[CHEATS_MANAGE_FLAGS].Line 						= CheatsManageFlagsOptions;
@@ -1950,6 +1963,7 @@ void setInitialSettings()
 	Cheat[FALL_THROUGH_FLOORS].Active 			= false;
 	// Cheat[SAVE_COORDINATES].Active 			= false;
 	// Cheat[LOAD_COORDINATES].Active 			= false;
+	Cheat[SPAWN_ITEM].Active 					= false;
 	Cheat[SAVE_ANYWHERE].Active 				= false;
 	// Cheat[TEXT_STORAGE].Active 				= false;
 	// Cheat[TIME_STOP_TEXT_STORAGE].Active 	= false;
@@ -1961,16 +1975,17 @@ void setInitialSettings()
 	// Cheat[LEVITATE].Active 					= false;
 	Cheat[LOCK_MARIO_HP_TO_MAX].Active 			= false;
 	Cheat[RUN_FROM_BATTLES].Active 				= false;
-	Cheat[SPAWN_ITEM].Active 					= false;
 	// Cheat[DISABLE_MENU_SOUNDS].Active 		= false;
 	// Cheat[BOBBERY_EARLY].Active 				= false;
 	Cheat[FORCE_ITEM_DROP].Active 				= false;
+	Cheat[LOCK_FLAGS].Active 					= false;
 
 	// Set the Cheats button combos
 	Cheat[WALK_THROUGH_WALLS].ButtonCombo 		= PAD_Z;
 	Cheat[FALL_THROUGH_FLOORS].ButtonCombo 		= PAD_Y | PAD_Z;
 	Cheat[SAVE_COORDINATES].ButtonCombo 		= PAD_L | PAD_DPAD_LEFT;
 	Cheat[LOAD_COORDINATES].ButtonCombo 		= PAD_L | PAD_DPAD_UP;
+	Cheat[SPAWN_ITEM].ButtonCombo 				= PAD_L | PAD_DPAD_DOWN;
 	Cheat[SAVE_ANYWHERE].ButtonCombo 			= PAD_Y | PAD_B;
 	Cheat[TEXT_STORAGE].ButtonCombo 			= PAD_L | PAD_X;
 	Cheat[TIME_STOP_TEXT_STORAGE].ButtonCombo 	= PAD_L | PAD_R;
@@ -1980,7 +1995,6 @@ void setInitialSettings()
 	Cheat[INFINITE_ITEM_USAGE].ButtonCombo 		= PAD_Y;
 	Cheat[RELOAD_ROOM].ButtonCombo 				= PAD_L | PAD_B;
 	Cheat[LEVITATE].ButtonCombo 				= PAD_L | PAD_A;
-	Cheat[SPAWN_ITEM].ButtonCombo 				= PAD_L | PAD_DPAD_DOWN;
 
 	// Set the Displays bools
 	// Displays[ONSCREEN_TIMER] 		= true;
@@ -1994,6 +2008,7 @@ void setInitialSettings()
 	// Displays[ART_ATTACK_HITBOXES] 	= true;
 	// Displays[YOSHI_SKIP] 			= true;
 	// Displays[PALACE_SKIP] 			= true;
+	// Displays[BLIMP_TICKET_SKIP] 		= true;
 
 	// Set the Displays button combos
 	OnScreenTimer.ButtonCombo[START_PAUSE_RESUME] 	= PAD_L | PAD_Z;

ttyd-tools/rel/source/main.cpp

@@ -776,6 +776,7 @@ void Mod::run()
 	bobberyEarly();
 	checkIfAreaFlagsShouldBeCleared();
 	checkIfSystemLevelShouldBeLowered();
+	lockFlags();
 
 	// Run each display function
 	// Only run if the mod menu isn't currently open