GTMS/types.js at master · gregk27/GTMS · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/**
 * @typedef {{
 *  number: number,
 *  name: string
 * }} Team
 *
 * @typedef {{
 *  id: number,
 *  type: string,
 *  number: number,
 *  redTeam: number,
 *  redScore: number,
 *  redName?: number
 *  blueTeam: number,
 *  blueScore: number,
 *  blueName?: number
 * }} Match
 *
 * @typedef {{
 *  num: number,
 *  name: string,
 *  score: number,
 *  metA: number,
 *  metB: number
 * }} ActiveAlliance
 *
 * @typedef {{
 *   name: string,
 *   duration: number,
 *   endTime: number,
 *   running: boolean,
 *   saved: boolean,
 *   id: number,
 *   red: ActiveAlliance,
 *   blue: ActiveAlliance
 * }} ActiveMatch
 *
 * @typedef {{
 *  number: number,
 *  name: string,
 *  wins: number,
 *  losses: number,
 *  ties: number,
 *  score: number,
 *  metA: number,
 *  metB: number,
 *  numMatches: number,
 *  rp: number,
 *  rpa: number,
 *  scoreAvg: number,
 * }} TeamScore
 *
 * @typedef {{
 *  time: number,
 *  source: string,
 * }} MatchSound
 *
 * @typedef {{
 *  text: string,
 *  score?: number,
 *  metA?: number,
 *  metB?: number,
 *  spaceBefore?: number,
 *  spaceAfter?: number
 * }} Button
 *
 * @typedef {{
 *  name: string,
 *  width: number,
 *  func: (t:TeamScore) => string
 * }} Column
 *
 * @typedef {{
 *  port:number,
 *  authString: string,
 *  initScript: string,
 *  matchLength: number,
 *  freezeDelay: number,
 *  audio: {
 *      leadTime: number,
 *      interrupted: string,
 *      sequence: MatchSound[],
 *  },
 *  scoreboard: {
 *      duration: number,
 *      rankCol: Column,
 *      data: Column[][]
 *  },
 *  postgame: {
 *      breakdown: {name:string, func: (a:ActiveAlliance) => string}[]
 *  },
 *  buttons: (Button | Button[])[],
 *  rankPointFunction: (t:TeamScore) => string,
 *  sortFunction: (a:TeamScore, b:TeamScore) => number,
 * }} Config
 */