Begin populating JSRF/GameData.hpp

decompile/src/JSRF/GameData.cpp

@@ -5,3 +5,6 @@ Save data and closely-related runtime data.
 #pragma bss_seg(".data")
 
 #include "GameData.hpp"
+
+
+GameData g_gameData = GameData();

decompile/src/JSRF/GameData.hpp

@@ -5,6 +5,160 @@ Save data and closely-related runtime data.
 #ifndef GAMEDATA_HPP
 #define GAMEDATA_HPP
 
+#include "../XDK/Win32.hpp"
 
 
+// Data structure actually saved to disk
+struct SaveData {
+	unsigned chapter;
+	unsigned missionDigits34;
+	unsigned spawnPosIndex;
+	unsigned playtimeFrames;
+	unsigned unlockedChars;
+
+	// Boolean flags read and written by missions
+	unsigned chapterFlags[16]; // Reset every chapter
+	unsigned globalFlags [16]; // Never reset
+	unsigned specialFlags[16]; // Never reset; special effects like
+	                           // unlocking/completing tutorials, finishing
+	                           // street challenges
+
+	unsigned spawnedSouls  [8]; // Souls that have appeared on streets
+	unsigned collectedSouls[8]; // Souls that have been acquired
+	unsigned heldSouls     [8]; // Souls currently usable (i.e. not stolen)
+
+	unsigned unusedPerStageBitmask[16];
+
+	// Which tags have been sprayed and by who
+	// Indexed by stage, tag ID, and player/rival tag; rival tags don't
+	// count towards completion and can be painted over.  Each entry is a
+	// packed bit array of 3 bits per "G" mark, valued 7 if nothing is
+	// painted or 0-3 to indicate player 1-4 painted it (in story mode,
+	// rival graffiti is considered painted by players 2-4).
+	unsigned tagState[16][80][2];
+
+	struct SaveSettings {
+		float    volumeMusic;
+		float    volumeSfx;
+		BOOL     rumbleEnabled;
+		unsigned unused[29];
+	} saveSettings;
+
+	unsigned garageMusic;
+	unsigned unusedBitfield[8];
+
+	// Sewer switches at offset 0 then noise tanks at offset 3
+	unsigned miscObjectives[32];
+
+	struct TestRunScoreSaved {
+		unsigned      score;
+		unsigned char character;
+		unsigned char rank1; // Used by Jet Tech
+		unsigned char rank2; // Used by other test runs
+	} highScores[16][4][5];
+
+	unsigned clutchTimer;
+	unsigned unusedTimer;
+
+	unsigned selectedTags     [5]; // Like GameData but for P1 in 1-player
+	unsigned customTagSelected[5]; // Like GameData but for P1 in 1-player
+
+	unsigned eventsSeen[16];
+};
+
+// Numeric IDs for selecting different listss of state flags
+enum FlagList {
+	FLAGLIST_MISSION,
+	FLAGLIST_CHAPTER,
+	FLAGLIST_GLOBAL,
+	FLAGLIST_SPECIAL
+};
+
+// Numeric IDs for tag sizes (should maybe put somewhere else?)
+enum TagSize { TAGSIZE_SS, TAGSIZE_S, TAGSIZE_M, TAGSIZE_L, TAGSIZE_XL };
+
+// Numeric IDs for different test run categories
+enum TestRunType {
+	TESTRUN_GRAFFITI,
+	TESTRUN_TECH,
+	TESTRUN_DASH,
+	TESTRUN_FLAG
+};
+
+// Unpacked version of TestRunScoreSaved
+struct TestRunScore {
+	unsigned  score;
+	unsigned  character;
+	unsigned  rank1; // Used by Jet Tech
+	unsigned  rank2; // Used by other test runs
+};
+
+// Numeric IDs for different timers
+enum Timer { TIMER_DEATHBALLPRACTICE, TIMER_CLUTCH, TIMER_UNUSED };
+
+// Save data-ish data structure used at runtime
+extern struct GameData {
+	SaveData saveActive;
+	SaveData saveStashed; // Holds save data during test runs/tutorials
+
+	unsigned missionFlags[16];       // Reset every mission transition
+	unsigned deathBallPracticeTimer; // For Jazz sequence in Future Site
+
+	// Indexed like SaveData.highScores; true if score is most recent and
+	// also made leaderboard
+	BOOL mostRecentHighScore[16][4][5];
+
+	// Tags indexed by single or multiplayer, then gang (GGs, Golden
+	// Rhinos/Zero Beat, Poison Jam, Immortals) or player, then size
+	unsigned selectedTags     [2][4][5]; // IDs of tags in use
+	BOOL     customTagSelected[2][4][5]; // True means tag ID is for custom
+	                                     // graffiti list, not ingame list
+
+	BOOL     checkFlagCondition  (unsigned cond);
+	void     writeStateFlag      (unsigned flagVal);
+	void     incrementChapter    ();
+	void     setMissionDigits34  (unsigned val);
+	void     setSpawnPosIndex    (unsigned val);
+	unsigned getSpawnPosIndex    ();
+	void     unlockCharacter     (unsigned charId);
+	void       lockCharacter     (unsigned charId);
+	BOOL     characterUnlocked   (unsigned charId);
+	BOOL     checkFlagConditions (unsigned * conds , unsigned count);
+	void     writeStateFlags     (unsigned * writes, unsigned count);
+	BOOL     checkFlagConditionUnpacked(FlagList flagList, unsigned index);
+	void     writeStateFlagUnpacked    (FlagList flagList, unsigned index, unsigned val);
+	void     setSoulSpawned      (unsigned soulId);
+	BOOL     getSoulSpawned      (unsigned soulId);
+	void     setSoulCollected    (unsigned soulId);
+	BOOL     getSoulHeld         (unsigned soulId);
+	BOOL     soulSpawnedUncollected(unsigned soulId);
+	void     clearHeldSouls      ();
+	void     restoreHeldSouls    ();
+	unsigned getSoulCount        ();
+	unsigned getTotalSoulsInStage(unsigned stageId);
+	unsigned getHeldSoulsInStage (unsigned stageId);
+	unsigned setSoulCollectedBySize(TagSize size, unsigned index);
+	void     setUnusedPerStageBitmask(unsigned stageId, unsigned index);
+	int      getTagState         (unsigned stageId, unsigned index, BOOL rivalTag);
+	void     setTagState         (unsigned stageId, unsigned index, BOOL rivalTag, unsigned val);
+	void     setTagCovered       (unsigned stageId, unsigned index, BOOL rivalTag, unsigned gangOrPlayer);
+	void     setVolumeSettings   (float   volMusic, float   volSfx);
+	void     getVolumeSettings   (float * outMusic, float * outSfx);
+	void     setRumbleEnabled    (BOOL val);
+	BOOL     getRumbleEnabled    ();
+	void     setGarageMusic      (unsigned songId);
+	unsigned getGarageMusic      ();
+	void     setUnusedBitfield   (unsigned index);
+	void     setMiscObjective    (unsigned index);
+	BOOL     getMiscObjective    (unsigned index);
+	unsigned countMiscObjectives ();
+	BOOL     getHighScore        (unsigned stageId, TestRunType type, unsigned rank, TestRunScore * out);
+	void     incrementTimer      (Timer timer);
+	unsigned getTimer            (Timer timer);
+	void     setTimer            (Timer timer, unsigned frames);
+
+	GameData();
+	virtual ~GameData();
+} g_gameData;
+
 #endif