Merge branch 'onInfoGetText' into 'master'

onDialogueResponse implementation

See merge request OpenMW/openmw!5142

Author: Daisyhasacat

apps/openmw/mwbase/luamanager.hpp

@@ -30,6 +30,8 @@ namespace ESM
     class ESMWriter;
     class RefId;
     struct LuaScripts;
+    struct DialInfo;
+    struct Dialogue;
 }
 
 namespace LuaUtil
@@ -84,6 +86,9 @@ namespace MWBase
             = 0;
         virtual void exteriorCreated(MWWorld::CellStore& cell) = 0;
         virtual void actorDied(const MWWorld::Ptr& actor) = 0;
+        virtual void onDialogueResponse(
+            const MWWorld::Ptr& actor, const ESM::DialInfo& info, const ESM::Dialogue& record)
+            = 0;
         virtual void questUpdated(const ESM::RefId& questId, int stage) = 0;
         // `arg` is either forwarded from MWGui::pushGuiMode or empty
         virtual void uiModeChanged(const MWWorld::Ptr& arg) = 0;

apps/openmw/mwdialogue/dialoguemanagerimp.cpp

@@ -30,6 +30,7 @@
 
 #include "../mwbase/environment.hpp"
 #include "../mwbase/journal.hpp"
+#include "../mwbase/luamanager.hpp"
 #include "../mwbase/mechanicsmanager.hpp"
 #include "../mwbase/scriptmanager.hpp"
 #include "../mwbase/soundmanager.hpp"
@@ -178,6 +179,7 @@ namespace MWDialogue
 
                     MWScript::InterpreterContext interpreterContext(&mActor.getRefData().getLocals(), mActor);
                     callback->addResponse({}, Interpreter::fixDefinesDialog(info->mResponse, interpreterContext));
+                    MWBase::Environment::get().getLuaManager()->onDialogueResponse(mActor, *info, dialogue);
                     executeScript(info->mResultScript, mActor);
                     mLastTopic = dialogue.mId;
 
@@ -307,6 +309,7 @@ namespace MWDialogue
 
             MWScript::InterpreterContext interpreterContext(&mActor.getRefData().getLocals(), mActor);
             callback->addResponse(title, Interpreter::fixDefinesDialog(info->mResponse, interpreterContext));
+            MWBase::Environment::get().getLuaManager()->onDialogueResponse(mActor, *info, dialogue);
 
             if (dialogue.mType == ESM::Dialogue::Topic)
             {
@@ -477,6 +480,7 @@ namespace MWDialogue
 
                     MWScript::InterpreterContext interpreterContext(&mActor.getRefData().getLocals(), mActor);
                     callback->addResponse({}, Interpreter::fixDefinesDialog(text, interpreterContext));
+                    MWBase::Environment::get().getLuaManager()->onDialogueResponse(mActor, *info, *dialogue);
 
                     if (dialogue->mType == ESM::Dialogue::Topic)
                     {
@@ -606,6 +610,7 @@ namespace MWDialogue
 
             callback->addResponse(gmsts.find("sServiceRefusal")->mValue.getString(),
                 Interpreter::fixDefinesDialog(info->mResponse, interpreterContext));
+            MWBase::Environment::get().getLuaManager()->onDialogueResponse(mActor, *info, dialogue);
 
             executeScript(info->mResultScript, mActor);
             return true;
@@ -649,6 +654,7 @@ namespace MWDialogue
                 sndMgr->say(actor, Misc::ResourceHelpers::correctSoundPath(VFS::Path::Normalized(info->mSound)));
             if (!info->mResultScript.empty())
                 executeScript(info->mResultScript, actor);
+            MWBase::Environment::get().getLuaManager()->onDialogueResponse(actor, *info, *dial);
         }
         return info != nullptr;
     }

apps/openmw/mwlua/luamanagerimp.cpp

@@ -448,6 +448,28 @@ namespace MWLua
         mLuaEvents.addLocalEvent({ getId(actor), "Died", {} });
     }
 
+    void LuaManager::onDialogueResponse(
+        const MWWorld::Ptr& actor, const ESM::DialInfo& info, const ESM::Dialogue& record)
+    {
+        mLua.protectedCall([&](LuaUtil::LuaView& view) {
+            sol::table data = view.newTable();
+            data["actor"] = LObject(actor);
+            if (record.mType == ESM::Dialogue::Type::Greeting)
+                data["type"] = "greeting";
+            else if (record.mType == ESM::Dialogue::Type::Journal)
+                data["type"] = "journal";
+            else if (record.mType == ESM::Dialogue::Type::Persuasion)
+                data["type"] = "persuasion";
+            else if (record.mType == ESM::Dialogue::Type::Topic)
+                data["type"] = "topic";
+            else if (record.mType == ESM::Dialogue::Type::Voice)
+                data["type"] = "voice";
+            data["infoId"] = info.mId.serializeText();
+            data["recordId"] = record.mId.serializeText();
+            sendLocalEvent(mPlayer, "DialogueResponse", data);
+        });
+    }
+
     void LuaManager::useItem(const MWWorld::Ptr& object, const MWWorld::Ptr& actor, bool force)
     {
         MWBase::Environment::get().getWorldModel()->registerPtr(object);

apps/openmw/mwlua/luamanagerimp.hpp

@@ -105,6 +105,8 @@ namespace MWLua
         void questUpdated(const ESM::RefId& questId, int stage) override;
         void uiModeChanged(const MWWorld::Ptr& arg) override;
         void actorDied(const MWWorld::Ptr& actor) override;
+        void onDialogueResponse(
+            const MWWorld::Ptr& actor, const ESM::DialInfo& info, const ESM::Dialogue& record) override;
 
         MWBase::LuaManager::ActorControls* getActorControls(const MWWorld::Ptr&) const override;
 

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

@@ -6,6 +6,29 @@ Events
 Actor events
 ------------
 
+**DialogueResponse**
+
+This event is sent to the player's local script when an actor triggers a greeting, topic response, service refusal, or plays a voice line.
+It returns a lua table with the following fields:
+- ``actor``: The actor that responded.
+- ``type``: The type of ``DialogueRecord`` that triggered the event, can be ``"greeting"``, ``"journal"``, ``"persuasion"``, ``"topic"``, or ``"voice"``.
+- ``recordId``: The ID of the ``DialogueRecord``.
+- ``infoId``: The ID of the ``DialogueRecordInfo`` in question.
+
+.. code-block:: Lua
+
+    eventHandlers = {
+        DialogueResponse = function(e)
+            local topic = core.dialogue[e.type].records[e.recordId];
+            for _, info in pairs(topic.infos) do
+                if info.id == e.infoId then
+                    print(e.actor, 'said', info.text)
+                    return
+                end
+            end
+        end
+    }
+
 **Died**
 
 This event is sent to an actor's local script when that actor dies.