-
Notifications
You must be signed in to change notification settings - Fork 1
/
TimingData.lua
223 lines (195 loc) · 9.09 KB
/
TimingData.lua
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
---@meta
--- ## Note with functions
--- GetBPMsAndTimes, GetStops, GetDelays, GetLabels, GetWarps, GetCombos, GetTimeSignatures, GetTickcounts,
--- GetFakes, GetScrolls, GetXScrolls, and GetSpeeds all have two different modes.
---
--- If false (or nothing) is the first argument to these functions, they return tables of strings.
--- The strings are numbers separated by '='.
---
--- If the argument is true, they return tables of tables, and the inner tables contain numbers as described
--- for each function.
---
--- The first form is kept around and is the default for compatibility with older themes.
--- The advantage of the second form is that you no longer need to have a bit of code in your theme
--- to transform the string into a table of numbers before you can use it.
---
--- ### Example
--- ```lua
--- local bpmsand= timing_data:GetBPMsAndTimes()
--- for i, s in ipairs(bpmsand) do
--- local sand= split("=", s)
--- bpmsand[i]= {tonumber(sand[1]), tonumber(sand[2])}
--- end
--- -- do something that looks at all the bpms and times.
--- -- Becomes:
--- local bpmsand= timing_data:GetBPMsAndTimes(true)
--- ```
---@class TimingData TimingDataInfo
TimingData = {}
---Returns the minimum and maximum BPM of the song in a table (in that order).
---@returns number[]
function TimingData:GetActualBPM() end
---Returns the beat from fElapsedTime.
---@returns number
function TimingData:GetBeatFromElapsedTime(fElapsedTime) end
---Returns the BPM at fBeat.
---@returns number[]
function TimingData:GetBPMAtBeat(fBeat) end
---Returns a table of the BPMs as floats.
---@returns number[]
function TimingData:GetBPMs() end
--- Returns a table of the BPMs and the times they happen as tables.
--- The first value is the beat. The second value is the bpm.
---
--- The `useTable` parameter is optional. It can be used to return the
--- values as a table, instead of a string separated by '='. This parameter is recommended.
---
---@see TimingData # for an explanation for why the classic method is still used first.
---@param useTable? boolean
---@return number[][]
function TimingData:GetBPMsAndTimes(useTable) end
--- Returns the elapsed time from `fBeat`.
---@param fBeat number
---@return number
function TimingData:GetElapsedTimeFromBeat(fBeat) end
--- Returns a table of the Stops and the times they happen as tables.
--- The first value is the beat. The second value is the length.
---
--- The `useTable` parameter is optional. It can be used to return the
--- values as a table, instead of a string separated by '='. This parameter is recommended.
---
---@see TimingData # for an explanation for why the classic method is still used first.
---@param useTable? boolean
---@return number[][]
function TimingData:GetStops(useTable) end
--- Returns a table of the Delays and the times they happen as tables.
--- The first value is the beat. The second value is the length.
---
--- The `useTable` parameter is optional. It can be used to return the
--- values as a table, instead of a string separated by '='. This parameter is recommended.
---
---@see TimingData # for an explanation for why the classic method is still used first.
---@param useTable? boolean
---@return number[][]
function TimingData:GetDelays(useTable) end
--- Returns a table of the Labels and the times they happen as tables.
--- The first value is the beat. The second value is the label.
---
--- The `useTable` parameter is optional. It can be used to return the
--- values as a table, instead of a string separated by '='. This parameter is recommended.
---
---@see TimingData # for an explanation for why the classic method is still used first.
---@param useTable? boolean
---@return number[][]
function TimingData:GetLabels(useTable) end
--- Returns a table of the Warps and the times they happen as tables.
--- The first value is the beat. The second value is the number of beats to warp over.
---
--- The `useTable` parameter is optional. It can be used to return the
--- values as a table, instead of a string separated by '='. This parameter is recommended.
---
---@see TimingData # for an explanation for why the classic method is still used first.
---@param useTable? boolean
---@return number[][]
function TimingData:GetWarps(useTable) end
--- Returns a table of the Combos and the times they happen as tables.
--- The first value is the beat. The second value is the combo. The third value is the miss combo.
---
--- The `useTable` parameter is optional. It can be used to return the
--- values as a table, instead of a string separated by '='. This parameter is recommended.
---
---@see TimingData # for an explanation for why the classic method is still used first.
---@param useTable? boolean
---@return number[][]
function TimingData:GetCombos(useTable) end
--- Returns a table of the Time Signatures and the times they happen as tables.
--- The first value is the beat. The second value is the numerator. The third value is the denominator.
---
--- The `useTable` parameter is optional. It can be used to return the
--- values as a table, instead of a string separated by '='. This parameter is recommended.
---
---@see TimingData # for an explanation for why the classic method is still used first.
---@param useTable? boolean
---@return number[][]
function TimingData:GetTimeSignatures(useTable) end
--- Returns a table of the Tickcounts and the times they happen as tables.
--- The first value is the beat. The second value is the number of ticks per beat.
---
--- The `useTable` parameter is optional. It can be used to return the
--- values as a table, instead of a string separated by '='. This parameter is recommended.
---
---@see TimingData # for an explanation for why the classic method is still used first.
---@param useTable? boolean
---@return number[][]
function TimingData:GetTickcounts(useTable) end
--- Returns a table of the Fakes and the times they happen as tables.
--- The first value is the beat. The second value is the number of beats to not judge.
---
--- The `useTable` parameter is optional. It can be used to return the
--- values as a table, instead of a string separated by '='. This parameter is recommended.
---
---@see TimingData # for an explanation for why the classic method is still used first.
---@param useTable? boolean
---@return number[][]
function TimingData:GetFakes(useTable) end
--- Returns a table of the Scrolls and the times they happen as tables.
--- The first value is the beat. The second value is the scroll rate ratio.
---
--- The `useTable` parameter is optional. It can be used to return the
--- values as a table, instead of a string separated by '='. This parameter is recommended.
---
---@see TimingData # for an explanation for why the classic method is still used first.
---@param useTable? boolean
---@return number[][]
function TimingData:GetScrolls(useTable) end
--- Returns a table of the XScrolls and the times they happen as tables.
--- The first value is the beat. The second value is the horizontal scroll rate ratio.
---
--- The `useTable` parameter is optional. It can be used to return the
--- values as a table, instead of a string separated by '='. This parameter is recommended.
---
---@see TimingData # for an explanation for why the classic method is still used first.
---@param useTable? boolean
---@return number[][]
function TimingData:GetXScrolls(useTable) end
--- Returns a table of the Speeds and the times they happen as tables.
--- The first value is the beat. The second value is the scroll rate ratio. The third value is the length of time to fully activate. The fourth value is the unit of activation (0 for beats, 1 for seconds).
---
--- The `useTable` parameter is optional. It can be used to return the
--- values as a table, instead of a string separated by '='. This parameter is recommended.
---
---@see TimingData # for an explanation for why the classic method is still used first.
---@param useTable? boolean
---@return number[][]
function TimingData:GetSpeeds(useTable) end
--- Returns `true` if the TimingData contains BPM changes.
---@return boolean
function TimingData:HasBPMChanges() end
--- Returns `true` if the TimingData contains delays.
---@return boolean
function TimingData:HasDelays() end
--- Returns `true` if the TimingData contains any BPM changes with a negative BPM.
---@return boolean
function TimingData:HasNegativeBPMs() end
--- Returns `true` if the TimingData contains stops.
---@return boolean
function TimingData:HasStops() end
--- Returns `true` if the TimingData contains warps.
---@return boolean
function TimingData:HasWarps() end
--- returns `true` if the TimingData contains fake segments.
---@return boolean
function TimingData:HasFakes() end
--- Returns `true` if the TimingData contains speed scrolling changes.
---@return boolean
function TimingData:HasSpeedChanges() end
--- Returns `true` if the TimingData contains general scrolling changes.
---@return boolean
function TimingData:HasScrollChanges() end
--- Returns `true` if the TimingData contains horizontal scrolling changes.
---@return boolean
function TimingData:HasXScrollChanges() end
--- Returns true if the current beat is valid for judgment detection.
---@param fBeat number
---@return boolean
function TimingData:IsJudgableAtBeat(fBeat) end