Merge pull request #141 from YimMenu-Lua/misc_refactors

refactor: another bloated refactor

Author: xesdoog

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "dev/LuaLS"]
+	path = dev/LuaLS
+	url = https://github.com/xesdoog/YimLLSX

SSV2/includes/backend.lua

@@ -20,8 +20,10 @@ local ClearPreview   = function() PreviewService:Clear() end
 ---@enum eBackendEvent
 Enums.eBackendEvent = {
 	RELOAD_UNLOAD  = 1,
-	SESSION_SWITCH = 2,
-	PLAYER_SWITCH  = 3,
+	PLAYER_SWITCH  = 2,
+	SESSION_SWITCH = 3,
+	SESSION_JOIN   = 4, -- Only works when switching from SP to Online, not between sessions
+	SESSION_LEAVE  = 5, -- Only works when switching from Online to SP, not between sessions
 }
 
 ---@enum eEntityType
@@ -56,8 +58,9 @@ local Backend = {
 	---@type table<eBackendEvent, array<function>>
 	EventCallbacks           = {
 		[Enums.eBackendEvent.RELOAD_UNLOAD]  = { ClearPreview },
-		[Enums.eBackendEvent.SESSION_SWITCH] = { ClearPreview },
-		[Enums.eBackendEvent.PLAYER_SWITCH]  = { ClearPreview }
+		[Enums.eBackendEvent.PLAYER_SWITCH]  = { ClearPreview },
+		[Enums.eBackendEvent.SESSION_SWITCH] = {},
+		[Enums.eBackendEvent.SESSION_LEAVE]  = {},
 	},
 
 	---@type table<eEntityType, table<handle, handle>>
@@ -77,7 +80,7 @@ local Backend = {
 	---@type table<string, fun(handle: handle): any>
 	FeatureEntityHandlers    = {},
 
-	---@type table<int64_t, pointer>
+	---@type table<uint64_t, pointer>
 	AllocatedPointers        = {}
 }; Backend.__index = Backend
 
@@ -411,10 +414,11 @@ end
 
 ---@param event eBackendEvent
 function Backend:TriggerEventCallbacks(event)
-	for _, fn in ipairs(self.EventCallbacks[event] or {}) do
-		if (type(fn) == "function") then
-			xpcall(fn, function(err)
-				log.fwarning("[Backend]: Callback error for event %s: %s", EnumToString(Enums.eBackendEvent, event), err)
+	for _, cb in ipairs(self.EventCallbacks[event] or {}) do
+		if (type(cb) == "function") then
+			xpcall(cb, function(err)
+				local evt_name = EnumToString(Enums.eBackendEvent, event)
+				log.fwarning("[Backend]: Callback error for event %s: %s", evt_name, err)
 			end)
 		end
 	end
@@ -501,30 +505,35 @@ function Backend:RegisterHandlers()
 		Translator:OnTick()
 
 		yield()
-	end, {
-		exception_handler = function()
-			Backend:Cleanup()
-		end
-	})
+	end, { exception_handler = function() Backend:Cleanup() end })
 
 	ThreadManager:RegisterLooped("SS_POOLMGR", function()
 		self:PoolMgr()
 		yield()
 	end)
 
-	event.register_handler(menu_event.MenuUnloaded, function() self:Cleanup() end)
-	event.register_handler(menu_event.ScriptsReloaded, function() self:Cleanup() end)
+	event.register_handler(menu_event.MenuUnloaded, function()
+		self:Cleanup()
+	end)
+
+	event.register_handler(menu_event.ScriptsReloaded, function()
+		self:Cleanup()
+	end)
+
+	event.register_handler(menu_event.playerMgrInit, function()
+		self:TriggerEventCallbacks(Enums.eBackendEvent.SESSION_JOIN)
+	end)
+
+	event.register_handler(menu_event.playerMgrShutdown, function()
+		self:TriggerEventCallbacks(Enums.eBackendEvent.SESSION_LEAVE)
+	end)
 end
 
 -- ### Baguette
-------
--- Note: This **will remove** all registered threads and not just stop or suspend them.
---
--- You can only restart (re-register) them by reloading the script.
 function Backend:PANIQUE()
 	ThreadManager:Run(function()
 		self:Cleanup()
-		for i = Enums.eBackendEvent.SESSION_SWITCH, Enums.eBackendEvent.PLAYER_SWITCH do
+		for i = Enums.eBackendEvent.PLAYER_SWITCH, Enums.eBackendEvent.SESSION_LEAVE do
 			self:TriggerEventCallbacks(i)
 			sleep(100)
 		end

SSV2/includes/classes/Set.lua

@@ -10,26 +10,50 @@
 --------------------------------------
 -- Class: Set
 --------------------------------------
----@class Set<T> : { [T]: true }
----@field protected m_data table<T, true>
----@field protected m_data_type string
----@field new fun(...: T): Set<T>
+-- Stores unique items of the same type.
+--___
+-- The set's runtime type is determined by the first item inserted. Once a type
+--
+-- has been determined, attempting to push a value of a different type will
+--
+-- raise an error.
+--
+-- For best LuaLS type inference, consider constructing sets with at least one item:
+--
+--```Lua
+-- local strings = Set("abc") -- Set<string>
+-- strings:Push(69) -- <- Produces a LuaLS type-mismatch warning
+--```
+--
+-- Creating an empty set does not provide LuaLS enough information to infer the
+--
+-- generic type:
+--
+--```Lua
+-- local unk = Set() -- Set<T>
+-- unk:Push("abc") -- No LuaLS warnings
+-- unk:Push(123) -- <- Still no LuaLS warning but this will throw at runtime because the previous Push assigned a string type.
+--```
+--
+-- Subsequent calls to Push do not update the inferred generic parameter, though
+-- runtime type checking still works as expected.
+---@class Set<T>
+---@field protected m_data { [T]: true }
+---@field private m_data_type string
+---@field private m_count integer
 ---@overload fun(...: T): Set<T>
-local Set = Callable("Set", {
-	ctor = function(t, ...)
-		return t:new(...)
-	end
-})
+local Set = Callable("Set", { ctor = function(t, ...) return t:new(...) end })
 
+---@param ... T
+---@return Set<T>
 function Set:new(...)
-	local instance = setmetatable({ m_data = {} }, self)
-	local args     = { ... }
-
-	if (#args > 0) then
-		instance.m_data_type = type(args[1])
-		for _, arg in ipairs(args) do
-			instance:Push(arg)
-		end
+	local instance = setmetatable({
+		m_data  = {},
+		m_count = 0
+	}, self)
+
+	for _, v in ipairs({ ... }) do
+		instance:Push(v)
 	end
 
 	return instance
@@ -49,23 +73,34 @@ function Set:Push(element)
 	if (not self.m_data_type) then
 		self.m_data_type = __type
 	elseif (__type ~= self.m_data_type) then
-		error(_F(
-			"[Set]: Data type mismatch! A set can only contain unique same-type objects. %s expected, got %s instead.",
+		error(_F("[Set]: Type mismatch! A set can only contain unique same-type objects. Expected '%s', got '%s' instead.",
 			self.m_data_type,
 			__type
 		))
 	end
 
 	self.m_data[element] = true
+	self.m_count         = self.m_count + 1
 end
 
 ---@param element T
 function Set:Pop(element)
+	if (self.m_data[element] == nil) then
+		return
+	end
+
 	self.m_data[element] = nil
+	self.m_count         = self.m_count - 1
+
+	if (self.m_count == 0) then
+		self.m_data_type = nil
+	end
 end
 
 function Set:Clear()
-	self.m_data = {}
+	self.m_data      = {}
+	self.m_count     = 0
+	self.m_data_type = nil
 end
 
 ---@param element any
@@ -76,16 +111,16 @@ end
 
 ---@return boolean
 function Set:IsEmpty()
-	return (next(self.m_data) == nil)
+	return self.m_count == 0
 end
 
----@return number
+---@return integer
 function Set:Size()
-	return table.getlen(self.m_data)
+	return self.m_count
 end
 
----@return fun(t: table<T, true>, index?: T): T, true
----@return table<T, true>
+---@return fun(t: table<T, true>, index?: T): T, true Iterator
+---@return table<T, true> data
 function Set:Iter()
 	return pairs(self.m_data)
 end
@@ -96,4 +131,9 @@ function Set:__pairs()
 	return pairs(self.m_data)
 end
 
+---@return integer
+function Set:__len()
+	return self.m_count
+end
+
 return Set

SSV2/includes/classes/gta/CWheel.lua

@@ -8,7 +8,7 @@
 
 
 local CStructView = require("includes.classes.gta.CStructView")
-local fVector3    = require("fVector3")
+local fVector3    = require("includes.classes.gta.fVector3")
 
 
 --------------------------------------

SSV2/includes/data/enums/__init__.lua

@@ -11,34 +11,34 @@
 --
 -- All enums are stored here to avoid polluting the global namespace.
 local Enums <const> = {
-	eActionType            = require("action_type"),
-	eAnimFlags             = require("anim_flags"),
-	eDrivingFlags          = require("driving_flags"),
-	eGameState             = require("game_state"),
-	eGameLanguage          = require("game_language"),
-	eHandlingEditorTypes   = require("handling_editor_types"),
-	eHandlingType          = require("handling_type"),
-	eLandingGearState      = require("landing_gear_state"),
-	eManagedValueDataType  = require("managed_value_data_type"),
-	eManagedValueType      = require("managed_value_type"),
-	eModelType             = require("model_type"),
-	ePedCombatAttributes   = require("ped_combat_attributes"),
-	ePedComponents         = require("ped_components"),
-	ePedConfigFlags        = require("ped_config_flags"),
-	ePedGender             = require("ped_gender"),
-	ePedResetFlags         = require("ped_reset_flags"),
-	ePedTaskIndex          = require("ped_task_index"),
-	ePedType               = require("ped_type"),
-	eRagdollBlockingFlags  = require("ragdoll_blocking_flags"),
-	eVehicleAdvancedFlags  = require("vehicle_advanced_flags"),
-	eVehicleClass          = require("vehicle_classes"),
-	eVehicleHandlingFlags  = require("vehicle_handling_flags"),
-	eVehicleModelFlags     = require("vehicle_model_flags"),
-	eVehicleModelInfoFlags = require("vehicle_model_info_flags"),
-	eVehicleTask           = require("vehicle_task"),
-	eVehicleType           = require("vehicle_type"),
-	eWheelConfigFlags      = require("cwheel_config_flags"),
-	eWheelDynamicFlags     = require("cwheel_dynamic_flags"),
+	eActionType            = require("includes.data.enums.action_type"),
+	eAnimFlags             = require("includes.data.enums.anim_flags"),
+	eDrivingFlags          = require("includes.data.enums.driving_flags"),
+	eGameState             = require("includes.data.enums.game_state"),
+	eGameLanguage          = require("includes.data.enums.game_language"),
+	eHandlingEditorTypes   = require("includes.data.enums.handling_editor_types"),
+	eHandlingType          = require("includes.data.enums.handling_type"),
+	eLandingGearState      = require("includes.data.enums.landing_gear_state"),
+	eManagedValueDataType  = require("includes.data.enums.managed_value_data_type"),
+	eManagedValueType      = require("includes.data.enums.managed_value_type"),
+	eModelType             = require("includes.data.enums.model_type"),
+	ePedCombatAttributes   = require("includes.data.enums.ped_combat_attributes"),
+	ePedComponents         = require("includes.data.enums.ped_components"),
+	ePedConfigFlags        = require("includes.data.enums.ped_config_flags"),
+	ePedGender             = require("includes.data.enums.ped_gender"),
+	ePedResetFlags         = require("includes.data.enums.ped_reset_flags"),
+	ePedTaskIndex          = require("includes.data.enums.ped_task_index"),
+	ePedType               = require("includes.data.enums.ped_type"),
+	eRagdollBlockingFlags  = require("includes.data.enums.ragdoll_blocking_flags"),
+	eVehicleAdvancedFlags  = require("includes.data.enums.vehicle_advanced_flags"),
+	eVehicleClass          = require("includes.data.enums.vehicle_classes"),
+	eVehicleHandlingFlags  = require("includes.data.enums.vehicle_handling_flags"),
+	eVehicleModelFlags     = require("includes.data.enums.vehicle_model_flags"),
+	eVehicleModelInfoFlags = require("includes.data.enums.vehicle_model_info_flags"),
+	eVehicleTask           = require("includes.data.enums.vehicle_task"),
+	eVehicleType           = require("includes.data.enums.vehicle_type"),
+	eWheelConfigFlags      = require("includes.data.enums.cwheel_config_flags"),
+	eWheelDynamicFlags     = require("includes.data.enums.cwheel_dynamic_flags"),
 }
 
 return Enums