Sly 1:LS

This article is about the states of Sly 1 levels. For the data structure used to track the game state in Sly 2 and 3, see DAG.

LS (Level State) is a data structure in Sly Cooper and the Thievius Raccoonus. It is used for storing the current state of each level in the Game State.

Structure

The LS struct is defined as follows:

struct LS {
    enum FLS fls; /* Level state flags */
    float dt; /* Time spent in level (secs) */
    float dtTimedBest; /* Best MTS time for level */
    float uSuck; /* Current player suck value for level */
    float suck_field_0x10; /* Unknown value, related to uSuck */
    int afDialogPlayed[12]; /*  Dialog played flags */
    struct SceneVar a_scene_vars[4]; /* Scene variables */
    int cclue; /* Count of bottles collected */
    uint fclue; /* Flags marking which bottles have been collected */
    undefined4 field_0x6c; /* Unknown */
    int field_0x70; /* Unknown */
    byte * unk_ptr_0x74; /* Unknown ptr to 1-byte value */
};

Level state flags

The current state of the level is represented using the FLS enum, which has the following possible values:

Name	Value	Description
FLS_Visited	0x1	Level has been visited and is selectable from View Map.
FLS_KeyCollected	0x2	The key has been collected on the level.
FLS_Secondary	0x4	The vault has been opened on the level.
FLS_Tertiary	0x8	The MTS has been completed on the level.
FLS_BossDefeated	0x10	Unknown

uSuck values

Main article: Difficulty

Each individual level state has a uSuck value which is used to scale the game's difficulty. There is also a second value related to suck stored at offset 0x10, but the purpose of that value is currently unknown. It is often incremented at the same time as the first suck value, but the second one is sometimes multiplied by some value to make it bigger or smaller.

Clue values

The level state has two values associated with clue bottles. The first, cclue, is the quantity of clue bottles have been collected in the level. The second, fclue, is a bitfield that keeps track of which specific clue bottles have been collected.

Each bit in fclue corresponds to a specific clue in the map. During a level load, any particular clue bottle will only be spawned in if the corresponding bit is not set.

Dialogue flags

Every LS has an array for storing up to 12 dialogue flags, afDialogPlayed, with each flag corresponding to a specific dialog. Most are Bentley cutscenes but it is also used for things like the PA announcements in the hub maps.

If a dialog flag is set to 0, that dialog will automatically play when Sly enters the associated trigger volume. If the flag is set to 1, then the trigger volume instead causes the L1 popup blot to appear in the lower-left corner, giving the option to replay the dialog.

Scene variables

Every LS has an array for storing up to 4 scene variables. A scene variable consists of two int values comprising an ID and value pair. For instance, in The Swamp’s Dark Center, an ID of 0x693 corresponds to the state of the left candle on the purple voodoo gate, and a value of 1 corresponds to that candle being broken.

When the game sets a scene variable it uses the first available slot on the LS. When the game needs to check the value of a scene variable, it calls a function that takes a map ID and a variable ID, iterating over the array of scene flags on that map’s LS and stops when it finds a match.