Add interface for model flags

Client/game_sa/CGameSA.cpp

@@ -841,6 +841,11 @@ void CGameSA::ResetModelLodDistances()
     CModelInfoSA::StaticResetLodDistances();
 }
 
+void CGameSA::ResetModelFlags()
+{
+    CModelInfoSA::StaticResetFlags();
+}
+
 void CGameSA::ResetAlphaTransparencies()
 {
     CModelInfoSA::StaticResetAlphaTransparencies();

Client/game_sa/CGameSA.h

@@ -415,6 +415,7 @@ class CGameSA : public CGame
     CWeaponStat* CreateWeaponStat(eWeaponType weaponType, eWeaponSkill weaponSkill);
     void         FlushPendingRestreamIPL();
     void         ResetModelLodDistances();
+    void         ResetModelFlags();
     void         ResetAlphaTransparencies();
     void         DisableVSync();
 

Client/game_sa/CModelInfoSA.cpp

@@ -19,6 +19,7 @@ CBaseModelInfoSAInterface** ppModelInfo = (CBaseModelInfoSAInterface**)ARRAY_Mod
 
 std::map<unsigned short, int>                                         CModelInfoSA::ms_RestreamTxdIDMap;
 std::map<DWORD, float>                                                CModelInfoSA::ms_ModelDefaultLodDistanceMap;
+std::map<DWORD, unsigned short>                                       CModelInfoSA::ms_ModelDefaultFlagsMap;
 std::map<DWORD, BYTE>                                                 CModelInfoSA::ms_ModelDefaultAlphaTransparencyMap;
 std::unordered_map<std::uint32_t, std::map<eVehicleDummies, CVector>> CModelInfoSA::ms_ModelDefaultDummiesPosition;
 std::unordered_map<DWORD, unsigned short>                             CModelInfoSA::ms_OriginalObjectPropertiesGroups;
@@ -482,21 +483,67 @@ BOOL CModelInfoSA::DoIsLoaded()
     return bLoaded;
 }
 
-BYTE CModelInfoSA::GetFlags()
+unsigned short CModelInfoSA::GetFlags()
 {
-    DWORD dwFunc = FUNC_GetModelFlags;
-    DWORD ModelID = m_dwModelID;
-    BYTE  bFlags = 0;
-    _asm
-    {
-        push    ModelID
-        call    dwFunc
-        add     esp, 4
-        mov     bFlags, al
-    }
-    return bFlags;
+    m_pInterface = ppModelInfo[m_dwModelID];
+    if (m_pInterface)
+        return m_pInterface->usFlags;
+    return 0;
+}
+
+unsigned short CModelInfoSA::GetOriginalFlags()
+{
+    if (MapContains(ms_ModelDefaultFlagsMap, m_dwModelID))
+        return MapGet(ms_ModelDefaultFlagsMap, m_dwModelID);
+
+    return 0;
 }
 
+void CModelInfoSA::SetFlags(unsigned int uiFlags)
+{
+    m_pInterface = ppModelInfo[m_dwModelID];
+    if (!m_pInterface)
+        return;
+
+    // Save default value if not done yet
+    if (!MapContains(ms_ModelDefaultFlagsMap, m_dwModelID))
+        MapSet(ms_ModelDefaultFlagsMap, m_dwModelID, m_pInterface->usFlags);
+
+    m_pInterface->usFlags = 0xC0;
+    typedef char(__cdecl * Function_SetAtomicModelFlags)(CBaseModelInfoSAInterface * pInterface, unsigned int uiFlags);
+    Function_SetAtomicModelFlags setAtomicModelFlags = (Function_SetAtomicModelFlags)(FUNC_SetAtimicModelFlags);
+
+    setAtomicModelFlags(m_pInterface, uiFlags);
+}
+
+void CModelInfoSA::StaticResetFlags()
+{
+    // Restore default values
+    for (std::map<DWORD, unsigned short>::const_iterator iter = ms_ModelDefaultFlagsMap.begin(); iter != ms_ModelDefaultFlagsMap.end(); ++iter)
+    {
+        CBaseModelInfoSAInterface* pInterface = ppModelInfo[iter->first];
+        if (pInterface)
+            pInterface->usFlags = iter->second;
+    }
+
+    ms_ModelDefaultFlagsMap.clear();
+}
+
+//BYTE CModelInfoSA::GetStreamFlags()
+//{
+//    DWORD dwFunc = FUNC_GetModelFlags;
+//    DWORD ModelID = m_dwModelID;
+//    BYTE  bFlags = 0;
+//    _asm
+//    {
+//        push    ModelID
+//        call    dwFunc
+//        add     esp, 4
+//        mov     bFlags, al
+//    }
+//    return bFlags;
+//}
+
 CBoundingBox* CModelInfoSA::GetBoundingBox()
 {
     DWORD         dwFunc = FUNC_GetBoundingBox;

Client/game_sa/CModelInfoSA.h

@@ -36,7 +36,9 @@ class CPedModelInfoSAInterface;
 #define     ARRAY_ModelInfo                 0xA9B0C8
 #define     CLASS_CText                     0xC1B340
 #define     FUNC_CText_Get                  0x6A0050
-#define     FUNC_GetModelFlags              0x4044E0
+#define     FUNC_SetBaseModelFlags          0x5B3AD0
+#define     FUNC_SetAtimicModelFlags        0x5B3B20
+#define     FUNC_GetModelStreamFlags        0x4044E0
 #define     FUNC_GetBoundingBox             0x4082F0
 
 #define     FUNC_RemoveRef                  0x4C4BB0
@@ -153,23 +155,31 @@ class CBaseModelInfoSAInterface
     unsigned short usDynamicIndex : 16;            // +16
 
     // Flags used by CBaseModelInfo
-    unsigned char bHasBeenPreRendered : 1;            // +18
-    unsigned char bAlphaTransparency : 1;
-    unsigned char bIsLod : 1;
-    unsigned char bDontWriteZBuffer : 1;
-    unsigned char bDontCastShadowsOn : 1;
-    unsigned char bDrawAdditive : 1;
-    unsigned char bDrawLast : 1;
-    unsigned char bDoWeOwnTheColModel : 1;
-
-    unsigned char dwUnknownFlag25 : 1;            // +19
-    unsigned char dwUnknownFlag26 : 1;
-    unsigned char dwUnknownFlag27 : 1;
-    unsigned char bSwaysInWind : 1;
-    unsigned char bCollisionWasStreamedWithModel : 1;            // CClumpModelInfo::SetCollisionWasStreamedWithModel(unsigned int)
-    unsigned char bDontCollideWithFlyer : 1;                     // CAtomicModelInfo::SetDontCollideWithFlyer(unsigned int)
-    unsigned char bHasComplexHierarchy : 1;                      // CClumpModelInfo::SetHasComplexHierarchy(unsigned int)
-    unsigned char bWetRoadReflection : 1;                        // CAtomicModelInfo::SetWetRoadReflection(unsigned int)
+    union
+    {
+        struct
+        {
+            unsigned short bHasBeenPreRendered : 1;            // +18
+            unsigned short bAlphaTransparency : 1;
+            unsigned short bIsLod : 1;
+            unsigned short bDontWriteZBuffer : 1;
+            unsigned short bDontCastShadowsOn : 1;
+            unsigned short bDrawAdditive : 1;
+            unsigned short bDrawLast : 1;
+            unsigned short bDoWeOwnTheColModel : 1;
+
+            unsigned short dwUnknownFlag25 : 1;            // +19
+            unsigned short dwUnknownFlag26 : 1;
+            unsigned short dwUnknownFlag27 : 1;
+            unsigned short bSwaysInWind : 1;
+            unsigned short bCollisionWasStreamedWithModel : 1;            // CClumpModelInfo::SetCollisionWasStreamedWithModel(unsigned int)
+            unsigned short bDontCollideWithFlyer : 1;                     // CAtomicModelInfo::SetDontCollideWithFlyer(unsigned int)
+            unsigned short bHasComplexHierarchy : 1;                      // CClumpModelInfo::SetHasComplexHierarchy(unsigned int)
+            unsigned short bWetRoadReflection : 1;                        // CAtomicModelInfo::SetWetRoadReflection(unsigned int)
+        };
+
+        unsigned short usFlags;
+    };
 
     CColModelSAInterface* pColModel;            // +20      CColModel: public CBoundingBox
 
@@ -218,6 +228,7 @@ class CBaseModelInfoSAInterface
     // +762 = Array of WORD containing something relative to paintjobs
     // +772 = Anim file index
 };
+static_assert(sizeof(CBaseModelInfoSAInterface) == 0x20, "Invalid size for CBaseModelInfoSAInterface");
 
 class CVehicleModelVisualInfoSAInterface            // Not sure about this name. If somebody knows more, please change
 {
@@ -277,6 +288,7 @@ class CModelInfoSA : public CModelInfo
     RpClump*                                                                     m_pCustomClump;
     static std::map<unsigned short, int>                                         ms_RestreamTxdIDMap;
     static std::map<DWORD, float>                                                ms_ModelDefaultLodDistanceMap;
+    static std::map<DWORD, unsigned short>                                       ms_ModelDefaultFlagsMap;
     static std::map<DWORD, BYTE>                                                 ms_ModelDefaultAlphaTransparencyMap;
     static std::unordered_map<std::uint32_t, std::map<eVehicleDummies, CVector>> ms_ModelDefaultDummiesPosition;
     static std::unordered_map<DWORD, unsigned short>                             ms_OriginalObjectPropertiesGroups;
@@ -318,7 +330,10 @@ class CModelInfoSA : public CModelInfo
     BYTE           GetLevelFromPosition(CVector* vecPosition);
     BOOL           IsLoaded();
     BOOL           DoIsLoaded();
-    BYTE           GetFlags();
+    unsigned short GetFlags();
+    unsigned short GetOriginalFlags();
+    void           SetFlags(unsigned int uiFlags);
+    static void    StaticResetFlags();
     CBoundingBox*  GetBoundingBox();
     bool           IsValid();
     float          GetDistanceFromCentreOfMassToBaseOfModel();

Client/mods/deathmatch/logic/CClientGame.cpp

@@ -3559,6 +3559,7 @@ void CClientGame::Event_OnIngame()
     g_pGame->GetWorld()->SetOcclusionsEnabled(true);
 
     g_pGame->ResetModelLodDistances();
+    g_pGame->ResetModelFlags();
     g_pGame->ResetAlphaTransparencies();
 
     // Make sure we can access all areas

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

@@ -46,7 +46,10 @@ void CLuaEngineDefs::LoadFunctions()
         {"engineRestoreModelPhysicalPropertiesGroup", EngineRestoreModelPhysicalPropertiesGroup},
         {"engineSetObjectGroupPhysicalProperty", EngineSetObjectGroupPhysicalProperty},
         {"engineGetObjectGroupPhysicalProperty", EngineGetObjectGroupPhysicalProperty},
-        {"engineRestoreObjectGroupPhysicalProperties", EngineRestoreObjectGroupPhysicalProperties}
+        {"engineRestoreObjectGroupPhysicalProperties", EngineRestoreObjectGroupPhysicalProperties},
+        {"engineGetModelFlags", EngineGetModelFlags},
+        {"engineSetModelFlags", EngineSetModelFlags},
+        {"engineResetModelFlags", EngineResetModelFlags},
 
         // CLuaCFunctions::AddFunction ( "engineReplaceMatchingAtomics", EngineReplaceMatchingAtomics );
         // CLuaCFunctions::AddFunction ( "engineReplaceWheelAtomics", EngineReplaceWheelAtomics );
@@ -84,6 +87,10 @@ void CLuaEngineDefs::AddClass(lua_State* luaVM)
     lua_classfunction(luaVM, "getObjectGroupPhysicalProperty", "engineGetObjectGroupPhysicalProperty");
     lua_classfunction(luaVM, "restoreObjectGroupPhysicalProperties", "engineRestoreObjectGroupPhysicalProperties");
 
+    lua_classfunction(luaVM, "setModelFlags", "engineSetModelFlags");
+    lua_classfunction(luaVM, "resetModelFlags", "engineResetModelFlags");
+    lua_classfunction(luaVM, "getModelFlags", "engineGetModelFlags");
+
     lua_registerstaticclass(luaVM, "Engine");
 
     AddEngineColClass(luaVM);
@@ -1969,3 +1976,92 @@ int CLuaEngineDefs::EngineRestoreObjectGroupPhysicalProperties(lua_State* luaVM)
     lua_pushboolean(luaVM, true);
     return 1;
 }
+
+int CLuaEngineDefs::EngineGetModelFlags(lua_State* luaVM)
+{
+    // float engineGetModelFlags ( int/string modelID )
+    SString          strModelId;
+    CScriptArgReader argStream(luaVM);
+    argStream.ReadString(strModelId);
+
+    if (!argStream.HasErrors())
+    {
+        ushort usModelID = CModelNames::ResolveModelID(strModelId);
+        if (usModelID < 20000)
+        {
+            CModelInfo* pModelInfo = g_pGame->GetModelInfo(usModelID);
+            if (pModelInfo)
+            {
+                lua_pushnumber(luaVM, pModelInfo->GetFlags());
+                return 1;
+            }
+        }
+        else
+            argStream.SetCustomError(SString("Expected a valid model name or ID in range [0-19999] at argument 1, got \"%s\"", *strModelId));
+    }
+    if (argStream.HasErrors())
+        m_pScriptDebugging->LogCustom(luaVM, argStream.GetFullErrorMessage());
+
+    // Failed
+    lua_pushboolean(luaVM, false);
+    return 1;
+}
+
+int CLuaEngineDefs::EngineSetModelFlags(lua_State* luaVM)
+{
+    // bool engineSetModelFlags ( int/string modelID, int flags )
+    SString          strModelId;
+    unsigned int     uiFlags;
+    CScriptArgReader argStream(luaVM);
+    argStream.ReadString(strModelId);
+    argStream.ReadNumber(uiFlags);
+
+    if (!argStream.HasErrors())
+    {
+        ushort usModelID = CModelNames::ResolveModelID(strModelId);
+        if (usModelID < 20000)
+        {
+            CModelInfo* pModelInfo = g_pGame->GetModelInfo(usModelID);
+            if (pModelInfo)
+            {
+                pModelInfo->SetFlags(uiFlags);
+                lua_pushboolean(luaVM, true);
+                return 1;
+            }
+        }
+        else
+            argStream.SetCustomError(SString("Expected a valid model name or ID in range [0-19999] at argument 1, got \"%s\"", *strModelId));
+    }
+    if (argStream.HasErrors())
+        m_pScriptDebugging->LogCustom(luaVM, argStream.GetFullErrorMessage());
+
+    lua_pushboolean(luaVM, false);
+    return 1;
+}
+
+int CLuaEngineDefs::EngineResetModelFlags(lua_State* luaVM)
+{
+    SString          strModel = "";
+    CScriptArgReader argStream(luaVM);
+    argStream.ReadString(strModel);
+
+    if (argStream.HasErrors())
+        return luaL_error(luaVM, argStream.GetFullErrorMessage());
+
+    unsigned short usModelID = CModelNames::ResolveModelID(strModel);
+    CModelInfo*    pModelInfo = g_pGame->GetModelInfo(usModelID);
+    if (pModelInfo)
+    {
+        float uiCurrentFlags = pModelInfo->GetFlags();
+        float uiOriginalFlags = pModelInfo->GetOriginalFlags();
+        if (uiOriginalFlags != uiCurrentFlags)
+        {
+            pModelInfo->SetLODDistance(uiOriginalFlags, true);
+            lua_pushboolean(luaVM, true);
+            return 1;
+        }
+    }
+
+    lua_pushboolean(luaVM, false);
+    return 1;
+}

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

@@ -57,6 +57,9 @@ class CLuaEngineDefs : public CLuaDefs
     LUA_DECLARE(EngineSetObjectGroupPhysicalProperty)
     LUA_DECLARE(EngineGetObjectGroupPhysicalProperty)
     LUA_DECLARE(EngineRestoreObjectGroupPhysicalProperties)
+    LUA_DECLARE(EngineGetModelFlags);
+    LUA_DECLARE(EngineSetModelFlags);
+    LUA_DECLARE(EngineResetModelFlags);
 
 private:
     static void AddEngineColClass(lua_State* luaVM);

Client/sdk/game/CGame.h

@@ -237,6 +237,7 @@ class __declspec(novtable) CGame
     virtual bool HasCreditScreenFadedOut() = 0;
     virtual void FlushPendingRestreamIPL() = 0;
     virtual void ResetModelLodDistances() = 0;
+    virtual void ResetModelFlags() = 0;
     virtual void ResetAlphaTransparencies() = 0;
     virtual void DisableVSync() = 0;
 

Client/sdk/game/CModelInfo.h

@@ -121,7 +121,9 @@ class CModelInfo
     virtual VOID           Request(EModelRequestType requestType, const char* szTag /* = NULL*/) = 0;
     virtual BYTE           GetLevelFromPosition(CVector* vecPosition) = 0;
     virtual BOOL           IsLoaded() = 0;
-    virtual BYTE           GetFlags() = 0;
+    virtual unsigned short GetFlags() = 0;
+    virtual unsigned short GetOriginalFlags() = 0;
+    virtual void           SetFlags(unsigned int uiFlags) = 0;
     virtual CBoundingBox*  GetBoundingBox() = 0;
     virtual bool           IsValid() = 0;
     virtual unsigned short GetTextureDictionaryID() = 0;