mirror of
https://github.com/OpenMW/openmw.git
synced 2025-10-31 09:56:38 +00:00
81 lines
2.2 KiB
ReStructuredText
81 lines
2.2 KiB
ReStructuredText
Built-in events
|
|
===============
|
|
|
|
.. include:: version.rst
|
|
|
|
Actor events
|
|
------------
|
|
|
|
**StartAIPackage, RemoveAIPackages**
|
|
|
|
Any script can send to any actor (except player, for player will be ignored) events ``StartAIPackage`` and ``RemoveAIPackages``.
|
|
The effect is equivalent to calling ``interfaces.AI.startPackage`` or ``interfaces.AI.removePackages`` in a local script on this actor.
|
|
|
|
Examples:
|
|
|
|
.. code-block:: Lua
|
|
|
|
actor:sendEvent('StartAIPackage', {type='Combat', target=self.object})
|
|
actor:sendEvent('RemoveAIPackages', 'Pursue')
|
|
|
|
**UseItem**
|
|
|
|
Any script can send global event ``UseItem`` with arguments ``object``, ``actor``, and optional boolean ``force``.
|
|
The actor will use (e.g. equip or consume) the object. The object should be in the actor's inventory.
|
|
|
|
Example:
|
|
|
|
.. code-block:: Lua
|
|
|
|
core.sendGlobalEvent('UseItem', {object = potion, actor = player, force = true})
|
|
|
|
UI events
|
|
---------
|
|
|
|
**UiModeChanged**
|
|
|
|
Every time UI mode is changed built-in scripts send to player the event ``UiModeChanged`` with arguments ``oldMode, ``newMode`` (same as ``I.UI.getMode()``)
|
|
and ``arg`` (for example in the mode ``Book`` the argument is the book the player is reading).
|
|
|
|
.. code-block:: Lua
|
|
|
|
eventHandlers = {
|
|
UiModeChanged = function(data)
|
|
print('UiModeChanged from', data.oldMode , 'to', data.newMode, '('..tostring(data.arg)..')')
|
|
end
|
|
}
|
|
|
|
**AddUiMode**
|
|
|
|
Equivalent to ``I.UI.addMode``, but can be sent from another object or global script.
|
|
|
|
.. code-block:: Lua
|
|
|
|
player:sendEvent('AddUiMode', {mode = 'Book', target = book})
|
|
|
|
**SetUiMode**
|
|
|
|
Equivalent to ``I.UI.setMode``, but can be sent from another object or global script.
|
|
|
|
.. code-block:: Lua
|
|
|
|
player:sendEvent('SetUiMode', {mode = 'Book', target = book})
|
|
|
|
World events
|
|
------------
|
|
|
|
Global events that just call the corresponding function in `openmw.world`.
|
|
|
|
.. code-block:: Lua
|
|
|
|
-- world.pause(tag)
|
|
core.sendGlobalEvent('Pause', tag)
|
|
|
|
-- world.unpause(tag)
|
|
core.sendGlobalEvent('Unpause', tag)
|
|
|
|
-- world.setGameTimeScale(scale)
|
|
core.sendGlobalEvent('SetGameTimeScale', scale)
|
|
|
|
-- world.setSimulationTimeScale(scale)
|
|
core.sendGlobalEvent('SetSimulationTimeScale', scale)
|