feat(classes): add more classes

- Add some game classes (unfinished)
- Add a PointerScanner module.
- Document all vector classes.

Author: xesdoog

SmallBase/includes/backend.lua

@@ -109,7 +109,8 @@ end
 
 ---@return boolean
 function Backend:IsUpToDate()
-    return (self.target_build == "any") or (Game.Version._build and self.target_build == Game.Version._build)
+    local game_ver = Game.GetVersion()
+    return (self.target_build == "any") or (game_ver._build and self.target_build == game_ver._build)
 end
 
 ---@param handle integer

SmallBase/includes/classes/CPed.lua

@@ -0,0 +1,87 @@
+---@diagnostic disable: param-type-mismatch
+
+--------------------------------------
+-- Class: CPed
+--------------------------------------
+---@ignore
+---@class CPed
+---@field private m_addr pointer
+---@field CPedIntelligence pointer -- `class`
+---@field CPedInventory pointer -- `class`
+---@field CPedWeaponManager pointer -- `class`
+---@field CPlayerInfo? CPlayerInfo -- `class`
+---@field m_velocity vec3 -- `rage::fvector3`
+---@field m_ped_type number -- `uint32_t`
+---@field m_ped_task_flag number -- `uint8_t`
+---@field m_seatbelt number -- `uint8_t`
+---@field m_armor float -- `float`
+---@overload fun(ped: integer): CPed|nil
+CPed = {}
+CPed.__index = CPed
+setmetatable(CPed, {
+    __call = function(cls, addr)
+        return cls.new(addr)
+    end,
+})
+
+---@param ped integer
+---@return CPed|nil
+function CPed.new(ped)
+    if not ENTITY.DOES_ENTITY_EXIST(ped) or not ENTITY.IS_ENTITY_A_PED(ped) then
+        return
+    end
+
+    local ptr = memory.handle_to_ptr(ped)
+    if not ptr or ptr:is_null() then
+        return nil
+    end
+
+    local instance = setmetatable({}, CPed)
+    instance.m_addr = ptr
+    instance.CPedIntelligence = ptr:add(0x10A0):deref()
+    instance.CPedInventory = ptr:add(0x10B0):deref()
+    instance.CPedWeaponManager = ptr:add(0x10B0):deref()
+    instance.m_velocity = ptr:add(0x0300):get_vec3()
+    instance.m_ped_type = ptr:add(0x1098):get_dword()
+    instance.m_ped_task_flag = ptr:add(0x144B):get_byte()
+    instance.m_seatbelt = ptr:add(0x143C):get_word()
+    instance.m_armor = ptr:add(0x150C):get_float()
+
+    if PED.IS_PED_A_PLAYER(ped) then
+        instance.CPlayerInfo = CPlayerInfo(ptr:add(0x10A8):deref())
+    end
+
+    return instance
+end
+
+---@return boolean
+function CPed:IsValid()
+    return self.m_addr and not self.m_addr:is_null()
+end
+
+---@return boolean
+function CPed:CanPedRagdoll()
+    if not self:IsValid() then
+        return false
+    end
+
+    return (self.m_ped_type & 0x20) ~= 0
+end
+
+---@return boolean
+function CPed:HasSeatbelt()
+    if not self:IsValid() then
+        return false
+    end
+
+    return (self.m_seatbelt & 0x3) ~= 0
+end
+
+---@retuurn number
+function CPed:GetGameState()
+    if self.CPlayerInfo then
+        return self.CPlayerInfo:GetGameState()
+    end
+
+    return -1 -- not a player ped
+end

SmallBase/includes/classes/CPlayerInfo.lua

@@ -0,0 +1,59 @@
+---@diagnostic disable: param-type-mismatch
+
+--------------------------------------
+-- Class: CPlayerInfo
+--------------------------------------
+---@ignore
+---@class CPlayerInfo
+---@field private m_addr pointer
+---@field m_swim_speed float `float`
+---@field m_is_wanted boolean `boolean`
+---@field m_wanted_level number `uint32_t`
+---@field m_wanted_level_display number `uint32_t`
+---@field m_run_speed float `float`
+---@field m_stamina float `float`
+---@field m_stamina_regen float `float`
+---@field m_weapon_damage_mult float `float`
+---@field m_weapon_defence_mult float `float`
+---@field m_game_state number `uint32_t`
+---@overload fun(addr: pointer): CPlayerInfo|nil
+CPlayerInfo = {}
+CPlayerInfo.__index = CPlayerInfo
+setmetatable(CPlayerInfo, {
+    __call = function(cls, addr)
+        return cls.new(addr)
+    end,
+})
+
+---@return CPlayerInfo|nil
+function CPlayerInfo.new(ptr)
+    if not ptr or ptr:is_null() then
+        return nil
+    end
+
+    local instance = setmetatable({}, CPlayerInfo)
+
+    instance.m_addr = ptr
+    instance.m_swim_speed = ptr:add(0x01C8):get_float()
+    instance.m_is_wanted = ptr:add(0x08E0):get_byte()
+    instance.m_wanted_level = ptr:add(0x08E8):get_dword()
+    instance.m_wanted_level_display = ptr:add(0x08EC):get_dword()
+    instance.m_run_speed = ptr:add(0x0D50):get_float()
+    instance.m_stamina = ptr:add(0x0D54):get_float()
+    instance.m_stamina_regen = ptr:add(0x0D58):get_float()
+    instance.m_weapon_damage_mult = ptr:add(0x0D6C):get_float()
+    instance.m_weapon_defence_mult = ptr:add(0x0D70):get_float()
+    instance.m_game_state = ptr:add(0x0230):get_dword()
+
+    return instance
+end
+
+---@return boolean
+function CPlayerInfo:IsValid()
+    return self.m_addr and not self.m_addr:is_null()
+end
+
+---@return number
+function CPlayerInfo:GetGameState()
+    return self.m_game_state
+end