Refactor event handler and improve performance [So far: ~40-50%]

Client/mods/deathmatch/CVoiceRecorder.cpp

@@ -206,7 +206,7 @@ void CVoiceRecorder::SetPTTState(bool bState)
             {
                 m_Mutex.unlock();
                 CLuaArguments Arguments;
-                bool          bEventTriggered = g_pClientGame->GetLocalPlayer()->CallEvent("onClientPlayerVoiceStart", Arguments, true);
+                bool          bEventTriggered = g_pClientGame->GetLocalPlayer()->CallEvent(BuiltInEvents::onClientPlayerVoiceStart, Arguments, true);
 
                 if (!bEventTriggered)
                     return;
@@ -229,7 +229,7 @@ void CVoiceRecorder::SetPTTState(bool bState)
             {
                 m_Mutex.unlock();
                 CLuaArguments Arguments;
-                g_pClientGame->GetLocalPlayer()->CallEvent("onClientPlayerVoiceStop", Arguments, true);
+                g_pClientGame->GetLocalPlayer()->CallEvent(BuiltInEvents::onClientPlayerVoiceStop, Arguments, true);
                 return;
             }
         }

Client/mods/deathmatch/ClientCommands.cpp

@@ -73,7 +73,7 @@ bool COMMAND_Executed(const char* szCommand, const char* szArguments, bool bHand
                 Arguments.PushString(strClumpedCommand);
             }
 
-            pLocalPlayer->CallEvent("onClientConsole", Arguments, true);
+            pLocalPlayer->CallEvent(BuiltInEvents::onClientConsole, Arguments, true);
         }
 
         // Write the chatlength and the content

Client/mods/deathmatch/StdInc.h

@@ -95,7 +95,6 @@
 #include <CCustomData.h>
 #include <CElementArray.h>
 #include <CLogger.h>
-#include <CMapEventManager.h>
 #include <CClientModelManager.h>
 #include <CModelNames.h>
 #include <CIFPEngine.h>
@@ -154,7 +153,6 @@
 // Deathmatch includes
 #include "ClientCommands.h"
 #include "CClient.h"
-#include "CEvents.h"
 #include "HeapTrace.h"
 #include "logic/CClientGame.h"
 #include "logic/CClientModelCacheManager.h"

Client/mods/deathmatch/logic/CClientColManager.cpp

@@ -152,12 +152,12 @@ void CClientColManager::HandleHitDetectionResult(bool bHit, CClientColShape* pSh
                 CLuaArguments Arguments;
                 Arguments.PushElement(pEntity);
                 Arguments.PushBoolean((pShape->GetDimension() == pEntity->GetDimension()));
-                pShape->CallEvent("onClientColShapeHit", Arguments, true);
+                pShape->CallEvent(BuiltInEvents::onClientColShapeHit, Arguments, true);
 
                 CLuaArguments Arguments2;
                 Arguments2.PushElement(pShape);
                 Arguments2.PushBoolean((pShape->GetDimension() == pEntity->GetDimension()));
-                pEntity->CallEvent("onClientElementColShapeHit", Arguments2, true);
+                pEntity->CallEvent(BuiltInEvents::onClientElementColShapeHit, Arguments2, true);
             }
 
             // Run whatever callback the collision item might have attached
@@ -177,12 +177,12 @@ void CClientColManager::HandleHitDetectionResult(bool bHit, CClientColShape* pSh
             CLuaArguments Arguments;
             Arguments.PushElement(pEntity);
             Arguments.PushBoolean((pShape->GetDimension() == pEntity->GetDimension()));
-            pShape->CallEvent("onClientColShapeLeave", Arguments, true);
+            pShape->CallEvent(BuiltInEvents::onClientColShapeLeave, Arguments, true);
 
             CLuaArguments Arguments2;
             Arguments2.PushElement(pShape);
             Arguments2.PushBoolean((pShape->GetDimension() == pEntity->GetDimension()));
-            pEntity->CallEvent("onClientElementColShapeLeave", Arguments2, true);
+            pEntity->CallEvent(BuiltInEvents::onClientElementColShapeLeave, Arguments2, true);
 
             pShape->CallLeaveCallback(*pEntity);
         }

Client/mods/deathmatch/logic/CClientEntity.cpp

@@ -9,6 +9,7 @@
  *****************************************************************************/
 
 #include "StdInc.h"
+#include <event/EventDispatcher.h>
 
 using std::list;
 
@@ -41,7 +42,6 @@ CClientEntity::CClientEntity(ElementID ID) : ClassInit(this)
     CElementIDs::SetElement(ID, this);
 
     m_pCustomData = new CCustomData;
-    m_pEventManager = new CMapEventManager;
 
     m_pAttachedToEntity = NULL;
 
@@ -101,12 +101,6 @@ CClientEntity::~CClientEntity()
 
     RemoveAllCollisions();
 
-    if (m_pEventManager)
-    {
-        delete m_pEventManager;
-        m_pEventManager = NULL;
-    }
-
     if (m_pElementGroup)
     {
         m_pElementGroup->Remove(this);
@@ -484,7 +478,7 @@ void CClientEntity::SetCustomData(const char* szName, const CLuaArgument& Variab
     Arguments.PushString(szName);
     Arguments.PushArgument(oldVariable);
     Arguments.PushArgument(Variable);
-    CallEvent("onClientElementDataChange", Arguments, true);
+    CallEvent(BuiltInEvents::onClientElementDataChange, Arguments, true);
 }
 
 void CClientEntity::DeleteCustomData(const char* szName)
@@ -504,7 +498,7 @@ void CClientEntity::DeleteCustomData(const char* szName)
         Arguments.PushString(szName);
         Arguments.PushArgument(oldVariable);
         Arguments.PushArgument(CLuaArgument());            // Use nil as the new value to indicate the data has been removed
-        CallEvent("onClientElementDataChange", Arguments, true);
+        CallEvent(BuiltInEvents::onClientElementDataChange, Arguments, true);
     }
 }
 
@@ -604,7 +598,7 @@ void CClientEntity::SetDimension(unsigned short usDimension)
     CLuaArguments Arguments;
     Arguments.PushNumber(usOldDimension);
     Arguments.PushNumber(usDimension);
-    CallEvent("onClientElementDimensionChange", Arguments, true);
+    CallEvent(BuiltInEvents::onClientElementDimensionChange, Arguments, true);
 }
 
 bool CClientEntity::IsOutOfBounds()
@@ -724,104 +718,15 @@ void CClientEntity::SetAttachedOffsets(CVector& vecPosition, CVector& vecRotatio
     m_vecAttachedRotation = vecRotation;
 }
 
-bool CClientEntity::AddEvent(CLuaMain* pLuaMain, const char* szName, const CLuaFunctionRef& iLuaFunction, bool bPropagated, EEventPriorityType eventPriority,
-                             float fPriorityMod)
-{
-    return m_pEventManager->Add(pLuaMain, szName, iLuaFunction, bPropagated, eventPriority, fPriorityMod);
-}
-
-bool CClientEntity::CallEvent(const char* szName, const CLuaArguments& Arguments, bool bCallOnChildren)
-{
-    if (!g_pClientGame->GetDebugHookManager()->OnPreEvent(szName, Arguments, this, NULL))
-        return false;
-
-    TIMEUS startTime = GetTimeUs();
-
-    CEvents* pEvents = g_pClientGame->GetEvents();
-
-    // Make sure our event-manager knows we're about to call an event
-    pEvents->PreEventPulse();
-
-    // Call the event on our parents/us first
-    CallParentEvent(szName, Arguments, this);
-
-    if (bCallOnChildren)
-    {
-        // Call it on all our children
-        CallEventNoParent(szName, Arguments, this);
-    }
-
-    // Tell the event manager that we're done calling the event
-    pEvents->PostEventPulse();
-
-    if (IS_TIMING_CHECKPOINTS())
-    {
-        TIMEUS deltaTimeUs = GetTimeUs() - startTime;
-        if (deltaTimeUs > 10000)
-            TIMING_DETAIL(SString("Event: %s [%d ms]", szName, deltaTimeUs / 1000));
-    }
-
-    g_pClientGame->GetDebugHookManager()->OnPostEvent(szName, Arguments, this, NULL);
-
-    // Return whether it got cancelled or not
-    return (!pEvents->WasEventCancelled());
-}
-
-void CClientEntity::CallEventNoParent(const char* szName, const CLuaArguments& Arguments, CClientEntity* pSource)
-{
-    // Call it on us if this isn't the same class it was raised on
-    // TODO not sure why the null check is necessary (eAi)
-    if (pSource != this && m_pEventManager != NULL && m_pEventManager->HasEvents())
-    {
-        m_pEventManager->Call(szName, Arguments, pSource, this);
-    }
-
-    // Call it on all our children
-    if (!m_Children.empty())
-    {
-        CElementListSnapshot* pList = GetChildrenListSnapshot();
-        pList->AddRef();            // Keep list alive during use
-        for (CElementListSnapshot::const_iterator iter = pList->begin(); iter != pList->end(); iter++)
-        {
-            CClientEntity* pEntity = *iter;
-            if (!pEntity->IsBeingDeleted())
-            {
-                if (!pEntity->m_pEventManager || pEntity->m_pEventManager->HasEvents() || !pEntity->m_Children.empty())
-                {
-                    pEntity->CallEventNoParent(szName, Arguments, pSource);
-                    if (m_bBeingDeleted)
-                        break;
-                }
-            }
-        }
-        pList->Release();
-    }
-}
-
-void CClientEntity::CallParentEvent(const char* szName, const CLuaArguments& Arguments, CClientEntity* pSource)
-{
-    // Call the event on us
-    if (m_pEventManager && m_pEventManager->HasEvents())
-    {
-        m_pEventManager->Call(szName, Arguments, pSource, this);
-    }
-
-    // Call parent's handler
-    if (m_pParent)
-    {
-        m_pParent->CallParentEvent(szName, Arguments, pSource);
-    }
-}
-
-bool CClientEntity::DeleteEvent(CLuaMain* pLuaMain, const char* szName, const CLuaFunctionRef& iLuaFunction)
+bool CClientEntity::CallEvent(const Event& event, const CLuaArguments& Arguments, bool bCallOnChildren)
 {
-    return m_pEventManager->Delete(pLuaMain, szName, iLuaFunction);
+    return s_EventDispatcher.Call(event, Arguments, bCallOnChildren, this);
 }
 
 void CClientEntity::DeleteEvents(CLuaMain* pLuaMain, bool bRecursive)
 {
     // Delete it from our events
-    m_pEventManager->Delete(pLuaMain);
+    GetEventHandlerCallDispatcher().Remove(pLuaMain);
 
     // Delete it from all our children's events
     if (bRecursive)
@@ -836,7 +741,7 @@ void CClientEntity::DeleteEvents(CLuaMain* pLuaMain, bool bRecursive)
 
 void CClientEntity::DeleteAllEvents()
 {
-    m_pEventManager->DeleteAll();
+    GetEventHandlerCallDispatcher().Clear();
 }
 
 void CClientEntity::CleanUpForVM(CLuaMain* pLuaMain, bool bRecursive)
@@ -1310,7 +1215,7 @@ void CClientEntity::SetInterior(unsigned char ucInterior)
     CLuaArguments Arguments;
     Arguments.PushNumber(ucOldInterior);
     Arguments.PushNumber(ucInterior);
-    CallEvent("onClientElementInteriorChange", Arguments, true);
+    CallEvent(BuiltInEvents::onClientElementInteriorChange, Arguments, true);
 }
 
 bool CClientEntity::IsOnScreen()

Client/mods/deathmatch/logic/CClientEntity.h

@@ -16,6 +16,7 @@ class CClientEntity;
 #include "CClientCommon.h"
 #include <core/CClientEntityBase.h>
 #include "logic/CClientEntityRefManager.h"
+#include <event/EventHandlerCallDispatcher.h>
 class CLuaFunctionRef;
 
 // Used to check fast version of getElementsByType
@@ -87,7 +88,6 @@ class CElementGroup;
 class CLuaArgument;
 class CLuaArguments;
 class CLuaMain;
-class CMapEventManager;
 typedef CFastList<CClientEntity*> CChildListType;
 
 // List of elements which is auto deleted when the last user calls Release()
@@ -242,12 +242,7 @@ class CClientEntity : public CClientEntityBase
     virtual bool   IsAttachToable();
     virtual void   DoAttaching();
 
-    bool AddEvent(CLuaMain* pLuaMain, const char* szName, const CLuaFunctionRef& iLuaFunction, bool bPropagated, EEventPriorityType eventPriority,
-                  float fPriorityMod);
-    bool CallEvent(const char* szName, const CLuaArguments& Arguments, bool bCallOnChildren);
-    void CallEventNoParent(const char* szName, const CLuaArguments& Arguments, CClientEntity* pSource);
-    void CallParentEvent(const char* szName, const CLuaArguments& Arguments, CClientEntity* pSource);
-    bool DeleteEvent(CLuaMain* pLuaMain, const char* szName, const CLuaFunctionRef& iLuaFunction);
+    bool CallEvent(const Event& event, const CLuaArguments& Arguments, bool bCallOnChildren = true);
     void DeleteEvents(CLuaMain* pLuaMain, bool bRecursive);
     void DeleteAllEvents();
 
@@ -281,8 +276,6 @@ class CClientEntity : public CClientEntityBase
 
     static unsigned int GetTypeID(const char* szTypeName);
 
-    CMapEventManager* GetEventManager() { return m_pEventManager; };
-
     void DeleteClientChildren();
 
     // Returns true if this class is inherited by CClientStreamElement
@@ -327,6 +320,57 @@ class CClientEntity : public CClientEntityBase
     bool CanBeDestroyedByScript() { return m_canBeDestroyedByScript; }
     void SetCanBeDestroyedByScript(bool canBeDestroyedByScript) { m_canBeDestroyedByScript = canBeDestroyedByScript; }
 
+    EventHandlerCallDispatcher& GetEventHandlerCallDispatcher() { return m_eventHandlerCallDispatcher; }
+
+    // Iter a snapshot list of our children
+    // The snapshot list is inmutable, thus even if it gets modified by
+    // scripts it wont crash.
+    // If the provided `Fn` function returns bool `false`
+    // the given child and its sub-tree will be skipped
+    // 
+    // TODO: This snapshot list stuff seems absolute bs
+    // Its inconsistent compared to IterAncestors
+    // since that function iterates the `live` version
+    // while this one a `snapshot`
+    // eg.: Parent gets changed in the middle of iteration:
+    // it will still iterate the old children, as the snapshot wont be updated
+    template<typename Fn>
+    void IterChildren(const Fn& fn)
+    {
+        auto childrenSnapshot = GetChildrenListSnapshot();
+        childrenSnapshot->AddRef();
+        for (auto* child : *childrenSnapshot)
+        {
+            if (child->IsBeingDeleted())
+                continue;
+            if (IsBeingDeleted())
+                break;
+            // Check if the function returns a bool
+            if constexpr (std::is_same_v<bool, std::invoke_result_t<Fn, decltype(child)>>)
+            {
+                if (!fn(child))
+                    continue; // Skip child and it's sub-tree
+            }
+            else
+                fn(child);
+            child->IterChildren(fn); // Recurse into child
+        }
+        childrenSnapshot->Release();
+    }
+
+    template<typename Fn>
+    void IterAncestors(const Fn& fn)
+    {
+        for (CClientEntity* it = m_pParent; it; it = it->m_pParent)
+            fn(it);
+    }
+
+    template<typename Fn>
+    void IterAncestorsThenChildren(const Fn& fn)
+    {
+        IterAncestors(fn);
+        IterChildren(fn);
+    }
 protected:
     CClientManager*       m_pManager;
     CClientEntity*        m_pParent;
@@ -336,6 +380,8 @@ class CClientEntity : public CClientEntityBase
 
     CCustomData* m_pCustomData;
 
+    EventHandlerCallDispatcher m_eventHandlerCallDispatcher;
+
     ElementID m_ID;
     CVector   m_vecRelativePosition;
 
@@ -360,7 +406,6 @@ class CClientEntity : public CClientEntityBase
 
     bool                              m_bBeingDeleted;
     bool                              m_bSystemEntity;
-    CMapEventManager*                 m_pEventManager;
     CModelInfo*                       m_pModelInfo;
     CFastList<class CClientColShape*> m_Collisions;
     CElementGroup*                    m_pElementGroup;

Client/mods/deathmatch/logic/CClientExplosionManager.cpp

@@ -94,7 +94,7 @@ bool CClientExplosionManager::Hook_ExplosionCreation(CEntity* pGameExplodingEnti
         Arguments.PushNumber(vecPosition.fY);
         Arguments.PushNumber(vecPosition.fZ);
         Arguments.PushNumber(explosionWeaponType);
-        const bool bAllowExplosion = pResponsible->CallEvent("onClientExplosion", Arguments, true);
+        const bool bAllowExplosion = pResponsible->CallEvent(BuiltInEvents::onClientExplosion, Arguments, true);
         return bAllowExplosion;
     }