Remove compatibility mode & Custom methods redesign (#510)

* Remove compatibility mode

* Change to custom method implementation

If you already use the custom methods feature, copy your CustomMethods header file to methods/Custom, re-run cmake and recompile. It should then work like before.

The Custom directory will never be changed and should not cause any future merge conflicts

Author: Foereaper

CMakeLists.txt

@@ -1,3 +1,8 @@
+set(CUSTOM_METHODS_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/methods/Custom/CustomMethods.h")
+if(EXISTS "${CUSTOM_METHODS_HEADER}")
+    target_compile_definitions(lualib PUBLIC ELUNA_USE_CUSTOM_METHODS)
+endif()
+
 # Define variables for paths
 set(MODULES_DIR "${CMAKE_CURRENT_SOURCE_DIR}/modules")
 if(UNIX)

ElunaConfig.cpp

@@ -29,7 +29,6 @@ void ElunaConfig::Initialize()
 {
     // Load bools
     SetConfig(CONFIG_ELUNA_ENABLED, "Eluna.Enabled", true);
-    SetConfig(CONFIG_ELUNA_COMPATIBILITY_MODE, "Eluna.CompatibilityMode", false);
     SetConfig(CONFIG_ELUNA_TRACEBACK, "Eluna.TraceBack", false);
     SetConfig(CONFIG_ELUNA_SCRIPT_RELOADER, "Eluna.ScriptReloader", false);
 
@@ -68,11 +67,6 @@ bool ElunaConfig::IsElunaEnabled()
     return GetConfig(CONFIG_ELUNA_ENABLED);
 }
 
-bool ElunaConfig::IsElunaCompatibilityMode()
-{
-    return GetConfig(CONFIG_ELUNA_COMPATIBILITY_MODE);
-}
-
 bool ElunaConfig::ShouldMapLoadEluna(uint32 id)
 {
     // if the set is empty (all maps), return true

ElunaConfig.h

@@ -12,7 +12,6 @@
 enum ElunaConfigBoolValues
 {
     CONFIG_ELUNA_ENABLED,
-    CONFIG_ELUNA_COMPATIBILITY_MODE,
     CONFIG_ELUNA_TRACEBACK,
     CONFIG_ELUNA_SCRIPT_RELOADER,
     CONFIG_ELUNA_BOOL_COUNT
@@ -46,7 +45,6 @@ class ElunaConfig
     void SetConfig(ElunaConfigStringValues index, std::string value) { _configStringValues[index] = value; }
 
     bool IsElunaEnabled();
-    bool IsElunaCompatibilityMode();
     bool ShouldMapLoadEluna(uint32 mapId);
 
 private:

ElunaTemplate.h

@@ -325,7 +325,7 @@ class ElunaTemplate
             }
 
             // if we're in multistate mode, we need to check whether a method is flagged as a world or a map specific method
-            if (!E->GetCompatibilityMode() && method->regState != METHOD_REG_ALL)
+            if (method->regState != METHOD_REG_ALL)
             {
                 int32 mapId = E->GetBoundMapId();
 

LuaEngine.cpp

@@ -46,11 +46,10 @@ void Eluna::_ReloadEluna()
     reload = false;
 }
 
-Eluna::Eluna(Map* map, bool compatMode) :
+Eluna::Eluna(Map* map) :
 event_level(0),
 push_counter(0),
 boundMap(map),
-compatibilityMode(compatMode),
 
 L(NULL),
 eventMgr(NULL),
@@ -264,15 +263,11 @@ void Eluna::RunScripts()
 
     for (auto it = scripts.begin(); it != scripts.end(); ++it)
     {
-        // if the Eluna state is in compatibility mode, it should load all scripts, including those tagged with a specific map ID
-        if (!GetCompatibilityMode())
+        // check that the script file is either global or meant to be loaded for this map
+        if (it->mapId != -1 && it->mapId != boundMapId)
         {
-            // check that the script file is either global or meant to be loaded for this map
-            if (it->mapId != -1 && it->mapId != boundMapId)
-            {
-                ELUNA_LOG_DEBUG("[Eluna]: `%s` is tagged %i and will not load for map: %i", it->filename.c_str(), it->mapId, boundMapId);
-                continue;
-            }
+            ELUNA_LOG_DEBUG("[Eluna]: `%s` is tagged %i and will not load for map: %i", it->filename.c_str(), it->mapId, boundMapId);
+            continue;
         }
 
         // Check that no duplicate names exist

LuaEngine.h

@@ -171,9 +171,6 @@ class ELUNA_GAME_API Eluna
 
     Map* const boundMap;
 
-    // Whether or not Eluna is in compatibility mode. Used in some method wrappers.
-    bool compatibilityMode;
-
     // Map from instance ID -> Lua table ref
     std::unordered_map<uint32, int> instanceDataRefs;
     // Map from map ID -> Lua table ref
@@ -370,9 +367,7 @@ class ELUNA_GAME_API Eluna
         return 0;
     }
 
-    bool GetCompatibilityMode() const { return compatibilityMode; }
-
-    Eluna(Map * map, bool compatMode = false);
+    Eluna(Map * map);
     ~Eluna();
 
     // Prevent copy

methods/CMangos/CustomMethods.h

@@ -0,0 +1,19 @@
+/*
+* Copyright (C) 2010 - 2025 Eluna Lua Engine <https://elunaluaengine.github.io/>
+* This program is free software licensed under GPL version 3
+* Please see the included DOCS/LICENSE.md for more information
+*/
+
+#ifndef CUSTOMMETHODSINT_H
+#define CUSTOMMETHODSINT_H
+
+#ifdef ELUNA_USE_CUSTOM_METHODS
+    #include "CustomMethods.h"
+#else
+namespace LuaCustom
+{
+    inline void RegisterCustomMethods([[maybe_unused]] Eluna* E) {}
+}
+#endif
+
+#endif

methods/CustomMethodsInterface.h

@@ -31,9 +31,7 @@
 #include "CorpseMethods.h"
 #include "VehicleMethods.h"
 #include "BattleGroundMethods.h"
-
-// Custom methods
-#include "CustomMethods.h"
+#include "CustomMethodsInterface.h"
 
 void RegisterMethods(Eluna* E)
 {
@@ -115,7 +113,6 @@ void RegisterMethods(Eluna* E)
 
     ElunaTemplate<ObjectGuid>::Register(E, "ObjectGuid");
 
-    // Register custom methods
     LuaCustom::RegisterCustomMethods(E);
 
     LuaVal::Register(E->L);