Added the Memory menu

Author: Zephiles

USER_MANUAL.md

@@ -7,6 +7,7 @@
     -   [Cheats](#cheats)
     -   [Stats](#stats)
     -   [Settings](#settings)
+    -   [Memory](#memory)
     -   [Battles](#battles)
     -   [Displays](#displays)
     -   [Warps](#warps)
@@ -65,6 +66,10 @@ This menu allows you to save and load various settings. The settings are stored
 * Cheats button combos
 * Which displays are active
 * Displays button combos
+* Memory watches (See below)
+
+### Memory
+This menu allows you to watch the values of up to 30 memory addresses, with support for up to 10 pointer levels each. Each of these watches can also be displayed on the screen at will.
 
 ### Battles
 This menu allows you to change the HP, Max HP, FP, Max FP, held items, and statuses of anyone in a battle (refered to as Actors).

ttyd-tools/rel/include/codes.h

@@ -27,6 +27,8 @@ void displayMarioCoordinatesBoolCheck();
 void displayJumpStorageDetails();
 void displayButtonInputs();
 void displayStickAngle();
+void displayMemoryWatches();
+
 void displayYoshiSkipDetails();
 void displayPalaceSkipDetails();
 void actionCommandsTimingsInit();

ttyd-tools/rel/include/commonfunctions.h

@@ -37,5 +37,6 @@ bool checkIfBadgeEquipped(int16_t badge);
 void recheckJumpAndHammerLevels();
 uint32_t getCurrentPitFloor();
 void clearGSWFsRange(uint32_t lowerBound, uint32_t upperBound);
+void *getLastPointerFromPath(void *address, int32_t *offset, uint32_t offsetAmount);;
 
 }

ttyd-tools/rel/include/draw.h

@@ -46,6 +46,11 @@ void drawPartnerStats();
 void drawBattlesActorStats();
 void drawBattlesActorsHeldItem();
 void drawCurrentFollowerOut();
+void drawMemoryWatches();
+void drawMemoryModifyList();
+void drawMemoryTypeList();
+void drawMemoryChangeWatchPosition();
+void drawMemoryChangeAddressList();
 void drawBattlesActorsList();
 void drawBattlesStatusesList();
 
@@ -55,6 +60,7 @@ void drawWarpsErrorMessage();
 void drawPartnerFollowerMessage(const char *message);
 void drawPartnerErrorMessage();
 void drawFollowersErrorMessage();
+void drawMemoryErrorMessage(const char *message);
 void drawNotInBattleErrorMessage();
 void drawConfirmationWindow(const char *message);
 
@@ -69,6 +75,7 @@ void drawSingleLineFromStringAndArray(int32_t posX, int32_t posY,
 
 void drawAdjustableValueSpawnItem();
 void drawAdjustableValue(bool changingItem, uint32_t currentMenu);
+void drawMemoryWatchAdjustableValue(uint32_t currentMenu);
 void drawAddByIconMain(uint32_t currentMenu);
 void drawAddByIcon(uint32_t currentMenu);
 void drawAddById(uint32_t currentMenu);
@@ -90,6 +97,8 @@ void drawMarioCoordinates();
 void drawJumpStorageDetails();
 void drawButtonInputs();
 void drawStickAngle();
+void drawMemoryWatchesOnOverworld();
+
 void drawYoshiSkipDetails();
 void drawPalaceSkipDetails();
 void drawActionCommandsTiming();

ttyd-tools/rel/include/global.h

@@ -13,6 +13,7 @@ enum MENU_NAMES
 	CHEATS,
 	STATS,
 	SETTINGS,
+	MEMORY,
 	BATTLES,
 	DISPLAYS,
 	WARPS,
@@ -25,6 +26,8 @@ enum MENU_NAMES
 	STATS_MARIO,
 	STATS_PARTNERS,
 	STATS_FOLLOWERS,
+	MEMORY_MODIFY,
+	MEMORY_CHANGE_ADDRESS,
 	BATTLES_CURRENT_ACTOR,
 	BATTLES_STATUSES,
 	DISPLAYS_ONSCREEN_TIMER,
@@ -191,6 +194,51 @@ enum SETTINGS_RETURN_CODES
 	SAVE_SUCCESSFUL,
 };
 
+enum MEMORY_TYPES
+{
+	string = 0,
+	time,
+	s8,
+	s16,
+	s32,
+	s64,
+	u8,
+	u16,
+	u32,
+	u64,
+	f32,
+	f64,
+};
+
+enum MEMORY_OPTIONS
+{
+	ADD_WATCH = 1,
+	MODIFY_WATCH,
+	DELETE_WATCH,
+};
+
+enum MEMORY_MODIFY_OPTIONS
+{
+	CHANGE_ADDRESS = 1,
+	CHANGE_TYPE,
+	SHOW_AS_HEX,
+	CHANGE_WATCH_POSITION,
+	DISPLAY_OUT_OF_MENU,
+};
+
+enum MEMORY_MODIFY_ADDRESS_OPTIONS
+{
+	CHANGE_ADDRESS_OR_POINTERS = 1,
+	ADD_POINTER_LEVEL,
+	REMOVE_POINTER_LEVEL,
+};
+
+enum MEMORY_ERRORS
+{
+	ALL_SLOTS_EMPTY = -2,
+	NO_SLOTS_LEFT,
+};
+
 enum BATTLES_CURRENT_ACTOR_STATS_SELECTION
 {
 	CHANGE_ACTOR_HP = 1,
@@ -398,6 +446,14 @@ struct AutoIncrement
 	uint16_t WaitFramesToPerformIncrement;
 };
 
+struct AutoIncrementCoordinates
+{
+	uint16_t WaitFramesToBeginIncrement;
+	uint16_t WaitFramesToPerformIncrement;
+	int32_t PosX;
+	int32_t PosY;
+};
+
 struct CheatsHandleDisplayButtons
 {
 	uint8_t CheatsBButtonCounter;
@@ -493,20 +549,36 @@ struct MemoryCardStruct
 	char *Description;
 };
 
+struct MemoryWatchStruct
+{
+	uint32_t Address;
+	int32_t AddressOffset[10];
+	uint8_t AddressOffsetAmount;
+	uint8_t Type;
+	bool ShowAsHex;
+	bool Display;
+	int32_t PosX;
+	int32_t PosY;
+};
+
 struct SettingsStruct
 {
 	bool CheatsActive[100];
 	uint16_t CheatButtonCombos[100];
 	bool DisplaysActive[100];
 	uint16_t DisplaysButtonCombos[100];
+	MemoryWatchStruct MemoryWatchSettings[30];
 };
 
-extern Menus Menu[21];
+extern Menus Menu[24];
 extern Cheats Cheat[19];
 extern bool Displays[9];
 extern char DisplayBuffer[256];
+extern MemoryWatchStruct MemoryWatch[30];
 
 extern AutoIncrement AdjustableValueMenu;
+extern AutoIncrement MemoryWatchAdjustableValueMenu;
+extern AutoIncrementCoordinates MemoryWatchPosition;
 extern CheatsHandleDisplayButtons CheatsDisplayButtons;
 extern MarioPartnerPositionsStruct MarioPartnerPositions;
 extern SaveAnywhereStruct SaveAnywhere;
@@ -536,6 +608,10 @@ extern const char *StatsPartnerOptionsLines[];
 extern uint8_t StatsPartnerOptionsLinesSize;
 extern const char *StatsFollowerOptionsLines[];
 extern uint8_t StatsFollowerOptionsLinesSize;
+extern const char *MemoryModifyLines[];
+extern uint8_t MemoryModifyLinesSize;
+extern const char *MemoryTypeLines[];
+extern uint8_t MemoryTypeLinesSize;
 extern const char *BattlesActorsLines[];
 extern const char *BattlesCurrentActorStats[];
 extern uint8_t BattlesCurrentActorStatsSize;
@@ -554,8 +630,10 @@ extern const char *WarpDescriptions[];
 extern const char ButtonInputDisplay[];
 #else
 extern const char *ButtonInputDisplay[];
+extern const char *PointerText;
 #endif
 
+extern bool HideMenu;
 extern bool MenuIsDisplayed;
 extern bool PreventClosingMenu;
 extern bool ChangingCheatButtonCombo;
@@ -570,6 +648,7 @@ extern int8_t FunctionReturnCode;
 extern uint32_t Timer;
 extern uint8_t MenuSelectionStates;
 extern int32_t MenuSecondaryValue;
+extern uint32_t MemoryWatchSecondaryValue;
 extern uint8_t FrameCounter;
 
 extern uint32_t r13;
@@ -591,6 +670,7 @@ extern uint32_t FieldItemsAddressesStart;
 
 extern uint32_t GlobalWorkPointer;
 extern uint32_t titleMainAddress;
+extern uint32_t ConsoleBusSpeedAddress;
 
 extern bool ResetMarioProperties;
 extern int16_t ForcedNPCItemDrop;

ttyd-tools/rel/include/memorywatch.h

@@ -0,0 +1,17 @@
+#pragma once
+
+#include <cstdint>
+
+namespace mod {
+
+int32_t getEmptyWatchSlot();
+const char *getAddressStringNoLetterP(int32_t slot);
+const char *getAddressString(int32_t slot);
+const char *getAddressStringFromOffsets(int32_t slot, uint32_t maxOffset);
+const char *getValueString(int32_t slot);
+void addMemoryWatch(int32_t slot);
+void deleteWatch(int32_t slot);
+uint32_t adjustWatchValueControls(int32_t slot);
+void adjustWatchTempValueAndBounds(int32_t slot, uint32_t highestDigit, int32_t valueChangedBy);
+
+}

ttyd-tools/rel/include/menufunctions.h

@@ -27,10 +27,13 @@ bool checkForClosingErrorMessage();
 void correctInventoryCurrentMenuOptionAndPage(uint32_t maxOptionsPerPage);
 uint32_t getHighestAdjustableValueDigit(uint32_t currentMenu);
 int32_t getDigitBeingChanged(int32_t number, int32_t valueChangedBy);
+int32_t getDigitBeingChangedUnsignedHex(uint32_t number, int32_t valueChangedBy);
 void setAdjustableValueToMax(uint32_t currentMenu);
 void setAdjustableValueToMin(uint32_t currentMenu);
 uint32_t adjustableValueButtonControls(uint32_t currentMenu);
 uint32_t addByIconButtonControls(uint32_t currentMenu);
+uint32_t memoryAddressTypeButtonControls();
+uint32_t memoryChangeWatchPositionButtonControls();
 uint32_t marioSpecialMovesButtonControls();
 uint32_t followersOptionsButtonControls();
 void adjustMenuItemBoundsMain(int32_t valueChangedBy, int32_t lowerBound, int32_t upperBound);
@@ -66,6 +69,8 @@ void adjustMenuSelectionInventory(uint32_t button);
 void adjustCheatClearAreaFlagSelection(uint32_t button);
 void adjustMarioStatsSelection(uint32_t button);
 void adjustPartnerStatsSelection(uint32_t button);
+void adjustMemoryWatchSelection(uint32_t button);
+void adjustMemoryChangeAddressOrPointerSelection(uint32_t button);
 void adjustBattlesActorSelection(uint32_t button);
 void adjustBattlesStatusSelection(uint32_t button);
 void adjustWarpsSelection(uint32_t button);

ttyd-tools/rel/include/ttyd.eu.lst

@@ -1222,6 +1222,8 @@
 80268570:_savegpr_29
 80268574:_savegpr_30
 80268578:_savegpr_31
+802685CC:__udivdi3
+802687F0:__umoddi3
 
 // printf.c
 8026DEAC:sprintf

ttyd-tools/rel/include/ttyd.jp.lst

@@ -1214,6 +1214,8 @@
 8025E9E0:_savegpr_29
 8025E9E4:_savegpr_30
 8025E9E8:_savegpr_31
+8025EA3C:__udivdi3
+8025EC60:__umoddi3
 
 // printf.c
 80264108:sprintf

ttyd-tools/rel/include/ttyd.us.lst

@@ -1220,6 +1220,8 @@
 80264990:_savegpr_29
 80264994:_savegpr_30
 80264998:_savegpr_31
+802649EC:__udivdi3
+80264C10:__umoddi3
 
 // printf.c
 8026A0B8:sprintf