fix(Entity): fix assertion errors

- Fix assertion error in the `Entity` module's constructor.
- Add missing fields in the `CEntity` class.

Author: xesdoog

SSV2/includes/classes/gta/CEntity.lua

@@ -22,8 +22,8 @@ local fwDrawData = require("includes.classes.gta.fwDrawData")
 ---@class CEntity: ClassMeta<CEntity>
 ---@field protected m_ptr pointer
 ---@field m_model_info pointer<CBaseModelInfo> -- 0x0020
----@field m_entity_type uint8_t
 ---@field m_model_type pointer<eModelType> CBaseModelInfo + 0x009D
+---@field m_entity_type pointer<uint8_t>
 ---@field m_flags pointer<uint32_t> `FLAG_ISVISIBLE = 1 << 0`
 ---@field m_draw_data fwDrawData
 ---@field m_transform_matrix pointer<fMatrix44>
@@ -50,11 +50,13 @@ function CEntity:init(entity)
 	local instance                   = setmetatable({ m_ptr = ptr }, CEntity)
 	instance.m_model_info            = ptr:add(0x0020):deref()
 	instance.m_model_type            = instance.m_model_info:add(0x009D)
+	instance.m_entity_type           = ptr:add(0x0028)
 	instance.m_flags                 = ptr:add(0x002D)
 	instance.m_draw_data             = fwDrawData(ptr:add(0x0048):deref())
 	instance.m_transform_matrix      = ptr:add(0x0060)
 	instance.m_render_focus_distance = ptr:add(0x00A8)
 	instance.m_shadow_flags          = ptr:add(0x00B0)
+	instance.m_damage_bits           = ptr:add(0x0188)
 	instance.m_hostility             = ptr:add(0x018C)
 	instance.m_health                = ptr:add(0x0280)
 	instance.m_max_health            = ptr:add(0x0284)

SSV2/includes/classes/gta/CVehicle.lua

@@ -68,23 +68,23 @@ function CVehicle:init(vehicle)
 
 	local ptr                    = memory.handle_to_ptr(vehicle)
 	instance.m_ptr               = ptr
-	instance.m_model_info        = CVehicleModelInfo(ptr:add(0x20):deref())
-	instance.m_vehicle_damage    = ptr:add(0x0420)
-	instance.m_handling_data     = CHandlingData(ptr:add(0x0960):deref())
+	instance.m_model_info        = CVehicleModelInfo(ptr:add(0x0020):deref())
+	instance.m_water_damage      = ptr:add(0x00D8)
 	instance.m_physics_fragments = phFragInst(ptr:add(0x0030):deref())
 	instance.m_draw_data         = CVehicleDrawData(ptr:add(0x0048):deref())
 	instance.m_can_boost_jump    = ptr:add(0x03A4)
+	instance.m_vehicle_damage    = ptr:add(0x0420)
 	instance.m_velocity          = ptr:add(0x07D0)
-	instance.m_deform_god        = ptr:add(0x096C)
 	instance.m_is_targetable     = ptr:add(0x0AEE)
-	instance.m_door_lock_status  = ptr:add(0x13D0)
-	instance.m_water_damage      = ptr:add(0x00D8)
 	instance.m_next_gear         = ptr:add(0x0880)
 	instance.m_current_gear      = ptr:add(0x0882)
 	instance.m_top_gear          = ptr:add(0x0886)
 	instance.m_engine_health     = ptr:add(0x0910)
+	instance.m_handling_data     = CHandlingData(ptr:add(0x0960):deref())
+	instance.m_deform_god        = ptr:add(0x096C)
 	instance.m_steering_input    = ptr:add(0x09D4)
 	instance.m_current_steering  = ptr:add(0x09DC)
+	instance.m_door_lock_status  = ptr:add(0x13D0)
 
 	local array_ptr              = ptr:add(0x0C30)
 	instance.m_wheels            = atArray(array_ptr, CWheel)

SSV2/includes/modules/Entity.lua

@@ -62,29 +62,37 @@ function Entity:__eq(right)
 end
 
 ---@param handle number
----@param opts? {expectedType?: eEntityType, noassert: boolean }
+---@param opts? { expectedType?: eEntityType, noassert?: boolean }
 ---@return Entity
 function Entity.new(handle, opts)
-	opts = opts or {}
-	if not (opts.noassert and Game.IsScriptHandle(handle)) then
-		error("Attempt to create an Entity instance from an invalid entity script handle", 2)
+	opts   = opts or {}
+	handle = handle or 0
+	if (not opts.noassert) then
+		if (not Game.IsScriptHandle(handle)) then
+			error("Attempt to create an Entity instance from an invalid entity script handle", 2)
+		end
 	end
 
 	local expectedType = opts.expectedType
-	if (expectedType and ENTITY.GET_ENTITY_TYPE(handle) ~= expectedType) then
-		local type_str = EnumToString(Enums.eEntityType, expectedType)
-		error(_F("The handle provided does not match the expected entity type (%s).", type_str))
+	if (expectedType) then
+		if (ENTITY.GET_ENTITY_TYPE(handle) ~= expectedType) then
+			local type_str = EnumToString(Enums.eEntityType, expectedType)
+			error(_F("The handle provided does not match the expected entity type (%s).", type_str))
+		end
 	end
 
 	---@type Entity
-	---@diagnostic disable-next-line
-	local instance    = setmetatable({}, Entity)
-	instance.m_handle = handle
+	---@diagnostic disable-next-line: param-type-mismatch
+	local instance = setmetatable({ m_handle = handle }, Entity)
 
 	if (handle ~= 0) then
-		instance.m_modelhash = Game.GetEntityModel(handle)
-		instance.m_ptr       = memory.handle_to_ptr(handle)
-		instance.m_internal  = instance:Resolve()
+		ThreadManager:Run(function()
+			---@diagnostic disable: invisible
+			instance.m_modelhash = Game.GetEntityModel(handle)
+			instance.m_ptr       = memory.handle_to_ptr(handle)
+			instance.m_internal  = instance:Resolve()
+			---@diagnostic enable: invisible
+		end)
 	end
 
 	return instance
@@ -169,10 +177,10 @@ function Entity:Resolve()
 	end
 
 	-- **DO NOT REMOVE. THIS IS NOT USELESS CODE.**
-	-- We have to do this because `Self` is static, it inherits from `Entity` but doesn't have a constructor
+	-- We have to do this because `LocalPlayer` inherits from `Entity` but doesn't have a constructor
 	-- and doesn't store handles or hashes as members (because they can change on player switch).
 
-	local hndl     = self:GetHandle() -- This is overridden in `Self` to always invoke `PLAYER.PLAYER_PED_ID()`
+	local hndl     = self:GetHandle() -- This is overridden in `LocalPlayer` to always invoke `PLAYER.PLAYER_PED_ID()`
 	local ent_type = Game.GetEntityType(hndl)
 	if (ent_type == Enums.eEntityType.Ped) then
 		self.m_internal = CPed(hndl)
@@ -185,6 +193,7 @@ function Entity:Resolve()
 	return self.m_internal
 end
 
+---@return nil
 function Entity:Destroy()
 	self.m_handle    = nil
 	self.m_modelhash = nil

SSV2/includes/modules/HandlingEditor.lua

@@ -82,12 +82,20 @@ end
 ---@param obj HandlingObject
 ---@return boolean
 function HandlingEditor:GetFlagDefault(obj)
-	return Switch(obj.m_type) {
-		[Enums.eHandlingEditorTypes.TYPE_HF]  = self.m_pv:GetHandlingFlag(obj.m_flag),
-		[Enums.eHandlingEditorTypes.TYPE_AF]  = self.m_pv:GetAdvancedFlag(obj.m_flag),
-		[Enums.eHandlingEditorTypes.TYPE_MIF] = self.m_pv:GetModelInfoFlag(obj.m_flag),
-		default                               = false
-	}
+	local __type = obj.m_type
+	if ((__type) == Enums.eHandlingEditorTypes.TYPE_HF) then
+		return self.m_pv:GetHandlingFlag(obj.m_flag)
+	end
+
+	if ((__type) == Enums.eHandlingEditorTypes.TYPE_AF) then
+		return self.m_pv:GetAdvancedFlag(obj.m_flag)
+	end
+
+	if ((__type) == Enums.eHandlingEditorTypes.TYPE_MIF) then
+		return self.m_pv:GetModelInfoFlag(obj.m_flag)
+	end
+
+	return false
 end
 
 ---@param gvarKey string

SSV2/includes/modules/LocalPlayer.lua

@@ -154,24 +154,28 @@ function LocalPlayer:GetCharacterName()
 end
 
 function LocalPlayer:OnVehicleSwitch()
-	if (self.m_vehicle:IsValid()) then
-		self.m_vehicle:RestoreHeadlights()
-
-		self.m_last_vehicle = Vehicle(self.m_vehicle:GetHandle())
+	local veh = self.m_vehicle
+	if (veh:IsValid()) then
+		veh:RestoreHeadlights()
+		self.m_last_vehicle = Vehicle(veh:GetHandle())
 	end
 
-	self.m_vehicle:Reset()
+	veh:Reset()
 	sleep(500)
-	self.m_vehicle:Set(self:GetVehicleNative())
+	veh:Set(self:GetVehicleNative())
 end
 
 function LocalPlayer:OnVehicleExit()
-	if (not self.m_last_vehicle or self.m_last_vehicle:GetHandle() ~= self.m_vehicle:GetHandle()) then
-		self.m_last_vehicle = Vehicle(self.m_vehicle:GetHandle())
+	local veh = self.m_vehicle
+	if (not veh:IsValid()) then
+		veh:Cleanup()
+		return
 	end
 
-	if (not self.m_vehicle:IsValid()) then
-		self.m_vehicle:Cleanup()
+	local prevHandle = veh:GetHandle()
+	local lastVeh    = self.m_last_vehicle
+	if (prevHandle ~= 0 and (not lastVeh or lastVeh:GetHandle() ~= prevHandle)) then
+		self.m_last_vehicle = Vehicle(prevHandle)
 	end
 end
 

SSV2/includes/modules/PlayerVehicle.lua

@@ -56,7 +56,7 @@ local Stancer          = require("includes.features.vehicle.stancer")
 ---@field public m_is_shooting_flares boolean
 ---@field public m_is_flatbed boolean cache it so we don't have to call natives in UI threads
 ---@field public m_stancer Stancer
----@overload fun(handle: handle): PlayerVehicle
+---@overload fun(handle: handle, opts?: { noassert: boolean }): PlayerVehicle
 local PlayerVehicle = Class("PlayerVehicle", { parent = Vehicle })
 
 PlayerVehicle.mines = {
@@ -143,12 +143,12 @@ function PlayerVehicle.new(handle)
 		m_default_xenon_lights   = { enabled = false, index = 0 },
 		m_default_tire_smoke     = { enabled = false, color = vec3:zero() },
 		m_autopilot              = {
-			eligible = false,
-			state = PlayerVehicle.eAutoPilotState.NONE,
+			eligible           = false,
+			state              = PlayerVehicle.eAutoPilotState.NONE,
 			initial_nozzle_pos = 1,
 		},
 		m_default_max_speed      = 0,
-		---@diagnostic disable-next-line
+		---@diagnostic disable-next-line: param-type-mismatch
 	}, PlayerVehicle)
 
 	instance.m_esc_sm = StateMachine({
@@ -164,16 +164,15 @@ function PlayerVehicle.new(handle)
 	instance:InitFeatures()
 	instance:InitHandlingEditor()
 
-	local main_thread = ThreadManager:RegisterLooped("SS_VEHICLE", function()
-		instance:Main()
-	end)
-
 	Backend:RegisterEventCallbackAll(function()
 		---@diagnostic disable-next-line: invisible
 		instance.m_feat_mgr:Cleanup()
 	end)
 
-	table.insert(instance.m_threads, main_thread)
+	table.insert(instance.m_threads, ThreadManager:RegisterLooped("SS_VEHICLE", function()
+		instance:Main()
+	end))
+
 	return instance
 end
 
@@ -185,7 +184,8 @@ function PlayerVehicle:Set(handle)
 
 	local new_model                     = ENTITY.GET_ENTITY_MODEL(handle)
 	self.m_default_max_speed            = VEHICLE.GET_VEHICLE_MODEL_ESTIMATED_MAX_SPEED(new_model)
-	self.m_last_model                   = new_model
+	self.m_last_model                   = self:GetModelHash()
+	self.m_modelhash                    = new_model
 	self.m_handle                       = handle
 	---@diagnostic disable-next-line
 
@@ -209,7 +209,7 @@ end
 function PlayerVehicle:Reset()
 	-- self:SuspendThreads()
 	if (self:IsValid() and self:IsLocked()) then
-		VEHICLE.SET_VEHICLE_DOORS_LOCKED(self:GetHandle(), 1)
+		self:LockDoors(false)
 		self.m_generic_toggleables["autolockdoors"] = nil
 		self.m_last_model = self:GetModelHash()
 	end
@@ -860,4 +860,4 @@ PlayerVehicle.m_flag_registry = {
 	},
 }
 
-return PlayerVehicle.new(0)
+return PlayerVehicle(0, { noassert = true })