summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/luascript
diff options
context:
space:
mode:
author Vas Crabb <vas@vastheman.com>2023-11-17 02:18:28 +1100
committer Vas Crabb <vas@vastheman.com>2023-11-17 02:18:28 +1100
commita10193900907966e44ce92e64361ce926d1b923b (patch)
tree3fed38a4a16ef5ba77d91cc63398ce7ed91e9f5d /docs/source/luascript
parent689e75b439e857cb62e60016350e6e21650097ad (diff)
-luaengine.cpp: Fixed jobs waiting for frame updates sleeping forever.
-sega_beena.cpp: Removed requires external artwork flag - the internal artwork is adequate.
Diffstat (limited to 'docs/source/luascript')
-rw-r--r--docs/source/luascript/ref-common.rst20
1 files changed, 9 insertions, 11 deletions
diff --git a/docs/source/luascript/ref-common.rst b/docs/source/luascript/ref-common.rst
index a68a832b88f..85bd580a144 100644
--- a/docs/source/luascript/ref-common.rst
+++ b/docs/source/luascript/ref-common.rst
@@ -58,23 +58,21 @@ classes are also available as properties of the emulator interface.
Methods
~~~~~~~
-emu.wait(duration, …)
+emu.wait(duration)
Yields for the specified duration in terms of emulated time. The duration
may be specified as an :ref:`attotime <luascript-ref-attotime>` or a number
- in seconds. Any additional arguments are returned to the caller. Returns a
- Boolean indicating whether the duration expired normally.
+ in seconds. Returns a Boolean indicating whether the duration expired
+ normally.
All outstanding calls to ``emu.wait`` will return ``false`` immediately if a
saved state is loaded or the emulation session ends. Calling this function
from callbacks that are not run as coroutines will raise an error.
-emu.wait_next_update(…)
- Yields until the next video/UI update. Any arguments are returned to the
- caller. Calling this function from callbacks that are not run as coroutines
- will raise an error.
-emu.wait_next_frame(…)
- Yields until the next emulated frame completes. Any arguments are returned
- to the caller. Calling this function from callbacks that are not run as
- coroutines will raise an error.
+emu.wait_next_update()
+ Yields until the next video/UI update. Calling this function from callbacks
+ that are not run as coroutines will raise an error.
+emu.wait_next_frame()
+ Yields until the next emulated frame completes. Calling this function from
+ callbacks that are not run as coroutines will raise an error.
emu.add_machine_reset_notifier(callback)
Add a callback to receive notifications when the emulated system is reset.
Returns a :ref:`notifier subscription <luascript-ref-notifiersub>`.