All resources are loaded through the SC2BnetFactory and resource helper methods.
Parameters: |
|
---|
A dict of achivementId -> Achievement containing all possible achievements. Lazy loaded and cached in the factory locale.
A nested dict of url -> offset -> Icon containing all possible icons. Lazy loaded and cached in the factory locale.
Load a new Ladder from the given id. Ladders are not cached.
Load a new PlayerProfile using the given options. Profiles are not cached.
Parameters: |
|
---|
This class should not be manually constructed, use SC2BnetFactory.load_profile().
Create a new PlayerProfile with basic data. No web API calls are made by default. The load_details(), load_ladders(), and load_matches() methods can be used to pull additional information from the Battle.net API.
A dict category -> points that breaks the total achievement points down by category.
A dict of achivement -> completion date for achivements completed by this player.
The name of the clan the player belongs to.
The tag of the clan the player belongs to.
The player’s overall character level.
The reference to the Season object for the current season
The number of games played this season
The current season number
The difficulty level used to complete the HotS campaign: CASUAL, NORMAL, HARD, or BRUTAL
The character’s unique Battle.net id.
The html profile page on Battle.net
Loads the majority of the player profile data. Everything except for current_season, previous_season, and recent_matches.
Loads the current and previous season ladder data into current_season and previous_season respectively.
Loads recent matches into the recent_matches attribute.
The character’s current name
The reference to the Season object for the previous season
One of ZERG, PROTOSS, TERRAN, or RANDOM
The player’s Protoss character level.
The player’s current XP progress to the next Protoss level. -1 if at max level.
The player’s total Protoss XP
Total career Protoss wins.
The id for the character’s home realm in the region
A list of recent matches played by the player
The region of Battle.net this character belongs to
A list of rewards this player has earned
A list of the earned rewards selected to be showcased.
The player’s Terran character level.
The player’s current XP progress to the next Terran level. -1 if at max level.
The player’s total Terran XP
Total career Terran wins.
The total point value of all achievements completed by this player.
Total career games played.
The difficulty level used to complete the WoL campaign: CASUAL, NORMAL, HARD, or BRUTAL
The player’s Zerg character level.
The player’s current XP progress to the next Zerg level. -1 if at max level.
The player’s total Zerg XP
Total career Zerg wins.
Represents a single ladder in a single season.
A boolean flag that is true of the team is arranged team. False if the team was partially random. None if not known
The division id of the ladder
The expansion the ladder is linked to. “” if it cannot be determined.
The unique integer id for the ladder
The league of the ladder: BRONZE, SILVER, GOLD, PLATINUM, DIAMOND, MASTER, GRANDMASTER
The name of the ladder
The queue this ladder draws opponents from.
A dict mapping rank -> LadderRanking
A list of LadderRanking on the ladder.
The region the ladder is active on
The type of teams for the ladder; 1v1, 2v2, 3v3, 4v4 (FFA is unranked). 0v0 if can’t be determined.
Represents a battle.net achievement
The id of the achievement’s category.
The description of the achievement.
The achievement’s unique id.
The number of points granted by the achievement
The title of the achievement.
Represents a Battle.net reward.
A reference to the Achievement that unlocks this reward. None if none needed.
The unique id of the achievement that unlocks this reward
The unique id for this reward
The title of this award
Represents the ranked ladder activity for a single person in one season on one region.
The season number
A backreference to the PlayerProfile this season is for
A list of LadderRanking references for ladder rankings this season
Region this season is active on
Represents a ladder ranking for a team. Depending on how the ladder ranking was loaded, different attributes are available.
The highest team rank. 0 if not available
The time the team joined the ladder. None if not available
The current loss total.
The team’s current point total. 0 if not available
The previous team rank. 0 if not available
The current team rank.
The current win total.
Represents a collection of players playing on a ranked ladder in one season.
A list of PlayerProfile references for members of the team
A list of LadderRanking references for ranks achieved by this team in this season.
The region this team is active in
Represents a single match played by a player.
The date the match was played (in UTC?)
The map the match was played on
The result of the match for the player. One of: WIN, LOSS, ??.
The effective game speed during the match. Generally FASTER.
The type of match that was played. One of:
- CUSTOM - Arcade map
- CO_OP - VS AI
- THREES - 3v3 (can it tell between HotS and WoL?)
- ???
Represents a single ladder in a single season.
A boolean flag that is true of the team is arranged team. False if the team was partially random. None if not known
The division id of the ladder
The expansion the ladder is linked to. “” if it cannot be determined.
The unique integer id for the ladder
The league of the ladder: BRONZE, SILVER, GOLD, PLATINUM, DIAMOND, MASTER, GRANDMASTER
Load additional ladder details from the Web API.
The name of the ladder
The queue this ladder draws opponents from.
A dict mapping rank -> LadderRanking
A list of LadderRanking on the ladder.
The region the ladder is active on
The type of teams for the ladder; 1v1, 2v2, 3v3, 4v4 (FFA is unranked). 0v0 if can’t be determined.
Represents an icon embedded in a compound image.
TODO: Extract the actual icon, cache the compound image.
The height of the icon
The index of the icon in an imaginary array of icon images counting from left to right, top to bottom on the linked compound image.
The working title for the icon
The of the compound image the icon is contained in.
The width of the icon
The x shift on the linked compound image for the top left corner of the icon
The y shift on the linked compound image for the top left corner of the icon