Sly 1:GS

From SlyMods
Revision as of 22:57, 27 July 2022 by TheOnlyZac (talk | contribs) (Added infobox)
Jump to navigation Jump to search
GS
Data Structure
GameSly Cooper and the Thievius Raccoonus
Official NameYes

GS (Game State) is a data structure in Sly Cooper and the Thievius Raccoonus. It stores an array of World States, which in turn each store an array of Level States.

Structure

The GS struct is declared as follows:

struct GS {
    int gsv;
    int cbThis; /* Size of this struct in bytes */
    int nChecksum; /* Unknown */
    float dt; /* Time spent in game (secs) */
    struct WS aws[6]; /* Saves for each world */
    enum GAMEWORLD gameworldCur; /* Current gameworld */
    enum WORLDLEVEL worldlevelCur; /* Current worldlevel */
    int clife; /* Lives count */
    int ccharm; /* Charms count */
    int ccoin; /* Coins count */
    GRFGS grfgs; /* Settings flags? */
    GRFVAULT grfvault; /* Powerup flags */
    uint unlocked_cutscenes; /* Cutscene flags (name is not official) */
    enum FGS fgs; /* Game state flags */
    int last_powerup; /* Last selected powerup (name is not official) */
};

World states array

aws is an array of 5 WS structs, one for each world. In the release build, the order is as follows:

  • 0: Intro
  • 1: Underwater
  • 2: Mesa
  • 3: Voodoo
  • 4: Snow
  • 5: Clockwerk

Unlockable flags

There are three[check] sets of flags after the world states.

Settings flags (GRFGS)

There is a set of flags of type GRFGS whose purpose is unclear. At least some of the bits appear to be used for game settings. GRFGS is an alias of int and occupies 4 bytes, or 32 bits.

Powerup flags (GRFVAULT)

There is a set of flags of type GRFVAULT for the unlocked powerups, with each bit corresponding to a particular powerup being unlocked. GRFVAULT is an alias of int and occupies 4 bytes, or 32 bits.

Cutscene flags

There are 16 bits for the cutscene flags, with each bit corresponding to a particular cutscene being unlocked. It is probably also stored as a typedef alias of int but the type is currently unknown.

Game state flags

The current game state is represented by the FGS enum, which has the following possible values:

FGS_FirstClue 0x1
FGS_HalfClues 0x2
FGS_AllClues 0x4
FGS_FirstVault 0x8
FGS_SecondVault 0x10