sc2_datasets.replay_parser.game_events.events.nested.delta

Classes

AddSubgroups

AddSubgroups is a data type holding information about some subgroup change.

Delta

Most likely specifies a change in which units belong to some subgroups.

Module Contents

class AddSubgroups(count: int, intraSubgroupPriority: int, subgroupPriority: int, unitLink: int)

Bases: sc2_datasets.replay_parser.game_events.game_event.GameEvent

AddSubgroups is a data type holding information about some subgroup change. The exact meaning or context of its attributes remains unclear.

Parameters:
  • count (int) – Specifies some unknown count parameter.

  • intraSubgroupPriority (int) – Specifies some priority within the intra subgroup.

  • subgroupPriority (int) – Specifies some subgroup priority.

  • unitLink (int) – Most likely specifies which units were affected.

static from_dict(d: dict) AddSubgroups

Abstract method that returns a GameEvent object. This method aids in implementation, specifically in the context of parsing original JSON data.

Parameters:

d (Dict) – A dictionary obtained from pre-processing an .SC2Replay file, available in the JSON format.

Raises:

NotImplementedError – If the method remains unimplemented, this error is raised.

Returns:

A method sheet that must be implemented.

Return type:

GameEvent

count
intraSubgroupPriority
subgroupPriority
class Delta(addSubgroups: list[AddSubgroups], addUnitTags: list[int], removeMask: types.NoneType, subgroupIndex: int)

Bases: sc2_datasets.replay_parser.game_events.game_event.GameEvent

Most likely specifies a change in which units belong to some subgroups. The exact definition of this data type remains unclear.

Parameters:
  • addSubgroups (AddSubgroups) – Most likely specifies a class with additional information on which subgroups were added.

  • addUnitTags (list[int]) – Most likely specifies which unit tags were added to a subgroup.

  • removeMask (NoneType) – This is an unknown parameter. We were not able to interpret it.

  • subgroupIndex (int) – Most likely specifies which subgroup was changed.

static from_dict(d: dict) Delta

Abstract method that returns a GameEvent object. This method aids in implementation, specifically in the context of parsing original JSON data.

Parameters:

d (Dict) – A dictionary obtained from pre-processing an .SC2Replay file, available in the JSON format.

Raises:

NotImplementedError – If the method remains unimplemented, this error is raised.

Returns:

A method sheet that must be implemented.

Return type:

GameEvent

addSubgroups
addUnitTags
removeMask
subgroupIndex