Add a death event to the Lua API

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

apps/openmw/mwlua/engineevents.cpp

@@ -86,6 +86,16 @@ namespace MWLua
 
         void operator()(const OnNewExterior& event) const { mGlobalScripts.onNewExterior(GCell{ &event.mCell }); }
 
+        void operator()(const OnDeath& event) const
+        {
+            MWWorld::Ptr actor = getPtr(event.mActor);
+            if (!actor.isEmpty())
+            {
+                if (auto* scripts = getLocalScripts(actor))
+                    scripts->onDeath();
+            }
+        }
+
     private:
         MWWorld::Ptr getPtr(ESM::RefNum id) const
         {

apps/openmw/mwlua/engineevents.hpp

@@ -51,7 +51,12 @@ namespace MWLua
         {
             MWWorld::CellStore& mCell;
         };
-        using Event = std::variant<OnActive, OnInactive, OnConsume, OnActivate, OnUseItem, OnNewExterior, OnTeleported>;
+        struct OnDeath
+        {
+            ESM::RefNum mActor;
+        };
+        using Event = std::variant<OnActive, OnInactive, OnConsume, OnActivate, OnUseItem, OnNewExterior, OnTeleported,
+            OnDeath>;
 
         void clear() { mQueue.clear(); }
         void addToQueue(Event e) { mQueue.push_back(std::move(e)); }

apps/openmw/mwlua/localscripts.cpp

@@ -170,7 +170,7 @@ namespace MWLua
     {
         this->addPackage("openmw.self", sol::make_object(lua->sol(), &mData));
         registerEngineHandlers({ &mOnActiveHandlers, &mOnInactiveHandlers, &mOnConsumeHandlers, &mOnActivatedHandlers,
-            &mOnTeleportedHandlers });
+            &mOnTeleportedHandlers, &mOnDeathHandlers });
     }
 
     void LocalScripts::setActive(bool active)

apps/openmw/mwlua/localscripts.hpp

@@ -71,6 +71,7 @@ namespace MWLua
         void onConsume(const LObject& consumable) { callEngineHandlers(mOnConsumeHandlers, consumable); }
         void onActivated(const LObject& actor) { callEngineHandlers(mOnActivatedHandlers, actor); }
         void onTeleported() { callEngineHandlers(mOnTeleportedHandlers); }
+        void onDeath() { callEngineHandlers(mOnDeathHandlers); }
 
         void applyStatsCache();
 
@@ -83,6 +84,7 @@ namespace MWLua
         EngineHandlerList mOnConsumeHandlers{ "onConsume" };
         EngineHandlerList mOnActivatedHandlers{ "onActivated" };
         EngineHandlerList mOnTeleportedHandlers{ "onTeleported" };
+        EngineHandlerList mOnDeathHandlers{ "onDeath" };
     };
 
 }

apps/openmw/mwlua/luamanagerimp.hpp

@@ -82,6 +82,10 @@ namespace MWLua
         {
             mEngineEvents.addToQueue(EngineEvents::OnNewExterior{ cell });
         }
+        void actorDied(const MWWorld::Ptr& actor) override
+        {
+            mEngineEvents.addToQueue(EngineEvents::OnDeath{ getId(actor) });
+        }
         void objectTeleported(const MWWorld::Ptr& ptr) override;
         void questUpdated(const ESM::RefId& questId, int stage) override;
         void uiModeChanged(const MWWorld::Ptr& arg) override;

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

docs/source/reference/lua-scripting/engine_handlers.rst

@@ -79,6 +79,8 @@ Engine handler is a function defined by a script, that can be called by the engi
     - | Called on an actor when they consume an item (e.g. a potion).
       | Similarly to onActivated, the item has already been removed
       | from the actor's inventory, and the count was set to zero.
+  * - onDeath()
+    - Called when the actor dies. Note that actors that start out dead are ignored.
 
 **Only for local scripts attached to a player**