fix: several fixes

- Fix miscellaneous typos.
- Cleanup the global namespace by limiting global exposure.
- Add a callable object generator function to be used instead of `Class` for lightweight objects.
- Rename `Game.GetGXTLabel` to `Game.GetLabelText`.
- Rename `HandlingPreset` to `VehicleFlagPreset`.
- Manual Gearbox: Add an `Automatic` mode that simply does nothing other than allow the user to still use the engine start/stop keybind with default engine and gearbox behavior.
Fix RGB lights color switch timing. It should now only switch colors when the lights are dimmed.

Author: xesdoog

SSV2/includes/backend.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/>.
 
 
+local Decorator      = require("includes.modules.Decorator")
 local PreviewService = require("includes.services.PreviewService")
 local ClearPreview   = function() PreviewService:Clear() end
 
@@ -122,7 +123,7 @@ function Backend:GetGameBranch()
 	---@type (fun(): integer)?
 	local get_game_branch = _G["get_game_branch"]
 	if (type(get_game_branch) ~= "function") then
-		self.m_game_branch = Enums.eGameBranch.LAGECY
+		self.m_game_branch = Enums.eGameBranch.LEGACY
 		return self.m_game_branch
 	end
 

SSV2/includes/classes/Mutex.lua

@@ -14,19 +14,11 @@
 ---@class Mutex
 ---@field protected m_locked boolean
 ---@overload fun(): Mutex
-local Mutex = {}
-Mutex.__index = Mutex
----@diagnostic disable-next-line
-setmetatable(Mutex, {
-	__call = function(_)
-		return Mutex.new()
-	end
-})
+local Mutex = Callable("Mutex")
 
 ---@return Mutex
 function Mutex.new()
-	---@diagnostic disable-next-line
-	return setmetatable({ m_locked = false }, Mutex)
+	return MakeInstance({ m_locked = false }, Mutex)
 end
 
 ---@return boolean

SSV2/includes/classes/Pair.lua

@@ -11,11 +11,12 @@
 -- Class: Pair
 --------------------------------------
 ---@class Pair<K, V> : { first: K, second: V }
-Pair = {}
+local Pair   = {}
 Pair.__index = Pair
 
-local _mt = {}
-_mt.__index = function(self, k)
+
+local _mt      = {}
+_mt.__index    = function(self, k)
 	if (k == "first") then
 		return self._raw[1]
 	end
@@ -73,3 +74,5 @@ function Pair.new(a, b)
 	local obj = { _raw = { a, b } }
 	return setmetatable(obj, _mt)
 end
+
+return Pair

SSV2/includes/classes/Range.lua

@@ -17,14 +17,7 @@
 ---@field private m_max number
 ---@field private m_step number
 ---@overload fun(from: number, to: number, step?: number): Range
-Range = {}
-Range.__index = Range
----@diagnostic disable-next-line
-setmetatable(Range, {
-	__call = function(_, from, to, step)
-		return Range.new(from, to, step)
-	end
-})
+local Range = Callable("Range")
 
 ---@param from number
 ---@param to number

SSV2/includes/classes/Rect.lua

@@ -14,14 +14,7 @@
 ---@field min vec2
 ---@field max vec2
 ---@overload fun(min: vec2, max: vec2) : Rect
-Rect = {}
-Rect.__index = Rect
----@diagnostic disable-next-line
-setmetatable(Rect, {
-	__call = function(_, ...)
-		return Rect.new(...)
-	end
-})
+local Rect = Callable("Rect")
 
 ---@param min vec2
 ---@param max vec2
@@ -93,3 +86,5 @@ end
 function Rect:__add(other)
 	return self:Add(other)
 end
+
+return Rect

SSV2/includes/classes/Set.lua

@@ -15,15 +15,7 @@
 ---@field protected m_data_type string
 ---@field new fun(...: T): Set<T>
 ---@overload fun(...: T): Set<T>
-Set         = { __type = "Set" }
-Set.__index = Set
-
----@diagnostic disable-next-line: param-type-mismatch
-setmetatable(Set, {
-	__call = function(_, ...)
-		return Set.new(...)
-	end
-})
+local Set = Callable("Set")
 
 function Set.new(...)
 	---@diagnostic disable-next-line: param-type-mismatch
@@ -101,7 +93,4 @@ function Set:__pairs()
 	return pairs(self.m_data)
 end
 
--- This is probably bad. Set:Contains() should be the only source of truth.
--- function Set:__index(key)
--- 	return Set[key] or (self.m_data[key] == true)
--- end
+return Set

SSV2/includes/classes/gta/CBoatHandlingData.lua

@@ -17,4 +17,10 @@ local CBaseSubHandlingData = require("includes.classes.gta.CBaseSubHandlingData"
 ---@overload fun(ptr: pointer): CBoatHandlingData
 local CBoatHandlingData = Class("CBoatHandlingData", { parent = CBaseSubHandlingData, pointer_ctor = true })
 
+---@param ptr pointer
+function CBoatHandlingData.new(ptr)
+	---@diagnostic disable-next-line: param-type-mismatch
+	return setmetatable({ m_ptr = ptr }, CBoatHandlingData)
+end
+
 return CBoatHandlingData

SSV2/includes/classes/gta/CPed.lua

@@ -59,8 +59,7 @@ function CPed:init(ped)
 		m_armor            = ptr:add(0x150C),
 		m_cash             = ptr:add(0x1614),
 		m_player_info      = CPlayerInfo(ptr:add(0x10A8):deref()),
-		---@diagnostic disable-next-line: param-type-mismatch
-	}, CPed)
+	}, self)
 end
 
 ---@return boolean

SSV2/includes/classes/gta/CStructView.lua

@@ -20,65 +20,64 @@
 ---@field public GetAddress fun(self: T): uint64_t
 ---@field __safecall fun(self: T, default: any, func: fun(...?): R1, R2?, R3?, R4?, R5?, ...?): R1, R2?, R3?, R4?, R5?, ...?
 
--- Creates a basic GTA class definition with default methods.
----@generic T
----@param name string
----@param size? integer Optional sugar, plays nice with `SizeOf`
----@return CStructBase<T>
-local function CStructView(name, size)
-	local cls = {
-		m_size     = size or GenericClass.m_size,
-		__type     = name,
-		__ptr_ctor = true
-	}
-	cls.__index = cls
+---@diagnostic disable: invisible
 
-	setmetatable(cls, {
-		__call = function(t, ...)
-			return t.new(...)
-		end
-	})
+---@param self CStructBase
+local function is_valid(self)
+	return self.m_ptr and self.m_ptr:is_valid() or false
+end
 
-	---@return boolean
-	function cls:IsValid()
-		return self.m_ptr and self.m_ptr:is_valid() or false
-	end
+---@param self CStructBase
+local function get_pointer(self)
+	return self.m_ptr or nullptr
+end
 
-	---@return pointer
-	function cls:GetPointer()
-		return self.m_ptr or nullptr
-	end
+---@param self CStructBase
+local function get_address(self)
+	return self.m_ptr and self.m_ptr:get_address() or 0x0
+end
 
-	---@return uint64_t
-	function cls:GetAddress()
-		return self.m_ptr and self.m_ptr:get_address() or 0x0
+---@generic R1, R2, R3, R4, R5
+---@param self CStructBase
+---@param default any Defaul value to return on failure
+---@param func fun(...): R1, R2?, R3?, R4?, R5?, ... ?
+---@param ... any
+---@return R1, R2?, R3?, R4?, R5?, ... ?
+local function safe_call(self, default, func, ...)
+	if (not self:IsValid()) then
+		return default
 	end
 
-	---@private
-	---@generic R1, R2, R3, R4, R5
-	---@param default any Defaul value to return on failure
-	---@param func fun(...): R1, R2?, R3?, R4?, R5?, ... ?
-	---@param ... any
-	---@return R1, R2?, R3?, R4?, R5?, ... ?
-	function cls:__safecall(default, func, ...)
-		if (not self:IsValid()) then
-			return default
-		end
-
-		local results = { pcall(func, ...) }
-		local ok      = results[1]
-		local err     = results[2]
-
-		if (not ok) then
-			log.fwarning("Safecall failed in %s: %s", self.__type, err)
-			return default
-		end
+	local results = { pcall(func, ...) }
+	local ok      = results[1]
+	local err     = results[2]
 
-		table.remove(results, 1)
-		return table.unpack(results)
+	if (not ok) then
+		log.fwarning("Safecall failed in %s: %s", self.__type, err)
+		return default
 	end
 
-	return cls
+	table.remove(results, 1)
+	return table.unpack(results)
 end
 
-return CStructView
+---@diagnostic enable: invisible
+
+-- Creates a basic GTA class definition with default methods.
+---@generic T
+---@param name string
+---@param size? integer Optional sugar, plays nice with `SizeOf`
+---@return CStructBase<T>
+return function(name, size)
+	return Callable(name, {
+		ctor     = function(t, ptr) return t.new(ptr) end,
+		ptr_ctor = true,
+		t_data   = {
+			m_size     = size or GenericClass.m_size,
+			IsValid    = is_valid,
+			GetPointer = get_pointer,
+			GetAddress = get_address,
+			__safecall = safe_call
+		},
+	})
+end

SSV2/includes/classes/gta/CVehicle.lua

@@ -38,18 +38,18 @@ local phFragInst        = require("includes.classes.gta.phFragInst")
 ---@field public m_velocity pointer<vec3>
 ---@field public m_transmission CTransmission
 ---@field public m_deform_god pointer<uint8_t>
----@field public m_frag_inst phFragInst //0x09C0 `fragInstGTA`
+---@field public m_frag_inst phFragInst 0x09C0 `fragInstGTA`
 ---@field public m_turbo pointer<float>
 ---@field public m_water_damage pointer<uint32_t>
 ---@field public m_engine_health pointer<float>
----@field public m_steering_input pointer<float> // 0x00D4 name might not correctly reflect what this actually is but this seems to store controller input (value is between 1.0 (left) .. -1.0 (right))
----@field public m_steering_angle pointer<float> 0x00DC // steering angle?. We'll use it to rewrite last known steering value after exiting a vehicle in IV-Style Exit so we'll no longer have to teleport outside or patch CTaskVehicleExit
+---@field public m_steering_input pointer<float> 0x00D4 name might not correctly reflect what this actually is but this seems to store controller input (value is between 1.0 (left) .. -1.0 (right))
+---@field public m_steering_angle pointer<float> 0x00DC // steering angle? // the same max value that this member can reach is the same value that YimMenu shows in the handling editor tab so yes, this is indeed the current steering angle.
 ---@field public m_throttle_power pointer<float> m_steering_angle + 0x8
 ---@field public m_brake_power pointer<float>
 ---@field public m_is_targetable pointer<byte> `bool`
 ---@field public m_door_lock_status pointer<uint32_t>
----@field public m_wheels atArray<CWheel> -- 0x0C30
----@field public m_num_wheels integer -- 0x0C38
+---@field public m_wheels atArray<CWheel> 0x0C30
+---@field public m_num_wheels integer array start + 8 so atArray.m_size
 ---@field public m_ride_height pointer<float>
 ---@field private DumpFlags fun(self: CVehicle, enum_flags: Enum, get_func: fun(self: CVehicle, flag: integer): boolean): nil
 ---@overload fun(vehicle: integer): CVehicle|nil
@@ -62,9 +62,7 @@ function CVehicle:init(vehicle)
 		error("Invalid entity!")
 	end
 
-	---@type CVehicle
-	---@diagnostic disable-next-line: param-type-mismatch
-	local instance = setmetatable({}, CVehicle)
+	local instance = MakeInstance({}, self) ---@cast instance CVehicle
 	instance:super().init(instance, vehicle)
 
 	local ptr                   = memory.handle_to_ptr(vehicle)