Add onPlayerResourceStart trigger check

Important: This commit also bumps _NETCODE_VERSION

Author: botder

Client/mods/deathmatch/logic/CPacketHandler.cpp

@@ -5023,8 +5023,9 @@ void CPacketHandler::Packet_ResourceStart(NetBitStreamInterface& bitStream)
         uiTotalSizeProcessed = 0;
 
     /*
-     * unsigned char (1)   - resource name size
+     * unsigned char (1)    - resource name size
      * unsigned char (x)    - resource name
+     * unsigned int  (4)    - start counter
      * unsigned short (2)   - resource id
      * unsigned short (2)   - resource entity id
      * unsigned short (2)   - resource dynamic entity id
@@ -5079,6 +5080,10 @@ void CPacketHandler::Packet_ResourceStart(NetBitStreamInterface& bitStream)
         return;
     }
 
+    // Start counter
+    unsigned int startCounter{};
+    bitStream.Read(startCounter);
+
     // Resource ID
     unsigned short usResourceID;
     bitStream.Read(usResourceID);
@@ -5122,6 +5127,7 @@ void CPacketHandler::Packet_ResourceStart(NetBitStreamInterface& bitStream)
     {
         pResource->SetRemainingNoClientCacheScripts(usNoClientCacheScriptCount);
         pResource->SetDownloadPriorityGroup(iDownloadPriorityGroup);
+        pResource->SetStartCounter(startCounter);
 
         // Resource Chunk Type (F = Resource File, E = Exported Function)
         unsigned char ucChunkType;

Client/mods/deathmatch/logic/CResource.cpp

@@ -341,6 +341,7 @@ void CResource::Load()
         {
             // Write resource net ID
             pBitStream->Write(GetNetID());
+            pBitStream->Write(GetStartCounter());
             g_pNet->SendPacket(PACKET_ID_PLAYER_RESOURCE_START, pBitStream, PACKET_PRIORITY_HIGH, PACKET_RELIABILITY_RELIABLE_ORDERED);
             g_pNet->DeallocateNetBitStream(pBitStream);
         }

Client/mods/deathmatch/logic/CResource.h

@@ -110,9 +110,13 @@ class CResource
     int                GetDownloadPriorityGroup() { return m_iDownloadPriorityGroup; }
     void               SetDownloadPriorityGroup(int iDownloadPriorityGroup) { m_iDownloadPriorityGroup = iDownloadPriorityGroup; }
 
+    void         SetStartCounter(unsigned int startCounter) { m_startCounter = startCounter; }
+    unsigned int GetStartCounter() const noexcept { return m_startCounter; }
+
 private:
     unsigned short       m_usNetID;
     uint                 m_uiScriptID;
+    unsigned int         m_startCounter{};
     SString              m_strResourceName;
     CLuaMain*            m_pLuaVM;
     CLuaManager*         m_pLuaManager;

Server/mods/deathmatch/logic/CGame.cpp

@@ -1555,6 +1555,9 @@ void CGame::QuitPlayer(CPlayer& Player, CClient::eQuitReasons Reason, bool bSayI
 
         Player.CallEvent("onPlayerQuit", Arguments);
 
+        // Tell the resource manager
+        m_pResourceManager->OnPlayerQuit(Player);
+
         // Tell the map manager
         m_pMapManager->OnPlayerQuit(Player);
 
@@ -4172,17 +4175,16 @@ void CGame::Packet_PlayerNetworkStatus(CPlayerNetworkStatusPacket& Packet)
 
 void CGame::Packet_PlayerResourceStart(CPlayerResourceStartPacket& Packet)
 {
-    CPlayer* pPlayer = Packet.GetSourcePlayer();
-    if (pPlayer)
-    {
-        CResource* pResource = Packet.GetResource();
-        if (pResource)
-        {
-            CLuaArguments Arguments;
-            Arguments.PushResource(pResource);
-            pPlayer->CallEvent("onPlayerResourceStart", Arguments, NULL);
-        }
-    }
+    CPlayer*     sourcePlayer = Packet.GetSourcePlayer();
+    CResource*   resource = Packet.GetResource();
+    unsigned int playerStartCounter = Packet.GetStartCounter();
+
+    if (!sourcePlayer || !resource || !resource->CanPlayerTriggerResourceStart(sourcePlayer, playerStartCounter))
+        return;
+
+    CLuaArguments Arguments;
+    Arguments.PushResource(resource);
+    sourcePlayer->CallEvent("onPlayerResourceStart", Arguments, nullptr);
 }
 
 void CGame::Packet_PlayerWorldSpecialProperty(CPlayerWorldSpecialPropertyPacket& packet) noexcept

Server/mods/deathmatch/logic/CResource.cpp

@@ -362,6 +362,23 @@ void CResource::Reload()
     Load();
 }
 
+bool CResource::CanPlayerTriggerResourceStart(CPlayer* player, unsigned int playerStartCounter)
+{
+    if (playerStartCounter != m_startCounter || m_eState != EResourceState::Running)
+        return false;
+
+    if (m_isRunningForPlayer.contains(player))
+        return false;
+
+    m_isRunningForPlayer.insert(player);
+    return true;
+}
+
+void CResource::OnPlayerQuit(CPlayer& Player)
+{
+    m_isRunningForPlayer.erase(&Player);
+}
+
 CResource::~CResource()
 {
     CIdArray::PushUniqueId(this, EIdClass::RESOURCE, m_uiScriptID);
@@ -1017,6 +1034,7 @@ bool CResource::Start(std::list<CResource*>* pDependents, bool bManualStart, con
         return false;
     }
 
+    m_startCounter = std::max<unsigned int>(m_startCounter + 1, 1); // We consider zero to be an invalid start counter.
     m_bStartedManually = bManualStart;
 
     // Remember the client files state
@@ -1028,7 +1046,7 @@ bool CResource::Start(std::list<CResource*>* pDependents, bool bManualStart, con
 
     // Broadcast new resourceelement that is loaded and tell the players that a new resource was started
     g_pGame->GetMapManager()->BroadcastResourceElements(m_pResourceElement, m_pDefaultElementGroup);
-    g_pGame->GetPlayerManager()->BroadcastOnlyJoined(CResourceStartPacket(m_strResourceName.c_str(), this));
+    g_pGame->GetPlayerManager()->BroadcastOnlyJoined(CResourceStartPacket(m_strResourceName, this, m_startCounter));
     SendNoClientCacheScripts();
     m_bClientSync = true;
 
@@ -1174,6 +1192,9 @@ bool CResource::Stop(bool bManualStop)
     // Broadcast the packet to joined players
     g_pGame->GetPlayerManager()->BroadcastOnlyJoined(removePacket);
 
+    // Clear the list of players where this resource is running
+    std::exchange(m_isRunningForPlayer, {});
+
     OnResourceStateChange("loaded");
     m_eState = EResourceState::Loaded;
     return true;
@@ -3312,8 +3333,7 @@ bool CResource::CheckState()
 
 void CResource::OnPlayerJoin(CPlayer& Player)
 {
-    // do the player join crap
-    Player.Send(CResourceStartPacket(m_strResourceName.c_str(), this));
+    Player.Send(CResourceStartPacket(m_strResourceName.c_str(), this, m_startCounter));
     SendNoClientCacheScripts(&Player);
 }
 

Server/mods/deathmatch/logic/CResource.h

@@ -153,6 +153,8 @@ class CResource : public EHS
 
     void Reload();
 
+    bool CanPlayerTriggerResourceStart(CPlayer* player, unsigned int playerStartCounter);
+
     // Get a resource default setting
     bool GetDefaultSetting(const char* szName, char* szValue, size_t sizeBuffer);
 
@@ -268,6 +270,7 @@ class CResource : public EHS
     uint GetScriptID() const noexcept { return m_uiScriptID; }
 
     void OnPlayerJoin(CPlayer& Player);
+    void OnPlayerQuit(CPlayer& Player);
     void SendNoClientCacheScripts(CPlayer* pPlayer = nullptr);
 
     void OnResourceStateChange(const char* state) noexcept;
@@ -395,6 +398,9 @@ class CResource : public EHS
     CElementGroup* m_pDefaultElementGroup = nullptr;            // stores elements created by scripts in this resource
     CLuaMain*      m_pVM = nullptr;
 
+    unsigned int                 m_startCounter{};
+    std::unordered_set<CPlayer*> m_isRunningForPlayer;
+
     KeyValueMap                    m_Info;
     std::list<CIncludedResources*> m_IncludedResources;            // we store them here temporarily, then read them once all the resources are loaded
     std::list<CResourceFile*>      m_ResourceFiles;

Server/mods/deathmatch/logic/CResourceManager.cpp

@@ -543,6 +543,14 @@ void CResourceManager::OnPlayerJoin(CPlayer& Player)
     }
 }
 
+void CResourceManager::OnPlayerQuit(CPlayer& Player)
+{
+    for (CResource* resource : CResource::m_StartedResources)
+    {
+        resource->OnPlayerQuit(Player);
+    }
+}
+
 //
 // Add resource <-> luaVM lookup mapping
 //

Server/mods/deathmatch/logic/CResourceManager.h

@@ -67,6 +67,7 @@ class CResourceManager
     unsigned int GetResourceLoadedCount() { return m_uiResourceLoadedCount; }
     unsigned int GetResourceFailedCount() { return m_uiResourceFailedCount; }
     void         OnPlayerJoin(CPlayer& Player);
+    void         OnPlayerQuit(CPlayer& Player);
 
     const char* GetResourceDirectory();
 

Server/mods/deathmatch/logic/packets/CPlayerResourceStartPacket.cpp

@@ -15,8 +15,11 @@
 
 bool CPlayerResourceStartPacket::Read(NetBitStreamInterface& BitStream)
 {
-    ushort usResourceNetId;
-    BitStream.Read(usResourceNetId);
+    ushort usResourceNetId{};
+
+    if (!BitStream.Read(usResourceNetId) || !BitStream.Read(m_startCounter))
+        return false;
+
     m_pResource = g_pGame->GetResourceManager()->GetResourceFromNetID(usResourceNetId);
     return true;
 }

Server/mods/deathmatch/logic/packets/CPlayerResourceStartPacket.h

@@ -17,16 +17,18 @@ class CResource;
 class CPlayerResourceStartPacket final : public CPacket
 {
 public:
-    CPlayerResourceStartPacket() {}
+    CPlayerResourceStartPacket() = default;
 
-    ePacketID               GetPacketID() const { return PACKET_ID_PLAYER_RESOURCE_START; }
-    unsigned long           GetFlags() const { return PACKET_HIGH_PRIORITY | PACKET_RELIABLE | PACKET_SEQUENCED; };
-    virtual ePacketOrdering GetPacketOrdering() const { return PACKET_ORDERING_DEFAULT; }
+    ePacketID       GetPacketID() const override { return PACKET_ID_PLAYER_RESOURCE_START; }
+    unsigned long   GetFlags() const override { return PACKET_HIGH_PRIORITY | PACKET_RELIABLE | PACKET_SEQUENCED; }
+    ePacketOrdering GetPacketOrdering() const override { return PACKET_ORDERING_DEFAULT; }
 
     bool Read(NetBitStreamInterface& BitStream);
 
-    CResource* GetResource() const { return m_pResource; }
+    CResource* GetResource() const noexcept { return m_pResource; }
+    unsigned int GetStartCounter() const noexcept { return m_startCounter; }
 
 private:
-    CResource* m_pResource;
+    CResource*   m_pResource{};
+    unsigned int m_startCounter{};
 };