Support Structures

These dumb data structures help to give meaningful organization and structure to the information in their respective parent resources.

Entity

class sc2reader.objects.Entity(sid, slot_data)
Parameters:
  • sid (integer) – The entity’s unique slot id.
  • slot_data (dict) – The slot data associated with this entity

Player

class sc2reader.objects.Player(pid, detail_data, attribute_data)
Parameters:
  • pid (integer) – The player’s unique player id.
  • detail_data (dict) – The detail data associated with this player
  • attribute_data (dict) – The attribute data associated with this player

User

class sc2reader.objects.User(uid, init_data)
Parameters:
  • uid (integer) – The user’s unique user id
  • init_data (dict) – The init data associated with this user
url

The player’s formatted Battle.net profile url

Observer

class sc2reader.objects.Observer(sid, slot_data, uid, init_data, pid)

Extends Entity and User.

Parameters:
  • sid (integer) – The entity’s unique slot id.
  • slot_data (dict) – The slot data associated with this entity
  • uid (integer) – The user’s unique user id
  • init_data (dict) – The init data associated with this user
  • pid (integer) – The player’s unique player id.

Computer

class sc2reader.objects.Computer(sid, slot_data, pid, detail_data, attribute_data)

Extends Entity and Player

Parameters:
  • sid (integer) – The entity’s unique slot id.
  • slot_data (dict) – The slot data associated with this entity
  • pid (integer) – The player’s unique player id.
  • detail_data (dict) – The detail data associated with this player
  • attribute_data (dict) – The attribute data associated with this player

Participant

class sc2reader.objects.Participant(sid, slot_data, uid, init_data, pid, detail_data, attribute_data)

Extends Entity, User, and Player

Parameters:
  • sid (integer) – The entity’s unique slot id.
  • slot_data (dict) – The slot data associated with this entity
  • uid (integer) – The user’s unique user id
  • init_data (dict) – The init data associated with this user
  • pid (integer) – The player’s unique player id.
  • detail_data (dict) – The detail data associated with this player
  • attribute_data (dict) – The attribute data associated with this player

Team

class sc2reader.objects.Team(number)

The team object primarily a container object for organizing Player objects with some metadata. As such, it implements iterable and can be looped over like a list.

Parameters:number (interger) – The team number as recorded in the replay
lineup

A string representation of the team play races like PP or TPZZ. Random pick races are not reflected in this string

PlayerSummary

class sc2reader.objects.PlayerSummary(pid)

Resents a player as loaded from a GameSummary file.

Graph

class sc2reader.objects.Graph(x, y, xy_list=None)

A class to represent a graph on the score screen. Derived from data in the GameSummary file.

as_points()

Get the graph as a list of (x, y) tuples

MapInfo

class sc2reader.objects.MapInfo(contents)

Represents the data encoded into the MapInfo file inside every SC2Map archive

MapInfoPlayer

class sc2reader.objects.MapInfoPlayer(pid, control, color, race, unknown, start_point, ai, decal)

Describes the player data as found in the MapInfo document of SC2Map archives.