v1.2.16

leaderboard.lua

@@ -1,12 +1,18 @@
 -- Leaderboards written by Not
+-- Reusable
 
 local FILENAME = "leaderboard.txt"
 local lb = {}
 local timeFinished = 0
-local disable = true
+local disable = false
 local prevLap = 0
 local splits = {}
 local PATCH = nil
+local help = true
+local UNCLAIMED = "Unclaimed Record"
+
+-- Retry / changelevel map
+local nextMap = nil
 
 local Flags = 0
 
@@ -18,11 +24,62 @@ local F_SPBEXP = 0x8
 
 local clearcheats = false
 
-local startTime = 6 * TICRATE + (3 * TICRATE / 4)
+local START_TIME = 6 * TICRATE + (3 * TICRATE / 4)
+local AFK_TIMEOUT = TICRATE * 5
+local AFK_BALANCE = TICRATE * 60
+local PREVENT_JOIN_TIME = START_TIME + TICRATE * 5
+
+local GUI_OFF    = 0x0
+local GUI_SPLITS = 0x1
+local GUI_ON     = 0x2
 
 -- patch caching function
 local cachePatches
 
+local cv_gui = CV_RegisterVar({
+	name = "lb_gui",
+	defaultvalue = GUI_ON,
+	flags = 0,
+	PossibleValue = {Off = GUI_OFF, Splits = GUI_SPLITS, On = GUI_ON}
+})
+
+local cv_afk = CV_RegisterVar({
+	name = "lb_afk",
+	defaultvalue = 1,
+	flags = CV_NETVAR,
+	PossibleValue = CV_OnOff
+})
+
+local cv_enable = CV_RegisterVar({
+	name = "lb_enable",
+	defaultvalue = 1,
+	flags = CV_NETVAR | CV_CALL,
+	PossibleValue = CV_OnOff,
+	func = function(v)
+		disable = $ or not v.value
+	end
+})
+
+local cv_saves = CV_RegisterVar({
+	name = "lb_save_count",
+	defaultvalue = 20,
+	flags = CV_NETVAR,
+	PossibleValue = CV_Natural
+})
+
+local cv_interrupt = CV_RegisterVar({
+	name = "lb_interrupt",
+	defaultvalue = 0,
+	flags = CV_NETVAR | CV_CALL,
+	PossibleValue = CV_OnOff,
+	func = function(v)
+		if v.value then
+			COM_BufInsertText(server, "allowteamchange yes")
+		end
+	end
+})
+
+
 local function lbID(map, flags)
 	local id = tostring(map)
 	if flags & F_SPBATK then
@@ -91,25 +148,44 @@ else
 	print("Failed to open file: ", FILENAME)
 end
 
-local function initLeaderboard(player)
+local function allowJoin(v)
-	local ingame = 0
+	if not cv_interrupt.value then
+		local y
+		if v then
+			y = "yes"
+			hud.enable("freeplay")
+		else
+			y = "no"
+			hud.disable("freeplay")
+		end
+
+		COM_BufInsertText(server, "allowteamchange " + y)
+	end
+end
+
+local function ingame()
+	local n = 0
 	for p in players.iterate do
 		if p.valid and not p.spectator then
-			ingame = ingame + 1
+			n = $ + 1
 		end
 	end
-	
+	return n
-	disable = ingame > 1
+end
 
-	if disable then
+local function initLeaderboard(player)
-		--print("To many players in game, leaderboard has been disabled")
+	if disable and leveltime < START_TIME then
-		return
+		disable = ingame() > 1
+	else
+		disable = disable or ingame() > 1
 	end
+	disable = $ or not cv_enable.value
+	player.afkTime = leveltime
 end
 addHook("PlayerSpawn", initLeaderboard)
 
 local function doyoudare(player)
-	if disable or player.spectator then
+	if ingame() > 1 or player.spectator then
 		CONS_Printf(player, "How dare you")
 		return false
 	end
@@ -118,7 +194,11 @@ end
 
 local function retry(player, ...)
 	if doyoudare(player) then
-		COM_BufInsertText(server, "map " + G_BuildMapName(gamemap))
+		-- Prevents bind crash
+		if leveltime < 20 then
+			return
+		end
+		nextMap = G_BuildMapName(gamemap)
 	end
 end
 COM_AddCommand("retry", retry)
@@ -130,6 +210,33 @@ local function exitlevel(player, ...)
 end
 COM_AddCommand("exit", exitlevel)
 
+local function findMap(player, ...)
+	local search = ...
+	if search == nil then 
+
+		return
+	end
+
+	for i = 1, #mapheaderinfo do
+		local map = mapheaderinfo[i]
+		if map == nil then
+			continue
+		end
+
+		if map.lvlttl:lower():find(search:lower()) then
+			CONS_Printf(
+				player,
+				string.format(
+					"%s - %s",
+					G_BuildMapName(i),
+					map.lvlttl
+				)
+			)
+		end
+	end
+end
+COM_AddCommand("findmap", findMap)
+
 local function mapNotExists(player, map)
 	CONS_Printf(player, string.format("Map doesn't exist: %s", map:upper()))
 end
@@ -140,8 +247,16 @@ local function changelevel(player, ...)
 	if not doyoudare(player) then
 		return
 	end
+	if leveltime < 20 then
+		return
+	end
 
 	local map = ...
+	if map == nil then
+		CONS_Printf(player, "Usage: changelevel MAPXX")
+		return
+	end
+
 	local p, q = map:upper():match("MAP(%w)(%w)$", 1)
 	if not (p and q) then
 		CONS_Printf(player, string.format("Invalid map name: %s", map))
@@ -159,8 +274,11 @@ local function changelevel(player, ...)
 	else
 		--Extended map numbers
 		p = ALPH:find(p) - 1
-		q = (tonumber(q) or ALPH:find(q) + 10) - 1
+		local qn = tonumber(q)
-		mapnum = 36 * p + q + 100
+		if qn == nil then
+			qn = ALPH:find(q) + 9
+		end
+		mapnum = 36 * p + qn + 100
 	end
 	
 	if mapheaderinfo[mapnum] == nil then
@@ -168,7 +286,7 @@ local function changelevel(player, ...)
 		return
 	end
 
-	COM_BufInsertText(server, "map " + (G_BuildMapName(mapnum)))
+	nextMap = G_BuildMapName(mapnum)
 end
 COM_AddCommand("changelevel", changelevel)
 
@@ -205,11 +323,17 @@ addHook("MapLoad", function()
 		timeFinished = 0
 		splits = {}
 		prevLap = 0
+
+		allowJoin(true)
 		--printTable(lb)
 	end
 )
 
 local function ticsToTime(tics)
+	if tics == 0 then
+		return "-:--:--"
+	end
+
 	return string.format(
 		"%d:%02d:%02d",
 		G_TicsToMinutes(tics),
@@ -231,92 +355,55 @@ local function drawitem(v, x, y, scale, itempatch, vflags)
 	)
 end
 
+local cursors = {
+	[1] = ". ",
+	[2] = " ."
+}
 local function marquee(text, maxwidth)
 	if #text <= maxwidth then
 		return text
 	end
 	
 	local shift = 16
+
+	-- Creates an index range ranging from -shift to #text + shift
 	local pos = ((leveltime / 16) % (#text - maxwidth + shift * 2)) + 1 - shift
+
+	local cursor = ""
+	if pos < #text - maxwidth + 1 then
+		cursor = cursors[((leveltime / 11) % #cursors) + 1]
+	end
+
+	-- The pos is the index going from -shift to #text + shift
+	-- It's clamped within the text boundaries ie.
+	-- 0 < pos < #text - maxwidth
 	pos = min(max(pos, 1), #text - maxwidth + 1)
-	return text:sub(pos, pos + maxwidth - 1)
+	return text:sub(pos, pos + maxwidth - 1) + cursor
 end
 
+-- Bats on ...
 local bodium = {V_YELLOWMAP, V_GRAYMAP, V_BROWNMAP, 0}
+
 local splitColor = {[true]=V_SKYMAP, [false]=V_REDMAP}
 local splitSymbol = {[true]="-", [false]="+"}
 
 local showSplit = 0
-local function drawScoreboard(v, player)
+local VFLAGS = V_SNAPTOLEFT
-	if disable then return end
+local FACERANK_DIM = 16
-	if player != displayplayers[0] then return end
+local function drawScore(v, player, i, gui, faceRank, color, name, time, sSplits, flags)
+	--draw Patch/chili
+	--        |    OFFSET   | + |      PADDING       | * |INDEX|
+	local h = ((200 / 4) + 4) + (FACERANK_DIM + 4) * (i - 1)
 
-	cachePatches(v)
+	v.draw(4, h, faceRank, V_HUDTRANS | VFLAGS, v.getColormap("sonic", color))
-	
+	if player.name == name then
-	local m = lb[lbID(gamemap, Flags)]
+		v.draw(4, h, PATCH["CHILI"][(leveltime / 4) % 8], V_HUDTRANS | VFLAGS)
-	if m == nil then
-		return
 	end
-
+	
-	for i, score in ipairs(m) do
+	--draw icons
-		local name = score["name"]
+	
-		local skin = skins[score["skin"]]
+	--draw name
-		if skin == nil then
+	if gui == GUI_ON or (gui == GUI_SPLITS and showSplit) then
-			skin = skins["sonic"]
-		end
-		local skinPatch = PATCH["FACERANK"][skin.name]
-
-		--        |    OFFSET   | + |      PADDING       | * |INDEX|
-		local h = ((200 / 4) + 4) + (skinPatch.height + 4) * (i - 1)
-
-		v.draw(4, h, skinPatch, V_HUDTRANS, v.getColormap("sonic", score["color"]))
-		if player.name == name then
-			v.draw(4, h, PATCH["CHILI"][(leveltime / 4) % 8], V_HUDTRANS)
-		end
-
-		-- SPB
-		if score["flags"] & F_SPBATK then
-			local scale = FRACUNIT / 4
-			drawitem(
-				v,
-				4 - 2,
-				h - 2,
-				scale,
-				PATCH["SPB"],
-				V_HUDTRANS
-			)
-			if score["flags"] & F_SPBEXP then
-				drawitem(
-					v,
-					skinPatch.width,
-					h - 2,
-					scale,
-					PATCH["INV"][(leveltime / 4) % 6],
-					V_HUDTRANS
-				)
-			end
-			if score["flags"] & F_SPBBIG then
-				drawitem(
-					v,
-					4 - 2,
-					h + skinPatch.height - 4,
-					scale,
-					PATCH["BIG"],
-					V_HUDTRANS
-				)
-			end
-			if score["flags"] & F_SPBJUS then
-				drawitem(
-					v,
-					skinPatch.width,
-					h + skinPatch.height - 4,
-					scale,
-					PATCH["HYUD"],
-					V_HUDTRANS
-				)
-			end
-		end
-
 		-- Shorten long names
 		local stralign = "left"
 		local MAXWIDTH = 70
@@ -334,14 +421,111 @@ local function drawScoreboard(v, player)
 			end
 		end
 
-		v.drawString(px + skinPatch.width, h + py, name, V_HUDTRANSHALF | V_ALLOWLOWERCASE, stralign)
+		-- SPB
+		if flags & F_SPBATK then
+			local scale = FRACUNIT / 4
+			drawitem(
+				v,
+				4 - 2,
+				h - 2,
+				scale,
+				PATCH["SPB"],
+				V_HUDTRANS | VFLAGS
+			)
+			if flags & F_SPBEXP then
+				drawitem(
+					v,
+					FACERANK_DIM,
+					h - 2,
+					scale,
+					PATCH["INV"][(leveltime / 4) % 6],
+					V_HUDTRANS | VFLAGS
+				)
+			end
+			if flags & F_SPBBIG then
+				drawitem(
+					v,
+					4 - 2,
+					h + FACERANK_DIM - 4,
+					scale,
+					PATCH["BIG"],
+					V_HUDTRANS | VFLAGS
+				)
+			end
+			if flags & F_SPBJUS then
+				drawitem(
+					v,
+					FACERANK_DIM,
+					h + FACERANK_DIM - 4,
+					scale,
+					PATCH["HYUD"],
+					V_HUDTRANS | VFLAGS
+				)
+			end
+		end
+
+		v.drawString(
+			px + FACERANK_DIM,
+			h + py,
+			name,
+			V_HUDTRANSHALF | V_ALLOWLOWERCASE | VFLAGS,
+			stralign
+		)
 
 		-- Draw splits
-		if showSplit > 0 and score["splits"][prevLap] != nil then
+		if showSplit and sSplits and sSplits[prevLap] != nil then
-			local split = splits[prevLap] - score["splits"][prevLap]
+			local split = splits[prevLap] - sSplits[prevLap]
-			v.drawString(px + skinPatch.width, h + 8, splitSymbol[split < 0] + ticsToTime(abs(split)), V_HUDTRANSHALF | splitColor[split < 0])
+			v.drawString(
+				px + FACERANK_DIM,
+				h + 8,
+				splitSymbol[split < 0] + ticsToTime(abs(split)),
+				V_HUDTRANSHALF | splitColor[split < 0] | VFLAGS
+			)
 		else
-			v.drawString(px + skinPatch.width, h + 8, ticsToTime(score["time"]), V_HUDTRANSHALF | bodium[min(i, 4)])
+			v.drawString(
+				px + FACERANK_DIM,
+				h + 8,
+				ticsToTime(time),
+				V_HUDTRANSHALF | bodium[min(i, 4)] | VFLAGS
+			)
+		end
+	end
+end
+
+local function drawScoreboard(v, player)
+	if disable then return end
+	if player != displayplayers[0] then return end
+
+	cachePatches(v)
+	
+	local m = lb[lbID(gamemap, Flags)]
+	--if m == nil then
+	--	return
+	--end
+
+	local gui = cv_gui.value
+	if leveltime < START_TIME or player.exiting or player.lives == 0 then
+		gui = GUI_ON
+	end
+
+	if gui then
+		-- Draw placeholder score
+		if m == nil then
+			drawScore(v, player, 1, gui, PATCH["NORANK"], nil, UNCLAIMED, 0, nil, 0)
+		else
+			for i, score in ipairs(m) do
+				if i > 5 then
+					break
+				end
+
+				local name = score["name"]
+				local skin = skins[score["skin"]]
+				if skin == nil then
+					skin = skins["sonic"]
+				end
+				local faceRank = PATCH["FACERANK"][skin.name]
+				drawScore(v, player, i, gui, faceRank, score["color"], score["name"], score["time"], score["splits"], score["flags"])
+			end
 		end
 	end
 end
@@ -356,6 +540,8 @@ function cachePatches(v)
 			PATCH["CHILI"][i-1] = v.cachePatch("K_CHILI" + i)
 		end
 
+		PATCH["NORANK"] = v.cachePatch("M_NORANK")
+
 		PATCH["FACERANK"] = {}
 		for skin in skins.iterate do
 			PATCH["FACERANK"][skin.name] = v.cachePatch(skin.facerank)
@@ -378,7 +564,7 @@ local function lbComp(a, b)
 	-- if s is negative then b is harder
 	-- if s is 0 then compare time
 	local s = (a["flags"] & (F_SPBEXP | F_SPBBIG)) - (b["flags"] & (F_SPBEXP | F_SPBBIG))
-	return s > 0 or not(s < 0 or a["time"] > b["time"])
+	return s > 0 or not(s < 0 or a["time"] >= b["time"])
 end
 
 local function saveTime(player)
@@ -418,7 +604,7 @@ local function saveTime(player)
 	)
 
 	table.sort(m, lbComp)
-	while #m > 5 do
+	while #m > cv_saves.value do
 		table.remove(m)
 	end
 
@@ -450,7 +636,7 @@ end
 
 -- DEBUGGING
 --local function saveLeaderboard(player, ...)
---	timeFinished = player.realtime
+--	timeFinished = tonumber(... or player.realtime)
 --	splits = {1000, 2000, 3000}
 --	saveTime(player)
 --end
@@ -464,17 +650,76 @@ local function regLap(player)
 	end
 end
 
+local function getGamer()
+	for p in players.iterate do
+		if p.valid and not p.spectator then
+			return p
+		end
+	end
+end
+
 local function think()
+	if nextMap then
+		COM_BufInsertText(server, "map " + nextMap)
+		nextMap = nil
+	end
+
 	if disable then
+		if cv_afk.value and ingame() > 1 then
+			for p in players.iterate do
+				if p.valid and not p.spectator and not p.exiting and p.lives > 0 then
+					if p.cmd.buttons then
+						p.afkTime = leveltime
+					end
+					if p.afkTime + AFK_BALANCE < leveltime then
+						p.spectator = true
+						chatprint("\x89" + p.name + " was moved to the other team for game balance", true)
+					end
+				end
+			end
+		else
+			for p in players.iterate do
+				if p.valid and not p.spectator then
+					p.afkTime = leveltime
+				end
+			end
+		end
+
+		help = true
 		return
 	end
 	if showSplit > 0 then
 		showSplit = showSplit - 1
 	end
 
-	if leveltime < startTime then
+	local p = getGamer()
+	if leveltime < START_TIME then
+		-- Help message
+		if leveltime == START_TIME - TICRATE * 3 then
+			if ingame() == 1  then
+				if help then
+					help = false
+					chatprint("\x89Leaderboard Commands:\nretry exit findmap changelevel spba_clearcheats lb_gui", true)
+				end
+			else
+				help = true
+			end
+		end
+
+		-- Autospec
+		if leveltime == 1 then
+			if p then
+				for s in players.iterate do
+					if s.valid and s.spectator then
+						COM_BufInsertText(s, string.format("view \"%d\"", #p))
+					end
+				end
+			end
+		end
+		
+		-- Gamemode flags
 		Flags = $ & !(F_SPBATK | F_SPBEXP | F_SPBBIG | F_SPBJUS)
-		if leveltime > startTime - (3 * TICRATE) / 2 and server.SPBArunning then
+		if leveltime > START_TIME - (3 * TICRATE) / 2 and server.SPBArunning then
 			Flags = $ | F_SPBATK
 			if server.SPBAexpert then
 				Flags = $ | F_SPBEXP
@@ -498,19 +743,52 @@ local function think()
 				end
 			end
 		end
+		if not (Flags & F_SPBATK) then
+			hud.enable("freeplay")
+		end
 	end
 
-	for p in players.iterate do
+	local cv_teamchange = CV_FindVar("allowteamchange")
+	if p then
+		if p.cmd.buttons then
+			p.afkTime = leveltime
+		end
+
+		if leveltime > PREVENT_JOIN_TIME and p.afkTime + AFK_TIMEOUT > leveltime then
+			if cv_teamchange.value then
+				allowJoin(false)
+			end
+		elseif p.afkTime + AFK_TIMEOUT < leveltime then
+			if not cv_teamchange.value then
+				allowJoin(true)
+			end
+		end
+
 		if p.laps >= mapheaderinfo[gamemap].numlaps and timeFinished == 0 then
 			timeFinished = p.realtime
 			saveTime(p)
 		end
 		regLap(p)
+	elseif cv_teamchange.value == 0 then
+		allowJoin(true)
 	end
 end
 addHook("ThinkFrame", think)
 
+local function interThink()
+	if nextMap then
+		COM_BufInsertText(server, "map " + nextMap)
+		nextMap = nil
+	end
+	if not CV_FindVar("allowteamchange").value then
+		allowJoin(true)
+	end
+end
+addHook("IntermissionThinker", interThink)
+
 local function netvars(net)
 	lb = net($)
+	splits = net($)
+	prevLap = net($)
 end
 addHook("NetVars", netvars)