Add get/setVehicleWheelScale (#1641)

* Add get/setVehicleWheelScale

These functions, related to issue #719, expose the wheel scale size
attribute of the CVehicle class to clientside Lua scripts.

* Remove the new functions from CStaticFunctionDefinitions

* Use override keyword in CVehicleSA new methods

This keyword guarantees that these methods override the virtual methods in the CVehicle class, as intended.

Co-authored-by: saml1er <[email protected]>

Author: AlexTMjugador

Client/game_sa/CVehicleSA.h

@@ -369,7 +369,7 @@ class CVehicleSAInterface : public CPhysicalSAInterface
     unsigned char m_colour1, m_colour2, m_colour3, m_colour4;
     char          m_comp1, m_comp2;
     short         m_upgrades[MAX_UPGRADES_ATTACHED];            // 1082
-    float         m_wheelScale;                                 // 1112
+    float         m_fWheelScale;                                // 1112
 
     unsigned short CarAlarmState;               // 1116
     unsigned short ForcedRandomSeed;            // if this is non-zero the random wander gets deterministic
@@ -822,6 +822,8 @@ class CVehicleSA : public virtual CVehicle, public virtual CPhysicalSA
     std::map<SString, SVehicleFrame>& GetComponentMap() { return m_ExtraFrames; }
     bool                              SetPlateText(const SString& strText);
     bool                              SetWindowOpenFlagState(unsigned char ucWindow, bool bState);
+    float                             GetWheelScale() override { return GetVehicleInterface()->m_fWheelScale; }
+    void                              SetWheelScale(float fWheelScale) override { GetVehicleInterface()->m_fWheelScale = fWheelScale; }
 
     void UpdateLandingGearPosition();
 

Client/mods/deathmatch/logic/CClientVehicle.cpp

@@ -135,6 +135,7 @@ CClientVehicle::CClientVehicle(CClientManager* pManager, ElementID ID, unsigned
     m_bEnableHeliBladeCollisions = true;
     m_fNitroLevel = 1.0f;
     m_cNitroCount = 0;
+    m_fWheelScale = 1.0f;
 
     for (unsigned int i = 0; i < MAX_WINDOWS; ++i)
     {
@@ -2681,6 +2682,7 @@ void CClientVehicle::Create()
         m_pVehicle->SetGravity(&m_vecGravity);
         m_pVehicle->SetHeadLightColor(m_HeadLightColor);
         m_pVehicle->SetRadioStatus(0);
+        m_pVehicle->SetWheelScale(m_fWheelScale);
 
         if (IsNitroInstalled())
         {
@@ -4982,3 +4984,21 @@ bool CClientVehicle::IsWindowOpen(uchar ucWindow)
     }
     return false;
 }
+
+void CClientVehicle::SetWheelScale(float fWheelScale)
+{
+    if (m_pVehicle)
+    {
+        m_pVehicle->SetWheelScale(fWheelScale);
+    }
+    m_fWheelScale = fWheelScale;
+}
+
+float CClientVehicle::GetWheelScale()
+{
+    if (m_pVehicle)
+    {
+        return m_pVehicle->GetWheelScale();
+    }
+    return m_fWheelScale;
+}

Client/mods/deathmatch/logic/CClientVehicle.h

@@ -494,6 +494,9 @@ class CClientVehicle : public CClientStreamElement
 
     void SetHeliBladeCollisionsEnabled(bool bEnable) { m_bEnableHeliBladeCollisions = bEnable; }
 
+    float GetWheelScale();
+    void  SetWheelScale(float fWheelScale);
+
     bool OnVehicleFallThroughMap();
 
 protected:
@@ -608,6 +611,7 @@ class CClientVehicle : public CClientStreamElement
     CHandlingEntry*                        m_pHandlingEntry;
     float                                  m_fNitroLevel;
     char                                   m_cNitroCount;
+    float                                  m_fWheelScale;
 
     bool  m_bChainEngine;
     bool  m_bIsDerailed;

Client/mods/deathmatch/logic/luadefs/CLuaVehicleDefs.cpp

@@ -83,6 +83,7 @@ void CLuaVehicleDefs::LoadFunctions()
         {"getVehicleComponents", GetVehicleComponents},
         {"getVehicleModelExhaustFumesPosition", GetVehicleModelExhaustFumesPosition},
         {"getVehicleModelDummyPosition", GetVehicleModelDummyPosition},
+        {"getVehicleWheelScale", ArgumentParser<GetVehicleWheelScale>},
         {"getVehicleModelWheelSize", ArgumentParser<GetVehicleModelWheelSize>},
 
         // Vehicle set funcs
@@ -140,6 +141,7 @@ void CLuaVehicleDefs::LoadFunctions()
         {"setVehicleWindowOpen", SetVehicleWindowOpen},
         {"setVehicleModelExhaustFumesPosition", SetVehicleModelExhaustFumesPosition},
         {"setVehicleModelDummyPosition", SetVehicleModelDummyPosition },
+        {"setVehicleWheelScale", ArgumentParser<SetVehicleWheelScale>},
         {"setVehicleModelWheelSize", ArgumentParser<SetVehicleModelWheelSize>},
     };
 
@@ -223,6 +225,7 @@ void CLuaVehicleDefs::AddClass(lua_State* luaVM)
     lua_classfunction(luaVM, "getUpgradeOnSlot", "getVehicleUpgradeOnSlot");
     lua_classfunction(luaVM, "getModelExhaustFumesPosition", OOP_GetVehicleModelExhaustFumesPosition);
     lua_classfunction(luaVM, "getVehicleModelDummyPosition", OOP_GetVehicleModelDummyPosition);
+    lua_classfunction(luaVM, "getWheelScale", "getVehicleWheelScale");
     lua_classfunction(luaVM, "getModelWheelSize", "getVehicleModelWheelSize");
 
     lua_classfunction(luaVM, "setComponentVisible", "setVehicleComponentVisible");
@@ -267,6 +270,7 @@ void CLuaVehicleDefs::AddClass(lua_State* luaVM)
     lua_classfunction(luaVM, "setGravity", "setVehicleGravity");
     lua_classfunction(luaVM, "setModelExhaustFumesPosition", "setVehicleModelExhaustFumesPosition");
     lua_classfunction(luaVM, "setVehicleModelDummyPosition", "setVehicleModelDummyPosition");
+    lua_classfunction(luaVM, "setWheelScale", "setVehicleWheelScale");
     lua_classfunction(luaVM, "setModelWheelSize", "setVehicleModelWheelSize");
 
     lua_classfunction(luaVM, "resetComponentPosition", "resetVehicleComponentPosition");
@@ -323,6 +327,7 @@ void CLuaVehicleDefs::AddClass(lua_State* luaVM)
     lua_classvariable(luaVM, "nitroRecharging", NULL, "isVehicleNitroRecharging");
     lua_classvariable(luaVM, "gravity", SetVehicleGravity, OOP_GetVehicleGravity);
     lua_classvariable(luaVM, "turnVelocity", SetVehicleTurnVelocity, OOP_GetVehicleTurnVelocity);
+    lua_classvariable(luaVM, "wheelScale", "setVehicleWheelScale", "getVehicleWheelScale");
 
     lua_registerclass(luaVM, "Vehicle", "Element");
 }
@@ -4057,6 +4062,18 @@ int CLuaVehicleDefs::OOP_GetVehicleModelExhaustFumesPosition(lua_State* luaVM)
     return 1;
 }
 
+
+float CLuaVehicleDefs::GetVehicleWheelScale(CClientVehicle* const pVehicle)
+{
+    return pVehicle->GetWheelScale();
+}
+
+bool CLuaVehicleDefs::SetVehicleWheelScale(CClientVehicle* const pVehicle, const float fWheelScale)
+{
+    pVehicle->SetWheelScale(fWheelScale);
+    return true;
+}
+
 std::variant<float, std::unordered_map<std::string, float>> CLuaVehicleDefs::GetVehicleModelWheelSize(
     const unsigned short usModel, const std::optional<eResizableVehicleWheelGroup> eWheelGroup)
 {

Client/mods/deathmatch/logic/luadefs/CLuaVehicleDefs.h

@@ -143,6 +143,8 @@ class CLuaVehicleDefs : public CLuaDefs
     LUA_DECLARE(SetVehicleModelExhaustFumesPosition);
     LUA_DECLARE_OOP(GetVehicleModelExhaustFumesPosition);
 
+    static float GetVehicleWheelScale(CClientVehicle* const pVehicle);
+    static bool SetVehicleWheelScale(CClientVehicle* const pVehicle, const float fWheelScale);
     static std::variant<float, std::unordered_map<std::string, float>> GetVehicleModelWheelSize(const unsigned short                             usModel,
                                                                                                 const std::optional<eResizableVehicleWheelGroup> eWheelGroup);
     static bool SetVehicleModelWheelSize(const unsigned short usModel, const eResizableVehicleWheelGroup eWheelGroup, const float fWheelSize);

Client/sdk/game/CVehicle.h

@@ -327,5 +327,7 @@ class CVehicle : public virtual CPhysical
     virtual void                              UpdateLandingGearPosition() = 0;
     virtual bool                              SetPlateText(const SString& strText) = 0;
     virtual bool                              SetWindowOpenFlagState(unsigned char ucWindow, bool bState) = 0;
+    virtual float                             GetWheelScale() = 0;
+    virtual void                              SetWheelScale(float fWheelScale) = 0;
     virtual CAEVehicleAudioEntity*            GetVehicleAudioEntity() = 0;
 };