better docs for IR function parameters
This commit is contained in:
parent
509dd46e37
commit
e9908b6014
|
@ -0,0 +1,69 @@
|
||||||
|
-- IR State enum
|
||||||
|
---@class States
|
||||||
|
local States = {
|
||||||
|
Unused = 0,
|
||||||
|
Pending = 10,
|
||||||
|
Success = 20,
|
||||||
|
Accepted = 22,
|
||||||
|
BadRequest = 40,
|
||||||
|
Unauthorized = 41,
|
||||||
|
ChartRefused = 42,
|
||||||
|
Forbidden = 43,
|
||||||
|
NotFound = 44,
|
||||||
|
ServerError = 50,
|
||||||
|
RequestFailure = 60
|
||||||
|
}
|
||||||
|
|
||||||
|
---@class IRData
|
||||||
|
---@field Active boolean # USC IR configured and active
|
||||||
|
---@field States States # IR reposonse state enum
|
||||||
|
IRData = {}
|
||||||
|
|
||||||
|
---@class IRHeartbeatResponseBody
|
||||||
|
---@field serverTime integer
|
||||||
|
---@field serverName string
|
||||||
|
---@field irVersion string
|
||||||
|
IRHeartbeatResponseBody = {}
|
||||||
|
|
||||||
|
---@class IRRecordResponseBody
|
||||||
|
---@field record IRScore
|
||||||
|
IRRecordResponseBody = {}
|
||||||
|
|
||||||
|
---@class IRLeaderboardResponseBody
|
||||||
|
---@field scores IRScore[]
|
||||||
|
IRLeaderboardResponseBody = {}
|
||||||
|
|
||||||
|
---@class IRResponse
|
||||||
|
---@field statusCode integer
|
||||||
|
---@field description string
|
||||||
|
---@field body nil|IRHeartbeatResponseBody|IRRecordResponseBody|IRLeaderboardResponseBody
|
||||||
|
IRResponse = {}
|
||||||
|
|
||||||
|
-- Performs a Heartbeat request.
|
||||||
|
---@param callback fun(res: IRResponse) # Callback function receives IRResponse as it's first parameter
|
||||||
|
local function Heartbeat(callback) end
|
||||||
|
|
||||||
|
-- Performs a Chart Tracked request for the chart with the provided hash.
|
||||||
|
---@param hash string # song hash
|
||||||
|
---@param callback fun(res: IRResponse) # Callback function receives IRResponse as it's first parameter
|
||||||
|
local function ChartTracked(hash, callback) end
|
||||||
|
|
||||||
|
-- Performs a Record request for the chart with the provided hash.
|
||||||
|
---@param hash string # song hash
|
||||||
|
---@param callback fun(res: IRResponse) # Callback function receives IRResponse as it's first parameter
|
||||||
|
local function Record(hash, callback) end
|
||||||
|
|
||||||
|
-- Performs a Leaderboard request for the chart with the provided hash, with parameters mode and n.
|
||||||
|
---@param hash string # song hash
|
||||||
|
---@param mode "best"|"rivals" # request leaderboard mode
|
||||||
|
---@param n integer # limit the number of requested scores
|
||||||
|
---@param callback fun(res: IRResponse) # Callback function receives IRResponse as it's first parameter
|
||||||
|
local function Leaderboard(hash, mode, n, callback) end
|
||||||
|
|
||||||
|
---@type table
|
||||||
|
IR = {
|
||||||
|
Heartbeat = Heartbeat,
|
||||||
|
ChartTracked = ChartTracked,
|
||||||
|
Record = Record,
|
||||||
|
Leaderboard = Leaderboard
|
||||||
|
}
|
Loading…
Reference in New Issue