Match Detail Models¶
At the match level, some additional models are provided for teams (Roster
),
players (Participant
), and metadata (Asset
). These objects are
automatically created whenever instantiating a Match
object, and they will
each expose attributes that link each other where appropriate.
Participant
instances can also be used to generate higher level
Player
and PlayerSeason
instances.
Match
instances can be used to create Telemetry
instances.
See Telemetry Models for more details.
-
class
chicken_dinner.models.match.
Match
(pubg, match_id, shard=None)[source]¶ Match object.
- Parameters
pubg – a PUBG instance
match_id (str) – the
match_id
for this matchshard (str) – the shard for this match
-
property
asset_id
¶ The asset id for this match.
-
property
created_at
¶ When the match was created.
-
property
data
¶ The data payload from the response for this match.
-
property
duration
¶ The duration of the match.
-
property
game_mode
¶ The game mode for the match.
-
get_telemetry
(map_assets=False)[source]¶ Download match telemetry and create a Telemetry object instance.
- Parameters
map_assets (bool) – whether to map asset ids to named values, e.g. map
Item_Weapon_AK47_C
toAKM
.- Returns
a
chicken_dinner.models.telemetry.Telemetry
instance for this match.
-
property
id
¶ The match id.
-
property
is_custom
¶ Whether or not the match is a custom match.
-
property
map_id
¶ The map id on which this match was played.
-
property
map_name
¶ The name of the map on which this match was played.
-
match_id
= None¶ The match id for this match
-
property
participants
¶ A list of Participant instances for match participants.
-
response
= None¶ The API response for this object
-
rosters
= None¶ A list of Roster instances for this match
-
property
rosters_player_names
¶ A mapping of roster_ids to player names for this match.
-
property
shard
¶ The shard for this match.
-
property
stats
¶ Stats for this match.
Tags associated with this match.
-
property
telemetry_url
¶ The URL for the telemetry data for this match.
-
property
title_id
¶ The title id associated with this match.
-
property
url
¶ The URL for this match resource.
-
property
winner
¶ The Roster instance for the winner of this match.
-
class
chicken_dinner.models.match.
Roster
(pubg, match, data, shard=None)[source]¶ Roster model.
- Parameters
pubg – a PUBG instance
match – the match object associated with this roster
data – the data payload associated with this roster response object
shard (str) – the shard for the match associated with this roster
-
data
= None¶ The data payload associated with this Roster
-
property
id
¶ The roster id.
-
match
= None¶ The Match instance for this roster
-
property
participant_ids
¶ A list of match-specific participant ids for this roster.
-
participants
= None¶ A list of Participant instances for this roster
-
property
player_ids
¶ A list of player account ids for this roster.
-
property
player_names
¶ A list of player names for this roster.
-
property
shard
¶ The shard for the match associated with this roster.
-
stats
= None¶ Stats for this roster
-
property
won
¶ Whether or not this roster won the associated match.
-
class
chicken_dinner.models.match.
Participant
(pubg, match, roster, data, shard=None)[source]¶ Participant model.
- Parameters
pubg – a PUBG instance
match – the match object associated with this participant
roster – the roster object associated with this participant
data – the data payload from the participant response object
shard (str) – the shard for the match for this participant
-
data
= None¶ The data payload associated with this participant
-
get_player_season
(season_id)[source]¶ Get a PlayerSeason object for this participant.
- Parameters
season_id (str) – the season id for which to retreive data
-
property
id
¶ The player’s account id.
-
match
= None¶ The Match instance associated with this participant
-
property
name
¶ The player’s in-game name.
-
property
participant_id
¶ The match specific participant id of the player.
-
property
player_id
¶ The player’s account id.
-
roster
= None¶ The Roster instance associated with this participant
-
property
shard
¶ The shard for the match associated with this participant.
-
stats
= None¶ Stats associated with this participant
-
property
teammates
¶ A list of participant objects for this player’s teammates.
-
property
teammates_player_ids
¶ A list of player account ids for this player’s teammates.
-
property
teammates_player_names
¶ A list of player names for this player’s teammates.
-
property
won
¶ Whether or not this player’s team won the associated match.
-
class
chicken_dinner.models.match.
Asset
(pubg, match, data, shard=None)[source]¶ Match asset model.
- Parameters
pubg – a
PUBG
instancematch – a
Match
instance associated with this assetdata – the data payload for this asset
shard (str) – the shard for this match
-
property
created_at
¶ When the asset was created.
-
data
= None¶ The data payload associated with this asset
-
property
description
¶ A description of the asset.
-
property
id
¶ The asset id.
-
match
= None¶ The Match object for this asset
-
property
shard
¶ The shard for the match associated with this asset.
-
property
url
¶ The URL of the asset.