Turn onDeath the engine handler into OnDeath the regular event

apps/openmw/mwlua/engineevents.cpp

@@ -86,16 +86,6 @@ 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,12 +51,7 @@ namespace MWLua
         {
             MWWorld::CellStore& mCell;
         };
-        struct OnDeath
+        using Event = std::variant<OnActive, OnInactive, OnConsume, OnActivate, OnUseItem, OnNewExterior, OnTeleported>;
-        {
-            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, &mOnDeathHandlers });
+            &mOnTeleportedHandlers });
     }
 
     void LocalScripts::setActive(bool active)

apps/openmw/mwlua/localscripts.hpp

@@ -71,7 +71,6 @@ 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();
 
@@ -84,7 +83,6 @@ namespace MWLua
         EngineHandlerList mOnConsumeHandlers{ "onConsume" };
         EngineHandlerList mOnActivatedHandlers{ "onActivated" };
         EngineHandlerList mOnTeleportedHandlers{ "onTeleported" };
-        EngineHandlerList mOnDeathHandlers{ "onDeath" };
     };
 
 }

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), "OnDeath", {} });
+    }
+
     void LuaManager::useItem(const MWWorld::Ptr& object, const MWWorld::Ptr& actor, bool force)
     {
         MWBase::Environment::get().getWorldModel()->registerPtr(object);

apps/openmw/mwlua/luamanagerimp.hpp

@@ -82,13 +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;
+        void actorDied(const MWWorld::Ptr& actor) override;
 
         MWBase::LuaManager::ActorControls* getActorControls(const MWWorld::Ptr&) const override;
 

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

@@ -79,8 +79,6 @@ 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**
 

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

@@ -6,6 +6,18 @@ Built-in events
 Actor events
 ------------
 
+**OnDeath**
+
+This event is sent to an actor's local script when that actor dies.
+
+.. code-block:: Lua
+
+    eventHandlers = {
+        OnDeath = 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``.