chore: tidy up

Author: xesdoog

SSV2/includes/classes/Mutex.lua

@@ -11,14 +11,14 @@
 -- Class: Mutex
 --------------------------------------
 -- Simple mutual exclusivity.
----@class Mutex
----@field protected m_locked boolean
+---@class Mutex : Callable<Mutex>
+---@field private m_locked boolean
 ---@overload fun(): Mutex
-local Mutex = Callable("Mutex")
+local Mutex = Callable("Mutex", { ctor = function(t) return t:new() end })
 
 ---@return Mutex
-function Mutex.new()
-	return MakeInstance({ m_locked = false }, Mutex)
+function Mutex:new()
+	return setmetatable({ m_locked = false }, self)
 end
 
 ---@return boolean

SSV2/includes/classes/Pair.lua

@@ -11,12 +11,12 @@
 -- Class: Pair
 --------------------------------------
 ---@class Pair<K, V> : { first: K, second: V }
-local Pair   = {}
-Pair.__index = Pair
+---@overload fun(k: K, v: V): Pair<K, V>
+local Pair = Callable("Pair", { ctor = function(t, ...) return t:new(...) end })
 
 
-local _mt      = {}
-_mt.__index    = function(self, k)
+local _mt <const> = {}
+_mt.__index       = function(self, k)
 	if (k == "first") then
 		return self._raw[1]
 	end
@@ -28,7 +28,7 @@ _mt.__index    = function(self, k)
 	return _mt[k]
 end
 
-_mt.__newindex = function(self, k, v)
+_mt.__newindex    = function(self, k, v)
 	if (type(k) == "number") then -- table.insert won't work without this
 		if (k == 1) then
 			self._raw[1] = v
@@ -70,7 +70,7 @@ end
 ---@param a K
 ---@param b V
 ---@return Pair<K, V>
-function Pair.new(a, b)
+function Pair:new(a, b)
 	local obj = { _raw = { a, b } }
 	return setmetatable(obj, _mt)
 end

SSV2/includes/classes/Range.lua

@@ -12,28 +12,27 @@
 --------------------------------------
 -- A simple `Range` utiliy.
 ---@ignore -- manual docs
----@class Range
+---@class Range : Callable<Range>
 ---@field private m_min number
 ---@field private m_max number
 ---@field private m_step number
 ---@overload fun(from: number, to: number, step?: number): Range
-local Range = Callable("Range")
+local Range = Callable("Range", { ctor = function(t, ...) return t:new(...) end })
 
 ---@param from number
 ---@param to number
 ---@param step? number
 ---@return Range
-function Range.new(from, to, step)
+function Range:new(from, to, step)
 	step = step or 1
 	assert(type(from) == "number" and type(to) == "number", "Range requires numeric from/to")
 	assert(step ~= 0, "Step cannot be 0")
 
 	return setmetatable({
-		m_min = from,
-		m_max = to,
+		m_min  = from,
+		m_max  = to,
 		m_step = step,
-		---@diagnostic disable-next-line
-	}, Range)
+	}, self)
 end
 
 ---@param value number

SSV2/includes/classes/Rect.lua

@@ -10,18 +10,21 @@
 --------------------------------------
 -- Class: Rect
 --------------------------------------
----@class Rect
----@field min vec2
----@field max vec2
+---@class Rect : Callable<Rect>
+---@field public min vec2
+---@field public max vec2
 ---@overload fun(min: vec2, max: vec2) : Rect
-local Rect = Callable("Rect")
+local Rect = Callable("Rect", {
+	ctor = function(t, ...)
+		return t:new(...)
+	end
+})
 
 ---@param min vec2
 ---@param max vec2
 ---@return Rect
-function Rect.new(min, max)
-	---@diagnostic disable-next-line
-	return setmetatable({ min = min, max = max }, Rect)
+function Rect:new(min, max)
+	return setmetatable({ min = min, max = max }, self)
 end
 
 ---@return float

SSV2/includes/classes/Set.lua

@@ -15,11 +15,14 @@
 ---@field protected m_data_type string
 ---@field new fun(...: T): Set<T>
 ---@overload fun(...: T): Set<T>
-local Set = Callable("Set")
+local Set = Callable("Set", {
+	ctor = function(t, ...)
+		return t:new(...)
+	end
+})
 
-function Set.new(...)
-	---@diagnostic disable-next-line: param-type-mismatch
-	local instance = setmetatable({ m_data = {} }, Set)
+function Set:new(...)
+	local instance = setmetatable({ m_data = {} }, self)
 	local args     = { ... }
 
 	if (#args > 0) then

SSV2/includes/data/bsv2_data.lua

@@ -280,34 +280,34 @@ return {
 	},
 
 	DefaultHeliModels = {
-		Pair.new("Annihilator", 837858166),
-		Pair.new("Annihilator Stealth", 295054921),
-		Pair.new("Maverick", 2634305738),
-		Pair.new("Police Maverick", 353883353),
-		Pair.new("Savage", 4212341271),
-		Pair.new("SuperVolito", 710198397),
-		Pair.new("SuperVolito Carbon", 2623428164),
-		Pair.new("Swift Flying Bravo", 3955379698),
-		Pair.new("Swift Deluxe", 1075432268),
-		Pair.new("Valkyrie", 2694714877),
-		Pair.new("Volatus", 2449479409),
+		Pair("Annihilator", 837858166),
+		Pair("Annihilator Stealth", 295054921),
+		Pair("Maverick", 2634305738),
+		Pair("Police Maverick", 353883353),
+		Pair("Savage", 4212341271),
+		Pair("SuperVolito", 710198397),
+		Pair("SuperVolito Carbon", 2623428164),
+		Pair("Swift Flying Bravo", 3955379698),
+		Pair("Swift Deluxe", 1075432268),
+		Pair("Valkyrie", 2694714877),
+		Pair("Volatus", 2449479409),
 	},
 
 	HeliPresetDestinations = {
-		Pair.new("Sandy Shores Helipad", vec3:new(1770.17, 3239.85, 42.1217)),
-		Pair.new("Paleto Bay Sheriff's Office", vec3:new(-475.02, 5988.46, 31.3367)),
-		Pair.new("Fort Zancudo Helipad", vec3:new(-1859.4, 2795.65, 32.8066)),
-		Pair.new("The Diamond Casino Helipad", vec3:new(967.052, 42.1343, 123.127)),
-		Pair.new("Vinewood Police Station", vec3:new(579.992, 12.3636, 103.234)),
-		Pair.new("Hawick Agency Helipad", vec3:new(393.284, -66.3109, 124.376)),
-		Pair.new("Richard's Majestic Helipad", vec3:new(-913.493, -378.444, 137.906)),
-		Pair.new("Rockford Hills Agency Helipad", vec3:new(-1007.68, -415.99, 80.1686)),
-		Pair.new("Vespucci Canals Agency Helipad", vec3:new(-1010.76, -756.875, 81.7484)),
-		Pair.new("Little Seoul Agency Helipad", vec3:new(-597.602, -716.92, 131.04)),
-		Pair.new("Lombank Office Helipad", vec3:new(-1581.9, -569.51, 116.328)),
-		Pair.new("Mazebank West Office Helipad", vec3:new(-1391.7, -477.587, 91.2508)),
-		Pair.new("Mazebank Tower Helipad", vec3:new(-75.2834, -819.323, 326.175)),
-		Pair.new("Arcadius Office Helipad", vec3:new(-144.582, -593.811, 211.775)),
+		Pair("Sandy Shores Helipad", vec3:new(1770.17, 3239.85, 42.1217)),
+		Pair("Paleto Bay Sheriff's Office", vec3:new(-475.02, 5988.46, 31.3367)),
+		Pair("Fort Zancudo Helipad", vec3:new(-1859.4, 2795.65, 32.8066)),
+		Pair("The Diamond Casino Helipad", vec3:new(967.052, 42.1343, 123.127)),
+		Pair("Vinewood Police Station", vec3:new(579.992, 12.3636, 103.234)),
+		Pair("Hawick Agency Helipad", vec3:new(393.284, -66.3109, 124.376)),
+		Pair("Richard's Majestic Helipad", vec3:new(-913.493, -378.444, 137.906)),
+		Pair("Rockford Hills Agency Helipad", vec3:new(-1007.68, -415.99, 80.1686)),
+		Pair("Vespucci Canals Agency Helipad", vec3:new(-1010.76, -756.875, 81.7484)),
+		Pair("Little Seoul Agency Helipad", vec3:new(-597.602, -716.92, 131.04)),
+		Pair("Lombank Office Helipad", vec3:new(-1581.9, -569.51, 116.328)),
+		Pair("Mazebank West Office Helipad", vec3:new(-1391.7, -477.587, 91.2508)),
+		Pair("Mazebank Tower Helipad", vec3:new(-75.2834, -819.323, 326.175)),
+		Pair("Arcadius Office Helipad", vec3:new(-144.582, -593.811, 211.775)),
 	},
 	DefaultJetModels = {
 		{

SSV2/includes/data/theme_library.lua

@@ -7,6 +7,7 @@
 --	* Provide a copy of or a link to the original license (GPL-3.0 or later); see LICENSE.md or <https://www.gnu.org/licenses/>.
 
 
+---@diagnostic disable
 ---@class ThemeLibrary
 local ThemeLibrary <const> = {
 	---@type Theme

SSV2/includes/features/EnemiesFlee.lua

@@ -29,11 +29,10 @@ function EnemiesFlee:OnClick()
 		end
 
 		Notifier:ShowSuccess("Samurai's Scripts", _T("WRLD_FLEE_ALL_NOTIF"), false, 10.5)
-		self.m_active = true
-		---@type Set<handle>
-		local task_set = Set.new()
-		local trash = {}
-		local timer = Timer.new(1e4)
+		self.m_active  = true
+		local task_set = Set() ---@type Set<handle>
+		local trash    = {}
+		local timer    = Timer.new(1e4)
 
 		while (not timer:IsDone()) do
 			for _, p in ipairs(entities.get_all_peds_as_handles()) do

SSV2/includes/features/self/laser_sights.lua

@@ -19,7 +19,7 @@ local Set         = require("includes.classes.Set")
 local LaserSights            = setmetatable({}, FeatureBase)
 LaserSights.__index          = LaserSights
 
-LaserSights.WeaponExclusions = Set.new(
+LaserSights.WeaponExclusions = Set(
 	0x34A67B97,
 	0xBA536372,
 	0x184140A1,

SSV2/includes/features/self/miscellaneous.lua

@@ -20,16 +20,16 @@ local Pair        = require("includes.classes.Pair")
 local SelfMisc        = setmetatable({}, FeatureBase)
 SelfMisc.__index      = SelfMisc
 SelfMisc.m_cell_input = {
-	Pair.new(172, 1),
-	Pair.new(173, 2),
-	Pair.new(174, 3),
-	Pair.new(175, 4),
-	Pair.new(176, 5),
-	Pair.new(177, 5),
-	Pair.new(178, 5),
-	Pair.new(179, 5),
-	Pair.new(180, 1),
-	Pair.new(181, 2),
+	Pair(172, 1),
+	Pair(173, 2),
+	Pair(174, 3),
+	Pair(175, 4),
+	Pair(176, 5),
+	Pair(177, 5),
+	Pair(178, 5),
+	Pair(179, 5),
+	Pair(180, 1),
+	Pair(181, 2),
 }
 
 ---@param ent LocalPlayer