Merge branch 'ondeath' into 'master'

Add a death event to the Lua API See merge request OpenMW/openmw!3555
OpenMW · Dec 6, 2023 · 0ff9831 · 0ff9831
2 parents 1073bd9 + efb819b
commit 0ff9831
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 0 deletions.
diff --git a/apps/openmw/mwbase/luamanager.hpp b/apps/openmw/mwbase/luamanager.hpp
@@ -53,6 +53,7 @@ namespace MWBase
         virtual void objectActivated(const MWWorld::Ptr& object, const MWWorld::Ptr& actor) = 0;
         virtual void useItem(const MWWorld::Ptr& object, const MWWorld::Ptr& actor, bool force) = 0;
         virtual void exteriorCreated(MWWorld::CellStore& cell) = 0;
+        virtual void actorDied(const MWWorld::Ptr& actor) = 0;
         virtual void questUpdated(const ESM::RefId& questId, int stage) = 0;
 
         // `arg` is either forwarded from MWGui::pushGuiMode or empty

diff --git a/apps/openmw/mwlua/luamanagerimp.cpp b/apps/openmw/mwlua/luamanagerimp.cpp
@@ -344,6 +344,13 @@ namespace MWLua
             playerScripts->uiModeChanged(argId, false);
     }
 
+    void LuaManager::actorDied(const MWWorld::Ptr& actor)
+    {
+        if (actor.isEmpty())
+            return;
+        mLuaEvents.addLocalEvent({ getId(actor), "Died", {} });
+    }
+
     void LuaManager::useItem(const MWWorld::Ptr& object, const MWWorld::Ptr& actor, bool force)
     {
         MWBase::Environment::get().getWorldModel()->registerPtr(object);

diff --git a/apps/openmw/mwlua/luamanagerimp.hpp b/apps/openmw/mwlua/luamanagerimp.hpp
@@ -85,6 +85,7 @@ namespace MWLua
         void objectTeleported(const MWWorld::Ptr& ptr) override;
         void questUpdated(const ESM::RefId& questId, int stage) override;
         void uiModeChanged(const MWWorld::Ptr& arg) override;
+        void actorDied(const MWWorld::Ptr& actor) override;
 
         MWBase::LuaManager::ActorControls* getActorControls(const MWWorld::Ptr&) const override;
 

diff --git a/apps/openmw/mwmechanics/actors.cpp b/apps/openmw/mwmechanics/actors.cpp
@@ -1730,6 +1730,8 @@ namespace MWMechanics
         actor.getClass().getCreatureStats(actor).notifyDied();
 
         ++mDeathCount[actor.getCellRef().getRefId()];
+
+        MWBase::Environment::get().getLuaManager()->actorDied(actor);
     }
 
     void Actors::resurrect(const MWWorld::Ptr& ptr) const

diff --git a/docs/source/reference/lua-scripting/events.rst b/docs/source/reference/lua-scripting/events.rst
@@ -6,6 +6,18 @@ Built-in events
 Actor events
 ------------
 
+**Died**
+
+This event is sent to an actor's local script when that actor dies.
+
+.. code-block:: Lua
+
+    eventHandlers = {
+        Died = function()
+            print('Alas, ye hardly knew me!')
+        end
+    }
+
 **StartAIPackage, RemoveAIPackages**
 
 Any script can send to any actor (except player, for player will be ignored) events ``StartAIPackage`` and ``RemoveAIPackages``.