Skip to content

Latest commit

 

History

History
48 lines (24 loc) · 1.82 KB

MatchSimple.md

File metadata and controls

48 lines (24 loc) · 1.82 KB

TbaApiV3client.MatchSimple

Properties

Name Type Description Notes
key String TBA match key with the format `yyyy[EVENT_CODE]_[COMP_LEVEL]m[MATCH_NUMBER]`, where `yyyy` is the year, and `EVENT_CODE` is the event code of the event, `COMP_LEVEL` is (qm, ef, qf, sf, f), and `MATCH_NUMBER` is the match number in the competition level. A set number may append the competition level if more than one match in required per set.
compLevel String The competition level the match was played at.
setNumber Number The set number in a series of matches where more than one match is required in the match series.
matchNumber Number The match number of the match in the competition level.
alliances MatchSimpleAlliances [optional]
winningAlliance String The color (red/blue) of the winning alliance. Will contain an empty string in the event of no winner, or a tie. [optional]
eventKey String Event key of the event the match was played at.
time Number UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of the scheduled match time, as taken from the published schedule. [optional]
predictedTime Number UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of the TBA predicted match start time. [optional]
actualTime Number UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of actual match start time. [optional]

Enum: CompLevelEnum

  • qm (value: "qm")

  • ef (value: "ef")

  • qf (value: "qf")

  • sf (value: "sf")

  • f (value: "f")

Enum: WinningAllianceEnum

  • red (value: "red")

  • blue (value: "blue")

  • empty (value: "")