Merge branch 'activeload' into 'master'

Add activators to openmw.content

See merge request OpenMW/openmw!5192

Author: Capostrophic

apps/openmw/mwlua/contentbindings.cpp

@@ -1,5 +1,6 @@
 #include "contentbindings.hpp"
 
+#include <components/esm3/loadacti.hpp>
 #include <components/esm3/loaddoor.hpp>
 #include <components/esm3/loadstat.hpp>
 #include <components/lua/util.hpp>
@@ -144,6 +145,15 @@ namespace MWLua
                 });
         }
 
+        sol::table initActivatorBindings(sol::state_view& lua, MWWorld::Store<ESM::Activator>& store)
+        {
+            addRecordStoreBindings<ESM::Activator>(lua, &MWLua::tableToActivator);
+            addMutableActivatorType(lua);
+            sol::table api(lua, sol::create);
+            api["records"] = MutableStore<ESM::Activator>{ store };
+            return LuaUtil::makeReadOnly(api);
+        }
+
         sol::table initDoorBindings(sol::state_view& lua, MWWorld::Store<ESM::Door>& store)
         {
             addRecordStoreBindings<ESM::Door>(lua, &MWLua::tableToDoor);
@@ -168,6 +178,7 @@ namespace MWLua
         auto lua = context.sol();
         sol::table api(lua, sol::create);
         MWWorld::ESMStore& esmStore = *MWBase::Environment::get().getESMStore();
+        api["activators"] = initActivatorBindings(lua, esmStore.getWritable<ESM::Activator>());
         api["doors"] = initDoorBindings(lua, esmStore.getWritable<ESM::Door>());
         api["globals"] = initGlobalVariableBindings(lua, esmStore.getWritable<ESM::Global>());
         api["statics"] = initStaticBindings(lua, esmStore.getWritable<ESM::Static>());

apps/openmw/mwlua/types/activator.cpp

@@ -1,6 +1,7 @@
 #include "types.hpp"
 
 #include "modelproperty.hpp"
+#include "usertypeutil.hpp"
 
 #include <components/esm3/loadacti.hpp>
 #include <components/lua/luastate.hpp>
@@ -15,14 +16,40 @@ namespace sol
     {
     };
 }
-namespace
+
+namespace MWLua
 {
+    namespace
+    {
+        template <class T, bool readOnly>
+        void addUserType(sol::state_view& lua, std::string_view name)
+        {
+            sol::usertype<T> record = lua.new_usertype<T>(name);
+
+            record[sol::meta_function::to_string]
+                = [](const T& rec) -> std::string { return "ESM3_Activator[" + rec.mId.toDebugString() + "]"; };
+            record["id"] = sol::readonly_property([](const T& rec) -> ESM::RefId { return rec.mId; });
+
+            Types::addProperty(record, "name", &ESM::Activator::mName);
+            if constexpr (readOnly)
+                addModelProperty(record);
+            else
+                addMutableModelProperty(record);
+            Types::addProperty(record, "mwscript", &ESM::Activator::mScript);
+        }
+    }
+
     // Populates a activator struct from a Lua table.
     ESM::Activator tableToActivator(const sol::table& rec)
     {
         ESM::Activator activator;
         if (rec["template"] != sol::nil)
-            activator = LuaUtil::cast<ESM::Activator>(rec["template"]);
+        {
+            if (rec["template"].is<MutableRecord<ESM::Activator>>())
+                activator = rec["template"].get<MutableRecord<ESM::Activator>>().find();
+            else
+                activator = LuaUtil::cast<ESM::Activator>(rec["template"]);
+        }
         else
             activator.blank();
         if (rec["name"] != sol::nil)
@@ -36,23 +63,17 @@ namespace
         }
         return activator;
     }
-}
 
-namespace MWLua
-{
+    void addMutableActivatorType(sol::state_view& lua)
+    {
+        addUserType<MutableRecord<ESM::Activator>, false>(lua, "ESM3_MutableActivator");
+    }
+
     void addActivatorBindings(sol::table activator, const Context& context)
     {
         activator["createRecordDraft"] = tableToActivator;
         addRecordFunctionBinding<ESM::Activator>(activator, context);
-
-        sol::usertype<ESM::Activator> record = context.sol().new_usertype<ESM::Activator>("ESM3_Activator");
-        record[sol::meta_function::to_string]
-            = [](const ESM::Activator& rec) { return "ESM3_Activator[" + rec.mId.toDebugString() + "]"; };
-        record["id"]
-            = sol::readonly_property([](const ESM::Activator& rec) -> std::string { return rec.mId.serializeText(); });
-        record["name"] = sol::readonly_property([](const ESM::Activator& rec) -> std::string { return rec.mName; });
-        addModelProperty(record);
-        record["mwscript"]
-            = sol::readonly_property([](const ESM::Activator& rec) -> ESM::RefId { return rec.mScript; });
+        sol::state_view lua = context.sol();
+        addUserType<ESM::Activator, true>(lua, "ESM3_Activator");
     }
 }

apps/openmw/mwlua/types/types.hpp

@@ -29,6 +29,8 @@ namespace MWLua
 
     // used in initTypesPackage
     void addActivatorBindings(sol::table activator, const Context& context);
+    ESM::Activator tableToActivator(const sol::table& rec);
+    void addMutableActivatorType(sol::state_view& lua);
     void addBookBindings(sol::table book, const Context& context);
     void addContainerBindings(sol::table container, const Context& context);
     void addDoorBindings(sol::table door, const Context& context);

files/lua_api/openmw/content.lua

@@ -6,6 +6,15 @@
 -- @usage local content = require('openmw.content')
 
 
+--- @{#ActivatorContent}: Activator manipulation.
+-- @field [parent=#content] #ActivatorContent activators
+
+---
+-- A mutable list of all @{openmw.types#ActivatorRecord}s.
+-- @field [parent=#ActivatorContent] #list<openmw.types#ActivatorRecord> records
+-- @usage
+-- content.activators.records.MyActivator = { mwscript = 'float', model = 'meshes/w/w_chitin_arrow.nif', name = 'Quest marker' }
+
 --- @{#DoorContent}: Door manipulation.
 -- @field [parent=#content] #DoorContent doors