mirror/OpenMW
1
0
Fork 0
mirror of https://gitlab.com/OpenMW/openmw.git synced 2025-01-29 18:32:36 +00:00
Code Issues Projects Releases Wiki Activity

Merge branch 'were_engineers_not_salt_miners' into 'master'

Browse Source 
FEAT: Lua Engine Handler for MWScript `startscript` functionality

See merge request OpenMW/openmw!4178
This commit is contained in:
psi29a 2024-06-24 07:09:24 +00:00
commit 456ac2a85b
13 changed files with 123 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -246,6 +246,7 @@
Feature #7964: Add Lua read access to MW Dialogue records
Feature #7971: Make save's Time Played value display hours instead of days
Feature #7985: Support dark mode on Windows
Feature #8028: Lua Engine Handler for MWScript `startscript` functionality.
Task #5896: Do not use deprecated MyGUI properties
Task #6085: Replace boost::filesystem with std::filesystem
Task #6149: Dehardcode Lua API_REVISION

3
apps/openmw/mwbase/luamanager.hpp
View File

@ -150,6 +150,9 @@ namespace MWBase
= 0;
virtual std::string formatResourceUsageStats() const = 0;
virtual void globalMWScriptCalled(const ESM::RefId& scriptName, const MWWorld::Ptr& target, const bool started)
= 0;
};
}

8
apps/openmw/mwlua/engineevents.cpp
View File

@ -113,6 +113,14 @@ namespace MWLua
scripts->onSkillLevelUp(event.mSkill, event.mSource);
}
void operator()(const OnGlobalScriptRequested& event) const
{
sol::optional<GObject> target;
if (event.mTarget.isSet())
target = GObject(event.mTarget);
mGlobalScripts.onGlobalScriptRequested(MWScriptRef{ event.mScript, {} }, event.mStarted, target);
}
private:
MWWorld::Ptr getPtr(ESM::RefNum id) const
{

8
apps/openmw/mwlua/engineevents.hpp
View File

@ -70,8 +70,14 @@ namespace MWLua
std::string mSkill;
std::string mSource;
};
struct OnGlobalScriptRequested
{
ESM::RefId mScript;
ESM::RefNum mTarget;
bool mStarted;
};
using Event = std::variant<OnActive, OnInactive, OnConsume, OnActivate, OnUseItem, OnNewExterior, OnTeleported,
OnAnimationTextKey, OnSkillUse, OnSkillLevelUp>;
OnAnimationTextKey, OnSkillUse, OnSkillLevelUp, OnGlobalScriptRequested>;
void clear() { mQueue.clear(); }
void addToQueue(Event e) { mQueue.push_back(std::move(e)); }

7
apps/openmw/mwlua/globalscripts.hpp
View File

@ -4,6 +4,7 @@
#include <components/lua/luastate.hpp>
#include <components/lua/scriptscontainer.hpp>
#include "mwscriptref.hpp"
#include "object.hpp"
namespace MWLua
@ -24,6 +25,7 @@ namespace MWLua
&mOnActivateHandlers,
&mOnUseItemHandlers,
&mOnNewExteriorHandlers,
&mOnGlobalScriptRequestedHandlers,
});
}
@ -41,6 +43,10 @@ namespace MWLua
callEngineHandlers(mOnUseItemHandlers, obj, actor, force);
}
void onNewExterior(const GCell& cell) { callEngineHandlers(mOnNewExteriorHandlers, cell); }
void onGlobalScriptRequested(const MWScriptRef& scriptRef, const bool started, sol::optional<GObject> target)
{
callEngineHandlers(mOnGlobalScriptRequestedHandlers, scriptRef, started, target);
}
private:
EngineHandlerList mObjectActiveHandlers{ "onObjectActive" };
@ -51,6 +57,7 @@ namespace MWLua
EngineHandlerList mOnActivateHandlers{ "onActivate" };
EngineHandlerList mOnUseItemHandlers{ "_onUseItem" };
EngineHandlerList mOnNewExteriorHandlers{ "onNewExterior" };
EngineHandlerList mOnGlobalScriptRequestedHandlers{ "onGlobalScriptRequested" };
};
}

11
apps/openmw/mwlua/luamanagerimp.cpp
View File

@ -1,5 +1,8 @@
#include "luamanagerimp.hpp"
#include <apps/openmw/mwlua/mwscriptref.hpp>
#include <apps/openmw/mwlua/object.hpp>
#include <components/misc/strings/lower.hpp>
#include <filesystem>
#include <MyGUI_InputManager.h>
@ -601,6 +604,14 @@ namespace MWLua
mGlobalScriptsStarted = true;
}
void LuaManager::globalMWScriptCalled(const ESM::RefId& scriptName, const MWWorld::Ptr& target, const bool started)
{
ESM::RefNum targetId;
if (!target.isEmpty())
targetId = getId(target);
mEngineEvents.addToQueue(EngineEvents::OnGlobalScriptRequested{ scriptName, targetId, started });
}
void LuaManager::saveLocalScripts(const MWWorld::Ptr& ptr, ESM::LuaScripts& data)
{
if (ptr.getRefData().getLuaScripts())

3
apps/openmw/mwlua/luamanagerimp.hpp
View File

@ -156,6 +156,9 @@ namespace MWLua
void reportStats(unsigned int frameNumber, osg::Stats& stats) const;
std::string formatResourceUsageStats() const override;
void globalMWScriptCalled(
const ESM::RefId& scriptName, const MWWorld::Ptr& target, const bool started) override;
LuaUtil::InputAction::Registry& inputActions() { return mInputActions; }
LuaUtil::InputTrigger::Registry& inputTriggers() { return mInputTriggers; }

52
apps/openmw/mwlua/mwscriptbindings.cpp
View File

@ -4,64 +4,14 @@
#include <components/lua/util.hpp>
#include <components/misc/strings/lower.hpp>
#include "../mwbase/environment.hpp"
#include "../mwbase/scriptmanager.hpp"
#include "../mwbase/world.hpp"
#include "../mwscript/globalscripts.hpp"
#include "../mwworld/esmstore.hpp"
#include "../mwworld/worldimp.hpp"
#include "mwscriptref.hpp"
#include "object.hpp"
#include <stdexcept>
namespace MWLua
{
struct MWScriptRef
{
ESM::RefId mId;
sol::optional<GObject> mObj;
MWScript::Locals& getLocals()
{
if (mObj)
return mObj->ptr().getRefData().getLocals();
else
return MWBase::Environment::get().getScriptManager()->getGlobalScripts().getLocals(mId);
}
bool isRunning() const
{
if (mObj.has_value()) // local script
{
MWWorld::LocalScripts& localScripts = MWBase::Environment::get().getWorld()->getLocalScripts();
return localScripts.isRunning(mId, mObj->ptr());
}
return MWBase::Environment::get().getScriptManager()->getGlobalScripts().isRunning(mId);
}
};
struct MWScriptVariables
{
MWScriptRef mRef;
};
}
namespace sol
{
template <>
struct is_automagical<MWLua::MWScriptRef> : std::false_type
{
};
template <>
struct is_automagical<MWLua::MWScriptVariables> : std::false_type
{
};
template <>
struct is_automagical<ESM::Global> : std::false_type
{
};
}
namespace MWLua
{

62
apps/openmw/mwlua/mwscriptref.hpp Normal file
View File

@ -0,0 +1,62 @@
#ifndef MWSCRIPTREF_H_
#define MWSCRIPTREF_H_
#include <sol/sol.hpp>
#include "../mwbase/environment.hpp"
#include "../mwbase/scriptmanager.hpp"
#include "../mwbase/world.hpp"
#include "../mwscript/globalscripts.hpp"
#include "../mwworld/localscripts.hpp"
#include "object.hpp"
namespace MWLua
{
struct MWScriptRef
{
ESM::RefId mId;
sol::optional<GObject> mObj;
MWScript::Locals& getLocals()
{
if (mObj)
return mObj->ptr().getRefData().getLocals();
else
return MWBase::Environment::get().getScriptManager()->getGlobalScripts().getLocals(mId);
}
bool isRunning() const
{
if (mObj.has_value()) // local script
{
MWWorld::LocalScripts& localScripts = MWBase::Environment::get().getWorld()->getLocalScripts();
return localScripts.isRunning(mId, mObj->ptr());
}
return MWBase::Environment::get().getScriptManager()->getGlobalScripts().isRunning(mId);
}
};
struct MWScriptVariables
{
MWScriptRef mRef;
};
}
namespace sol
{
template <>
struct is_automagical<MWLua::MWScriptRef> : std::false_type
{
};
template <>
struct is_automagical<MWLua::MWScriptVariables> : std::false_type
{
};
template <>
struct is_automagical<ESM::Global> : std::false_type
{
};
}
#endif // MWSCRIPTREF_H_

1
apps/openmw/mwlua/object.hpp
View File

@ -8,6 +8,7 @@
#include <sol/sol.hpp>
#include <components/esm3/cellref.hpp>
#include <components/esm3/loadglob.hpp>
#include "../mwworld/ptr.hpp"

10
apps/openmw/mwscript/globalscripts.cpp
View File

@ -14,6 +14,8 @@
#include "../mwbase/world.hpp"
#include "../mwworld/worldmodel.hpp"
#include "../mwbase/luamanager.hpp"
#include "interpretercontext.hpp"
namespace
@ -128,6 +130,7 @@ namespace MWScript
void GlobalScripts::addScript(const ESM::RefId& name, const MWWorld::Ptr& target)
{
const auto iter = mScripts.find(name);
bool started = false;
if (iter == mScripts.end())
{
@ -136,21 +139,24 @@ namespace MWScript
auto desc = std::make_shared<GlobalScriptDesc>();
MWWorld::Ptr ptr = target;
desc->mTarget = ptr;
desc->mRunning = true;
started = desc->mRunning = true;
desc->mLocals.configure(*script);
mScripts.insert(std::make_pair(name, desc));
}
else
{
Log(Debug::Error) << "Failed to add global script " << name << ": script record not found";
return;
}
}
else if (!iter->second->mRunning)
{
iter->second->mRunning = true;
started = iter->second->mRunning = true;
MWWorld::Ptr ptr = target;
iter->second->mTarget = ptr;
}
MWBase::Environment::get().getLuaManager()->globalMWScriptCalled(name, target, started);
}
void GlobalScripts::removeScript(const ESM::RefId& name)

2
components/lua/scriptscontainer.hpp
View File

@ -178,7 +178,7 @@ namespace LuaUtil
// Calls given handlers in direct order.
template <typename... Args>
void callEngineHandlers(EngineHandlerList& handlers, const Args&... args)
void callEngineHandlers(EngineHandlerList& handlers, Args&&... args)
{
for (Handler& handler : handlers.mList)
{

10
docs/source/reference/lua-scripting/engine_handlers.rst
View File

@ -58,6 +58,16 @@ Engine handler is a function defined by a script, that can be called by the engi
- Object is activated by an actor.
* - onNewExterior(cell)
- A new exterior cell not defined by a content file has been generated.
* - onGlobalScriptRequested(script, started, target)
- | A `StartScript` was called.
| Note that this affects `Start Scripts` defined by content files, as well as calls to the MWScript function `StartScript`.
| This does not necessarily indicate the script in question is actually being started, as there may (presently)
| only be a single instance of a global script at a time.
| This can potentially be used to override vanilla functionality, such as:
| ``if script.recordId == 'dbattackscript' then script.variables.sleeponce = 1 end``
| The `target` and `script.object` fields may be different.
| If `started` is true then refer to `script.object`, otherwise the `target`, if present, represents what the `startscript` call is actually targeted at. For example:
| ``if started and script.object then print(script.object.recordId) elseif target then print(target.recordId) end``
**Only for local scripts**