sl2.roster Namespace Reference

Functions
	parse_roster (menu_data, game)
	Read the character roster from a DS3 or ER header entry.

Variables
dict	ROSTER_PARAMS
	Header-entry index, occupancy-flag offset, first-descriptor offset, descriptor stride, and max name length, per game.

Detailed Description

The header roster block: character names, and DS3's play-time field.

Function Documentation

parse_roster()

sl2.roster.parse_roster	(		menu_data,
			game
	)

Read the character roster from a DS3 or ER header entry.

These games keep a load-screen table of ten slots — an occupancy byte each, then fixed-stride descriptors that begin with the character name. That name is trustworthy; the deeper stat and inventory blocks are not mapped in this build, so only the roster is returned.

Parameters

menu_data	The decrypted header entry.
game	"ds3" or "er".

Returns

A list of (slot_index, name).

Definition at line 37 of file roster.py.

Variable Documentation

ROSTER_PARAMS

dict sl2.roster.ROSTER_PARAMS

Initial value:

=  {
    "ds3": {
        "menu": 10,
        "occ": 4244,
        "desc": 4254,
        "stride": 554,
        "namelen": 16,
        "decrypt": DS3_KEY,
    },
    "er": {
        "menu": 10,
        "occ": 6484,
        "desc": 6494,
        "stride": 588,
        "namelen": 16,
        "decrypt": None,
    },
}

Header-entry index, occupancy-flag offset, first-descriptor offset, descriptor stride, and max name length, per game.

Definition at line 8 of file roster.py.