sc2_datasets.replay_parser.game_events.events.cmd

Classes

Cmd

Cmd contains specific details about command interface events.

Module Contents

class Cmd

Bases: sc2_datasets.replay_parser.game_events.game_event.GameEvent

Cmd contains specific details about command interface events.

Parameters:

  • id (int) – Specifies the ID of an event corresponding to its name.

  • loop (int) – Specifies the game loop number (game-engine tick) at which the event occurred.

  • otherUnit (NoneType) – Specific information unavailable about this parameter.

  • sequence (int) – Likely specifies an ID parameter representing the sequence the user typed in the console. Specific information about this parameter is unavailable.

  • unitGroup (NoneType or int) – Specific information unavailable about this parameter.

  • userid (int) – Likely specifies the user’s ID using the interface. Specific information about this parameter is unavailable.

id: int
loop: int
otherUnit: types.NoneType
sequence: int
unitGroup: types.NoneType | int
userid: int
static from_dict(d: dict) → Cmd

Static method returning an initialized Cmd class from a dictionary. This aids in parsing the original JSON.

Parameters:

d (dict) – Dictionary available in the JSON file, typically a result of pre-processing an .SC2Replay file.

Returns:

Initialized Cmd class.

Return type:

Cmd