chore: tidy up codebase

Author: xesdoog

SmallBase/includes/backend.lua

@@ -19,7 +19,7 @@ eBackendEvent = {
     PLAYER_SWITCH  = 3,
 }
 
----@enum eEntityTypes
+---@enum eEntityType
 eEntityTypes = {
     Ped     = 1,
     Vehicle = 2,
@@ -123,7 +123,7 @@ function Backend:IsPlayerSwitchInProgress()
     return STREAMING.IS_PLAYER_SWITCH_IN_PROGRESS()
 end
 
----@param entity_type eEntityTypes
+---@param entity_type eEntityType
 ---@return number
 function Backend:GetMaxAllowedEntities(entity_type)
     if not self.MaxAllowedEntities[entity_type] then
@@ -134,7 +134,7 @@ function Backend:GetMaxAllowedEntities(entity_type)
 end
 
 ---@param value number
----@param entity_type eEntityTypes
+---@param entity_type eEntityType
 function Backend:SetMaxAllowedEntities(entity_type, value)
     if not self.MaxAllowedEntities[entity_type] then
         return
@@ -143,7 +143,7 @@ function Backend:SetMaxAllowedEntities(entity_type, value)
     self.MaxAllowedEntities[entity_type] = value
 end
 
----@param entity_type eEntityTypes
+---@param entity_type eEntityType
 ---@return boolean
 function Backend:CanCreateEntity(entity_type)
     local currentCount = table.getlen(self.SpawnedEntities[entity_type])
@@ -169,7 +169,7 @@ function Backend:IsBlipRegistered(handle)
 end
 
 ---@param handle integer
----@param entity_type? eEntityTypes
+---@param entity_type? eEntityType
 ---@param etc? table -- metadata
 function Backend:RegisterEntity(handle, entity_type, etc)
     if not Game.IsScriptHandle(handle) then
@@ -185,7 +185,7 @@ function Backend:RegisterEntity(handle, entity_type, etc)
 end
 
 ---@param handle number
----@param entity_type eEntityTypes
+---@param entity_type eEntityType
 function Backend:RemoveEntity(handle, entity_type)
     if not (self.SpawnedEntities[entity_type] or self.SpawnedEntities[entity_type][handle]) then
         return

SmallBase/includes/classes/CEntity.lua

@@ -0,0 +1,71 @@
+---@diagnostic disable: param-type-mismatch
+
+---@ignore
+---@class CBaseModelInfo : GenericClass
+local CBaseModelInfo = GenericClass
+
+---@ignore
+---@class CAttackers : GenericClass
+local CAttackers = GenericClass
+
+--------------------------------------
+-- Class: CEntity
+--------------------------------------
+---@ignore
+---@class CEntity: ClassMeta<CEntity>
+---@field private m_ptr pointer
+---@field m_model_info pointer<CBaseModelInfo> // 0x0020
+---@field m_entity_type uint8_t // 0x0028
+---@field m_model_type pointer<uint8_t> // CBaseModelInfo + 0x009D
+---@field m_flags pointer<uint32_t> // 0x002D
+---@field m_transform_matrix pointer<fMatrix44> // 0x0060
+---@field m_render_focus_distance pointer<uint32_t> // 0x00A8
+---@field m_shadow_flags pointer<uint32_t> // 0x00B0
+---@field m_damage_bits pointer<uint32_t> // 0x0188
+---@field m_hostility pointer<uint8_t> // 0x018C
+---@field m_health pointer<float> // 0x0280
+---@field m_max_health pointer<float> // 0x0284
+---@field m_max_attackers pointer<CAttackers> // 0x0288
+---@overload fun(entity: handle): CEntity
+CEntity = Class("CEntity", nil, 0x290)
+
+---@param entity handle
+---@return CEntity
+function CEntity:init(entity)
+    if not ENTITY.DOES_ENTITY_EXIST(entity) then
+        error("Invalid entity!")
+    end
+
+    local ptr = memory.handle_to_ptr(entity)
+
+    ---@type CEntity
+    local instance = setmetatable({}, CEntity)
+
+    instance.m_ptr = ptr
+    instance.m_model_info = ptr:add(0x0020):deref()
+    instance.m_model_type = instance.m_model_info:add(0x009D)
+    instance.m_flags = ptr:add(0x002D)
+    instance.m_transform_matrix = ptr:add(0x0060)
+    instance.m_render_focus_distance = ptr:add(0x00A8)
+    instance.m_shadow_flags = ptr:add(0x00B0)
+    instance.m_hostility = ptr:add(0x018C)
+    instance.m_health = ptr:add(0x0280)
+    instance.m_max_health = ptr:add(0x0284)
+    instance.m_max_attackers = ptr:add(0x0288)
+
+    return instance
+end
+
+---@return boolean
+function CEntity:IsValid()
+    return self.m_ptr and self.m_ptr:is_valid()
+end
+
+---@return eModelType
+function CEntity:GetModelType()
+    if not self:IsValid() then
+        return 0
+    end
+
+    return (self.m_model_type:get_word() & 0x1F)
+end

SmallBase/includes/classes/CPed.lua

@@ -8,65 +8,53 @@
 -- Class: CPed
 --------------------------------------
 ---@ignore
----@class CPed
----@field private m_addr pointer
----@field CPedIntelligence pointer<CPedIntelligence>
----@field CPedInventory pointer<CPedInventory>
----@field CPedWeaponManager pointer<CPedWeaponManager>
----@field CPlayerInfo? CPlayerInfo
+---@class CPed : CEntity
+---@field private m_ptr pointer
+---@field m_ped_intelligence pointer<CPedIntelligence>
+---@field m_ped_inventory pointer<CPedInventory>
+---@field m_ped_weapon_mgr pointer<CPedWeaponManager>
+---@field m_player_info? CPlayerInfo
 ---@field m_velocity pointer<vec3>
----@field m_ped_type pointer<uint32_t>
+---@field m_ped_type pointer<uint8_t>
 ---@field m_ped_task_flag pointer<uint8_t>
 ---@field m_seatbelt pointer<uint8_t>
 ---@field m_armor pointer<float>
----@field m_cash pointer<uint16_t>
----@overload fun(ped: integer): CPed|nil
-CPed = {}
-CPed.__index = CPed
-setmetatable(CPed, {
-    __call = function(cls, addr)
-        return cls.new(addr)
-    end,
-})
+---@field m_cash pointer<uint16_t> // 0x1614
+---@overload fun(ped: handle): CPed
+CPed = Class("CPed", CEntity, 0x161C)
 
----@param ped integer
----@return CPed|nil
-function CPed.new(ped)
+---@param ped handle
+---@return CPed
+function CPed:init(ped)
     if not ENTITY.DOES_ENTITY_EXIST(ped) or not ENTITY.IS_ENTITY_A_PED(ped) then
-        return
+        error("Invalid entity!")
     end
 
+    self:super().init(self, ped)
     local ptr = memory.handle_to_ptr(ped)
-    if not ptr or ptr:is_null() then
-        return nil
-    end
 
+    ---@type CPed
     local instance = setmetatable({}, CPed)
-    instance.m_addr = ptr
-    instance.CPedIntelligence = ptr:add(0x10A0)
-    instance.CPedInventory = ptr:add(0x10B0)
-    instance.CPedWeaponManager = ptr:add(0x10B8)
+    instance.m_ptr = ptr
+    instance.m_ped_intelligence = ptr:add(0x10A0)
+    instance.m_ped_inventory = ptr:add(0x10B0)
+    instance.m_ped_weapon_mgr = ptr:add(0x10B8)
     instance.m_velocity = ptr:add(0x0300)
     instance.m_ped_type = ptr:add(0x1098)
     instance.m_ped_task_flag = ptr:add(0x144B)
     instance.m_seatbelt = ptr:add(0x143C)
     instance.m_armor = ptr:add(0x150C)
     instance.m_cash = ptr:add(0x1614)
 
-    if PED.IS_PED_A_PLAYER(ped) then
-        instance.CPlayerInfo = CPlayerInfo(ptr:add(0x10A8):deref())
+    if (PED.IS_PED_A_PLAYER(ped)) then
+        instance.m_player_info = CPlayerInfo(ptr:add(0x10A8):deref())
     end
 
     return instance
 end
 
 ---@return boolean
-function CPed:IsValid()
-    return self.m_addr and self.m_addr:is_valid()
-end
-
----@return boolean
-function CPed:CanPedRagdoll()
+function CPed:CanRagdoll()
     if not self:IsValid() then
         return false
     end
@@ -93,11 +81,7 @@ function CPed:GetSpeed()
     return speed_vec:mag()
 end
 
----@return number
-function CPed:GetGameState()
-    if self.CPlayerInfo and self.CPlayerInfo:IsValid() then
-        return self.CPlayerInfo:GetGameState()
-    end
-
-    return -1 -- not a player ped
+---@return ePedType
+function CPed:GetPedType()
+   return (self.m_ped_type:get_word() << 11 >> 25)
 end

SmallBase/includes/classes/CPlayerInfo.lua

@@ -5,36 +5,38 @@
 --------------------------------------
 ---@ignore
 ---@class CPlayerInfo
----@field private m_addr pointer
+---@field private m_ptr pointer
 ---@field m_swim_speed pointer<float>
+---@field m_game_state pointer<uint32_t>
 ---@field m_is_wanted pointer<byte> bool
 ---@field m_wanted_level pointer<uint32_t>
 ---@field m_wanted_level_display pointer<uint32_t>
 ---@field m_run_speed pointer<float>
 ---@field m_stamina pointer<float>
 ---@field m_stamina_regen pointer<float>
 ---@field m_weapon_damage_mult pointer<float>
----@field m_weapon_defence_mult pointer<float>
----@field m_game_state pointer<uint32_t>
----@overload fun(addr: pointer): CPlayerInfo|nil
-CPlayerInfo = {}
+---@field m_weapon_defence_mult pointer<float> // 0x0D70
+---@overload fun(ptr: pointer): CPlayerInfo|nil
+CPlayerInfo = { m_size = 0x0D78 }
 CPlayerInfo.__index = CPlayerInfo
 setmetatable(CPlayerInfo, {
-    __call = function(cls, addr)
-        return cls.new(addr)
+    __call = function(cls, ptr)
+        return cls.new(ptr)
     end,
 })
 
----@return CPlayerInfo|nil
+---@param ptr pointer
+---@return CPlayerInfo
 function CPlayerInfo.new(ptr)
     if not ptr or ptr:is_null() then
-        return nil
+        error("Invalid ped pointer!")
     end
 
     local instance = setmetatable({}, CPlayerInfo)
 
-    instance.m_addr = ptr
+    instance.m_ptr = ptr
     instance.m_swim_speed = ptr:add(0x01C8)
+    instance.m_game_state = ptr:add(0x0230)
     instance.m_is_wanted = ptr:add(0x08E0)
     instance.m_wanted_level = ptr:add(0x08E8)
     instance.m_wanted_level_display = ptr:add(0x08EC)
@@ -43,17 +45,16 @@ function CPlayerInfo.new(ptr)
     instance.m_stamina_regen = ptr:add(0x0D58)
     instance.m_weapon_damage_mult = ptr:add(0x0D6C)
     instance.m_weapon_defence_mult = ptr:add(0x0D70)
-    instance.m_game_state = ptr:add(0x0230)
 
     return instance
 end
 
 ---@return boolean
 function CPlayerInfo:IsValid()
-    return self.m_addr and not self.m_addr:is_null()
+    return self.m_ptr and self.m_ptr:is_valid()
 end
 
----@return number
+---@return eGameState
 function CPlayerInfo:GetGameState()
-    return self.m_game_state:get_dword()
+    return self.m_game_state:get_int()
 end