clear lua linting errors and warnings in songwheel.lua

fix(?) volforce indicator

scripts/songselect/songwheel.lua

@@ -135,7 +135,7 @@ local top50diffs = {}
 
 local irRequestStatus = 1 -- 0=unused, 1=not requested, 2=loading, others are status codes
 local irRequestTimeout = 2
-local irLeaderboard = {}
+local irLeaderboard = {} ---@type ServerScore[]|{}
 local irLeaderboardsCache = {}
 
 local transitionScrollScale = 0
@@ -162,6 +162,7 @@ local transitionSearchInfoEnterScale = 0
 local transitionSearchBackgroundAlpha = 0
 local transitionSearchbarOffsetY = 0
 local transitionSearchInfoOffsetY = 0
+local transitionSearchBackgroundInfoAlpha = Easing.inOutQuad(transitionSearchInfoEnterScale)
 
 local transitionLaserScale = 0
 local transitionLaserY = 0
@@ -199,8 +200,8 @@ local resolutionChange = function(x, y)
     game.Log('resX:' .. resX .. ' // resY:' .. resY .. ' // fullX:' .. fullX .. ' // fullY:' .. fullY, game.LOGGER_ERROR)
 end
 
-function getCorrectedIndex(from, offset) 
+local function getCorrectedIndex(from, offset)
-	total = #songwheel.songs
+    local total = #songwheel.songs
 
     if (math.abs(offset) > total) then
         if (offset < 0) then
@@ -210,21 +211,21 @@ function getCorrectedIndex(from, offset)
         end
     end
 
-	index = from + offset
+    local index = from + offset
 
     if index < 1 then
         index = total + (from+offset) -- this only happens if the offset is negative
     end
 
     if index > total then
-		indexesUntilEnd = total - from
+        local indexesUntilEnd = total - from
         index = offset - indexesUntilEnd -- this only happens if the offset is positive
     end
 
     return index
 end
 
-function getJacketImage(song)
+local function getJacketImage(song)
     if not jacketCache[song.id] or jacketCache[song.id]==defaultJacketImage then
         jacketCache[song.id] = gfx.LoadImageJob(song.difficulties[
             math.min(selectedDifficulty, #song.difficulties)
@@ -234,7 +235,7 @@ function getJacketImage(song)
     return jacketCache[song.id]
 end
 
-function getGradeImageForScore(score)
+local function getGradeImageForScore(score)
     local gradeImage = gradeImages.none
     local bestGradeCutoff = 0
     for gradeName, scoreCutoff in pairs(gradeCutoffs) do
@@ -249,7 +250,7 @@ function getGradeImageForScore(score)
     return gradeImage
 end
 
-function drawLaserAnim()
+local function drawLaserAnim()
     gfx.Save()
     gfx.BeginPath()
 
@@ -260,7 +261,7 @@ function drawLaserAnim()
     gfx.Restore()
 end
 
-function drawBackground(deltaTime)
+local function drawBackground(deltaTime)
     Background.draw(deltaTime)
 
     local song = songwheel.songs[selectedIndex]
@@ -273,7 +274,6 @@ function drawBackground(deltaTime)
             gfx.BeginPath()
             gfx.ImageRect(transitionJacketBgScrollPosX, 0, 900, 900, jacketImage or defaultJacketImage, transitionJacketBgScrollAlpha, 0)
 
-            
             gfx.BeginPath()
             gfx.FillColor(0,0,0,math.floor(transitionJacketBgScrollAlpha*64))
             gfx.Rect(0,0,900,900)
@@ -304,7 +304,9 @@ function drawBackground(deltaTime)
 
 end
 
-function drawSong(song, y)
+---@param song SongWheelSong
+---@param y number
+local function drawSong(song, y)
     if (not song) then return end
 
     local songX = desw/2+28
@@ -376,13 +378,13 @@ function drawSong(song, y)
     gfx.ImageRect(songX+391, y+47, 60, 60, gradeImage, gradeAlpha, 0)
 
     -- Draw top 50 label if applicable
-    if (top50diffs[selectedSongDifficulty.id]) then
+    if (top50diffs[selectedSongDifficulty.hash]) then
         gfx.BeginPath()
         gfx.ImageRect(songX+82, y+109, 506*0.85, 26*0.85, top50OverlayImage, 1, 0)
     end
 end
 
-function drawSongList()
+local function drawSongList()
     gfx.GlobalAlpha(1-transitionLeaveScale)
 
     local numOfSongsAround = 7 -- How many songs should be up and how many should be down of the selected one
@@ -409,131 +411,8 @@ function drawSongList()
     gfx.GlobalAlpha(1)
 end
 
-function drawData() -- Draws the song data on the left panel
-
-    if isFilterWheelActive or transitionLeaveReappearTimer ~= 0 then return false end
-
-    local song = songwheel.songs[selectedIndex]
-    local diff = song and song.difficulties[selectedDifficulty] or false
-    local bestScore = diff and diff.scores[1]
-
-    if not song then return false end
-
-    local jacketImage = getJacketImage(song)
-    gfx.BeginPath()
-    gfx.ImageRect(96, 324, 348, 348, jacketImage or defaultJacketImage, 1, 0)
-    
-    if (top50diffs[diff.id]) then
-        gfx.BeginPath()
-        gfx.ImageRect(96, 529, 410*0.85, 168*0.85, top50JacketOverlayImage, 1, 0)
-    end
-
-    -- Draw best score
-    gfx.Save()
-    gfx.BeginPath()
-
-    local scoreNumber = 0
-    if bestScore then 
-        scoreNumber = bestScore.score
-    end
-
-    Numbers.draw_number(100, 793, 1.0, math.floor(scoreNumber / 10000), 4, scoreNumbers, true, 0.3, 1.12)
-    Numbers.draw_number(253, 798, 1.0, scoreNumber, 4, scoreNumbers, true, 0.22, 1.12)
-
-    -- Draw grade
-    local gradeImage = gradeImages.none
-    local gradeAlpha = transitionAfterscrollGradeAlpha
-    if bestScore then 
-        gradeImage = getGradeImageForScore(bestScore.score)
-
-        if (transitionAfterscrollGradeAlpha == 1 and bestScore.score >= gradeCutoffs.S) then
-            gradeAlpha = transitionFlashAlpha -- If S, flash the badge
-        end
-    end
-
-    gfx.BeginPath()
-    gfx.ImageRect(360, 773, 45, 45, gradeImage, gradeAlpha, 0)
-
-    -- Draw badge
-    badgeImage = badgeImages[diff.topBadge+1]
-
-    local badgeAlpha = transitionAfterscrollBadgeAlpha
-    if (transitionAfterscrollBadgeAlpha == 1 and diff.topBadge >= 3) then
-        badgeAlpha = transitionFlashAlpha -- If hard clear or above, flash the badge, but only after the initial transition
-    end
-
-    gfx.BeginPath()
-    gfx.ImageRect(425, 724, 93/1.1, 81/1.1, badgeImage, badgeAlpha, 0)
-
-    gfx.Restore()
-
-    -- Draw BPM
-    gfx.Save()
-    gfx.BeginPath()
-    gfx.FontSize(24)
-    gfx.TextAlign(gfx.TEXT_ALIGN_LEFT + gfx.TEXT_ALIGN_MIDDLE)
-    gfx.LoadSkinFont('Digital-Serial-Bold.ttf')
-    gfx.GlobalAlpha(transitionAfterscrollDataOverlayAlpha) -- TODO: split this out
-    gfx.Text(song.bpm, 85, 920)
-    gfx.Restore()
-    
-    -- Draw song title
-    gfx.Save()
-    gfx.FontSize(28)
-    gfx.GlobalAlpha(transitionAfterscrollTextSongTitle)
-    gfx.Text(song.title, 30+(1-transitionAfterscrollTextSongTitle)*20, 955)
-    gfx.Restore()
-    
-    -- Draw artist
-    gfx.Save()
-    gfx.GlobalAlpha(transitionAfterscrollTextSongArtist)
-    gfx.Text(song.artist, 30+(1-transitionAfterscrollTextSongArtist)*30, 997)
-    gfx.Restore()
-
-    -- Draw difficulties
-    local DIFF_X_START = 98.5
-    local DIFF_GAP = 114.8
-    gfx.Save()
-    gfx.GlobalAlpha(transitionAfterscrollDifficultiesAlpha)
-    for i, diff in ipairs(song.difficulties) do
-        gfx.BeginPath()
-
-        local index = diff.difficulty+1
-
-        if i == selectedDifficulty then
-            gfx.ImageRect(DIFF_X_START+(index-1)*DIFF_GAP-(163*0.8)/2, 1028, 163*0.8, 163*0.8, diffCursorImage, 1, 0)
-        end
-
-        Numbers.draw_number(85+(index-1)*DIFF_GAP, 1085, 1.0, diff.level, 2, difficultyNumbers, false, 0.8, 1)
-        
-        local diffLabelImage = difficultyLabelUnderImages[
-            Charting.GetDisplayDifficulty(diff.jacketPath, diff.difficulty)
-        ]
-        local tw, th = gfx.ImageSize(diffLabelImage)
-        tw=tw*0.9
-        th=th*0.9
-        gfx.BeginPath()
-        gfx.ImageRect(DIFF_X_START+(index-1)*DIFF_GAP-tw/2, 1050, tw, th, diffLabelImage, 1, 0)
-    end
-    gfx.Restore()
-
-    -- Scoreboard
-
-    drawLocalLeaderboard(diff)
-    drawIrLeaderboard()
-
-    gfx.Save()
-    gfx.FontSize(22)
-    gfx.TextAlign(gfx.TEXT_ALIGN_LEFT + gfx.TEXT_ALIGN_MIDDLE)
-    gfx.GlobalAlpha(transitionAfterscrollDataOverlayAlpha)
-    gfx.Text(diff.effector, 270, 1180) -- effected by
-    gfx.Text(diff.illustrator, 270, 1210) -- illustrated by
-    gfx.Restore()
-
-end
-
 ---@param diff SongWheelDifficulty
-function drawLocalLeaderboard(diff)
+local function drawLocalLeaderboard(diff)
     gfx.LoadSkinFont('Digital-Serial-Bold.ttf')
     gfx.FontSize(26)
 
@@ -575,11 +454,12 @@ function drawLocalLeaderboard(diff)
         gfx.Text(username or "-", sbBarContentLeftX, scoreBoardY + sbBarHeight/2 + i*sbBarHeight)
 
         gfx.BeginPath()
-        gfx.Text(score or "- - - - - - - -", sbBarContentRightX, scoreBoardY + sbBarHeight/2 + i*sbBarHeight)
+        local scoreText = score and tostring(score) or "- - - - - - - -"
+        gfx.Text(scoreText, sbBarContentRightX, scoreBoardY + sbBarHeight/2 + i*sbBarHeight)
     end
 end
 
-function drawIrLeaderboard()
+local function drawIrLeaderboard()
     if not IRData.Active then
         return
     end
@@ -656,7 +536,130 @@ function drawIrLeaderboard()
     end
 end
 
-function drawFilterInfo(deltatime)
+local function drawData() -- Draws the song data on the left panel
+
+    if isFilterWheelActive or transitionLeaveReappearTimer ~= 0 then return false end
+
+    local song = songwheel.songs[selectedIndex]
+    local diff = song and song.difficulties[selectedDifficulty] or false
+    local bestScore = diff and diff.scores[1]
+
+    if not song then return false end
+
+    local jacketImage = getJacketImage(song)
+    gfx.BeginPath()
+    gfx.ImageRect(96, 324, 348, 348, jacketImage or defaultJacketImage, 1, 0)
+
+    if (top50diffs[diff.hash]) then
+        gfx.BeginPath()
+        gfx.ImageRect(96, 529, 410*0.85, 168*0.85, top50JacketOverlayImage, 1, 0)
+    end
+
+    -- Draw best score
+    gfx.Save()
+    gfx.BeginPath()
+
+    local scoreNumber = 0
+    if bestScore then
+        scoreNumber = bestScore.score
+    end
+
+    Numbers.draw_number(100, 793, 1.0, math.floor(scoreNumber / 10000), 4, scoreNumbers, true, 0.3, 1.12)
+    Numbers.draw_number(253, 798, 1.0, scoreNumber, 4, scoreNumbers, true, 0.22, 1.12)
+
+    -- Draw grade
+    local gradeImage = gradeImages.none
+    local gradeAlpha = transitionAfterscrollGradeAlpha
+    if bestScore then
+        gradeImage = getGradeImageForScore(bestScore.score)
+
+        if (transitionAfterscrollGradeAlpha == 1 and bestScore.score >= gradeCutoffs.S) then
+            gradeAlpha = transitionFlashAlpha -- If S, flash the badge
+        end
+    end
+
+    gfx.BeginPath()
+    gfx.ImageRect(360, 773, 45, 45, gradeImage, gradeAlpha, 0)
+
+    -- Draw badge
+    local badgeImage = badgeImages[diff.topBadge+1]
+
+    local badgeAlpha = transitionAfterscrollBadgeAlpha
+    if (transitionAfterscrollBadgeAlpha == 1 and diff.topBadge >= 3) then
+        badgeAlpha = transitionFlashAlpha -- If hard clear or above, flash the badge, but only after the initial transition
+    end
+
+    gfx.BeginPath()
+    gfx.ImageRect(425, 724, 93/1.1, 81/1.1, badgeImage, badgeAlpha, 0)
+
+    gfx.Restore()
+
+    -- Draw BPM
+    gfx.Save()
+    gfx.BeginPath()
+    gfx.FontSize(24)
+    gfx.TextAlign(gfx.TEXT_ALIGN_LEFT + gfx.TEXT_ALIGN_MIDDLE)
+    gfx.LoadSkinFont('Digital-Serial-Bold.ttf')
+    gfx.GlobalAlpha(transitionAfterscrollDataOverlayAlpha) -- TODO: split this out
+    gfx.Text(song.bpm, 85, 920)
+    gfx.Restore()
+
+    -- Draw song title
+    gfx.Save()
+    gfx.FontSize(28)
+    gfx.GlobalAlpha(transitionAfterscrollTextSongTitle)
+    gfx.Text(song.title, 30+(1-transitionAfterscrollTextSongTitle)*20, 955)
+    gfx.Restore()
+
+    -- Draw artist
+    gfx.Save()
+    gfx.GlobalAlpha(transitionAfterscrollTextSongArtist)
+    gfx.Text(song.artist, 30+(1-transitionAfterscrollTextSongArtist)*30, 997)
+    gfx.Restore()
+
+    -- Draw difficulties
+    local DIFF_X_START = 98.5
+    local DIFF_GAP = 114.8
+    gfx.Save()
+    gfx.GlobalAlpha(transitionAfterscrollDifficultiesAlpha)
+    for i, diff in ipairs(song.difficulties) do
+        gfx.BeginPath()
+
+        local index = diff.difficulty+1
+
+        if i == selectedDifficulty then
+            gfx.ImageRect(DIFF_X_START+(index-1)*DIFF_GAP-(163*0.8)/2, 1028, 163*0.8, 163*0.8, diffCursorImage, 1, 0)
+        end
+
+        Numbers.draw_number(85+(index-1)*DIFF_GAP, 1085, 1.0, diff.level, 2, difficultyNumbers, false, 0.8, 1)
+
+        local diffLabelImage = difficultyLabelUnderImages[
+            Charting.GetDisplayDifficulty(diff.jacketPath, diff.difficulty)
+        ]
+        local tw, th = gfx.ImageSize(diffLabelImage)
+        tw=tw*0.9
+        th=th*0.9
+        gfx.BeginPath()
+        gfx.ImageRect(DIFF_X_START+(index-1)*DIFF_GAP-tw/2, 1050, tw, th, diffLabelImage, 1, 0)
+    end
+    gfx.Restore()
+
+    -- Scoreboard
+
+    drawLocalLeaderboard(diff)
+    drawIrLeaderboard()
+
+    gfx.Save()
+    gfx.FontSize(22)
+    gfx.TextAlign(gfx.TEXT_ALIGN_LEFT + gfx.TEXT_ALIGN_MIDDLE)
+    gfx.GlobalAlpha(transitionAfterscrollDataOverlayAlpha)
+    gfx.Text(diff.effector, 270, 1180) -- effected by
+    gfx.Text(diff.illustrator, 270, 1210) -- illustrated by
+    gfx.Restore()
+
+end
+
+local function drawFilterInfo(deltatime)
     gfx.LoadSkinFont('NotoSans-Regular.ttf')
 
     if (songwheel.searchInputActive) then
@@ -686,7 +689,7 @@ function drawFilterInfo(deltatime)
     gfx.Text(sortOptionLabel or '', desw-150, 130)
 end
 
-function drawCursor()
+local function drawCursor()
     if isFilterWheelActive or transitionLeaveScale ~= 0 then return false end
 
     gfx.BeginPath()
@@ -697,7 +700,7 @@ function drawCursor()
     gfx.ImageRect(desw / 2 - 14, desh / 2 - 213 / 2, 555, 213, cursorImage, 1, 0)
 end
 
-function drawSearch()
+local function drawSearch()
     if (not songwheel.searchInputActive and searchPreviousActiveState) then
         searchPreviousActiveState = false
         game.PlaySample('sort_wheel/enter.wav')
@@ -767,7 +770,7 @@ function drawSearch()
     gfx.Text(songwheel.searchText, xPos + 160, yPos + 83.2)
 end
 
-function drawScrollbar()
+local function drawScrollbar()
     if isFilterWheelActive or transitionLeaveScale ~= 0 then return end
 
     -- Scrollbar Background
@@ -810,7 +813,33 @@ function drawScrollbar()
     end
 end
 
-function refreshIrLeaderboard(deltaTime)
+---Called on IR Leaderboard fetch complete
+---@param res IRLeaderboardResponse
+local function onIrLeaderboardFetched(res)
+    irRequestStatus = res.statusCode
+
+    local song = songwheel.songs[selectedIndex]
+    local diff = song and song.difficulties[selectedDifficulty] or false
+
+    if res.statusCode == IRData.States.Success then
+        local tempIrLB = res.body
+
+        table.sort(tempIrLB, function (a,b)
+            return a.score > b.score
+        end)
+
+        irLeaderboard = tempIrLB
+        irLeaderboardsCache[diff.hash] = irLeaderboard
+    else
+        local httpStatus = (res.statusCode // 10) * 100 + res.statusCode % 10 -- convert to 100 range
+        game.Log("IR error (" .. httpStatus .. "): " .. res.description, game.LOGGER_ERROR)
+        if res.body then
+            game.Log(common.dump(res.body), game.LOGGER_ERROR)
+        end
+    end
+end
+
+local function refreshIrLeaderboard(deltaTime)
     if not IRData.Active then
         return
     end
@@ -839,56 +868,10 @@ function refreshIrLeaderboard(deltaTime)
     end
 
     irRequestStatus = 2 -- Loading
-    -- onIrLeaderboardFetched({
-    --     statusCode = 20,
-    --     body = {}
-    -- })
     IR.Leaderboard(diff.hash, 'best', 4, onIrLeaderboardFetched)
 end
 
-function dump(o)
+local function tickTransitions(deltaTime)
-    if type(o) == 'table' then
-        local s = '{ '
-        for k,v in pairs(o) do
-                if type(k) ~= 'number' then k = '"'..k..'"' end
-                s = s .. '['..k..'] = ' .. dump(v) .. ','
-        end
-        return s .. '} '
-    else
-        return tostring(o)
-    end
-end
-
-function onIrLeaderboardFetched(res)
-    irRequestStatus = res.statusCode
-
-    local song = songwheel.songs[selectedIndex]
-    local diff = song and song.difficulties[selectedDifficulty] or false
-    game.Log(diff.hash, game.LOGGER_ERROR)
-    
-    if res.statusCode == IRData.States.Success then
-        game.Log('Raw IR reposonse: ' .. dump(res.body), game.LOGGER_ERROR)
-        local tempIrLB = res.body
-
-        table.sort(tempIrLB, function (a,b)
-            -- game.Log(a.score .. ' ?? ' .. b.score, game.LOGGER_ERROR)
-            return a.score > b.score
-        end)
-
-        -- for i, tempScore in ipairs(tempIrLeaderboard) do
-        --     irLeaderboard[tempScore.ranking] = tempScore
-        -- end
-
-        irLeaderboard = tempIrLB
-        irLeaderboardsCache[diff.hash] = irLeaderboard
-
-        game.Log(dump(irLeaderboard), game.LOGGER_ERROR)
-    else
-        game.Log("IR error " .. res.statusCode, game.LOGGER_ERROR)
-    end
-end
-
-function tickTransitions(deltaTime)
     if transitionScrollScale < 1 then
         transitionScrollScale = transitionScrollScale + deltaTime / 0.1 -- transition should last for that time in seconds
     else
@@ -949,8 +932,6 @@ function tickTransitions(deltaTime)
         end
     end
 
-    transitionSearchBackgroundInfoAlpha = Easing.inOutQuad(transitionSearchInfoEnterScale)
-
     -- Grade alpha
     if transitionAfterscrollScale >= 0.03 and transitionAfterscrollScale < 0.033 then
         transitionAfterscrollGradeAlpha = 0.5
@@ -1021,22 +1002,14 @@ function tickTransitions(deltaTime)
 
     -- Flash transition
     if transitionFlashScale < 1 then
+        ---@type number|string
         local songBpm = 120
+
         if (songwheel.songs[selectedIndex] and game.GetSkinSetting('animations_affectWithBPM')) then
-            songBpm = songwheel.songs[selectedIndex].bpm
+            local songBpmStr = songwheel.songs[selectedIndex].bpm
-
+            local songBpmStrs = common.split(songBpmStr, '-')
-            -- Is a variable BPM
+            local minBpm = tonumber(songBpmStrs[1]) -- Lowest bpm value
-            if (type(songBpm) == "string") then
+            songBpm = minBpm or songBpm
-                local s = common.split(songBpm, '-')
-                songBpm = tonumber(s[1]) -- Lowest bpm value
-            end
-        end
-
-        -- If the original songBpm is "2021.04.01" for example, the above code can produce `nil` in the songBpm
-        -- since it cannot parse the number out of that string. Here we implement a fallback, to not crash
-        -- USC on whacky charts. Whacky charters, quit using batshit insane bpm values. It makes me angery >:(
-        if (songBpm == nil) then
-            songBpm = 120
         end
 
         transitionFlashScale = transitionFlashScale + deltaTime / (60/songBpm) -- transition should last for that time in seconds
@@ -1107,7 +1080,7 @@ local function drawRadar()
     gfx.Restore()
 end
 
-draw_songwheel = function(deltaTime)
+local draw_songwheel = function(deltaTime)
     drawBackground(deltaTime)
 
     drawSongList()
@@ -1139,6 +1112,7 @@ draw_songwheel = function(deltaTime)
     gfx.ResetTransform()
 end
 
+---@diagnostic disable-next-line:lowercase-global
 render = function (deltaTime)
     tickTransitions(deltaTime)
 
@@ -1164,6 +1138,7 @@ render = function (deltaTime)
     refreshIrLeaderboard(deltaTime)
 end
 
+---@diagnostic disable-next-line:lowercase-global
 songs_changed = function (withAll)
 
     irLeaderboardsCache = {} -- Reset LB cache
@@ -1178,25 +1153,28 @@ songs_changed = function (withAll)
         local song = songwheel.allSongs[i]
         for j = 1, #song.difficulties do
             local diff = song.difficulties[j]
-			diff.force = VolforceCalc.calc(diff)
+            table.insert(diffs, {hash = diff.hash, force = VolforceCalc.calc(diff)})
-			table.insert(diffs, diff)
         end
     end
+
     table.sort(diffs, function (l, r)
         return l.force > r.force
     end)
-	totalForce = 0
+
+    local totalForce = 0
     for i = 1, 50 do
-		if diffs[i] then
+        local diff = diffs[i]
-            top50diffs[diffs[i].id] = true
+        if not diff then
-			totalForce = totalForce + diffs[i].force
+            break
         end
+        top50diffs[diff.hash] = true
+        totalForce = totalForce + diff.force
     end
 
     game.SetSkinSetting('_volforce', totalForce)
 end
 
-
+---@diagnostic disable-next-line:lowercase-global
 set_index = function(newIndex)
     transitionScrollScale = 0
     transitionAfterscrollScale = 0
@@ -1220,6 +1198,7 @@ end
 
 local json = require("common.json")
 
+---@diagnostic disable-next-line:lowercase-global
 set_diff = function(newDiff)
     if newDiff ~= selectedDifficulty then
         jacketCache = {} -- Clear the jacket cache for the new diff jackets