diff options
author | 2023-11-17 02:56:56 +1100 | |
---|---|---|
committer | 2023-11-17 02:56:56 +1100 | |
commit | 143f6c4508dc71e24ac0645952f97734e7f29d52 (patch) | |
tree | 31bac5e82e8c235e65103f59e0d84a86ad83ba36 /docs/source/luascript | |
parent | a10193900907966e44ce92e64361ce926d1b923b (diff) |
luaengine.cpp: Restored ability for wait functions to yield values from coroutines.
Made the documentation on what it's supposed to do a bit clearer.
Diffstat (limited to 'docs/source/luascript')
-rw-r--r-- | docs/source/luascript/ref-common.rst | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/source/luascript/ref-common.rst b/docs/source/luascript/ref-common.rst index 85bd580a144..c08d3676621 100644 --- a/docs/source/luascript/ref-common.rst +++ b/docs/source/luascript/ref-common.rst @@ -58,21 +58,23 @@ 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. Returns a Boolean indicating whether the duration expired - normally. + in seconds. Any additional arguments are returned from the coroutine. + 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. 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.wait_next_update(…) + Yields until the next video/UI update. Any arguments are returned from the + coroutine. 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 + from the coroutine. 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>`. |