From e9908b601406d6c570bbbd06278585ccb2547a37 Mon Sep 17 00:00:00 2001
From: Hersi <atillacsa@gmail.com>
Date: Sun, 24 Apr 2022 00:06:48 +0200
Subject: [PATCH] better docs for IR function parameters

---
 docs/lua_api/IR.lua | 69 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 docs/lua_api/IR.lua

diff --git a/docs/lua_api/IR.lua b/docs/lua_api/IR.lua
new file mode 100644
index 0000000..9ee25ac
--- /dev/null
+++ b/docs/lua_api/IR.lua
@@ -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
+}
\ No newline at end of file