Archive/openmw
0
0
Fork 0
mirror of https://gitlab.com/OpenMW/openmw.git synced 2025-04-28 12:58:00 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 20

FEAT: Lua Engine Handler for MWScript startscript functionality

Browse source
This commit is contained in:
Dave Corley 2024-06-24 07:09:23 +00:00 • committed by psi29a
parent 5cf809f39b
commit 1a79e79f57
13 changed files with 123 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

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**