tour/minetest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

core.after: Improve documentation details about how time is handled (#15316)

Browse Source
This commit is contained in:
DS 2024-10-24 17:52:27 +02:00 committed by GitHub
parent 2d135cc1bb
commit 3f306a407c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/lua_api.md
View File

@ -6923,6 +6923,14 @@ Timing
* Optional: Variable number of arguments that are passed to `func` * Optional: Variable number of arguments that are passed to `func`
* Jobs set for earlier times are executed earlier. If multiple jobs expire * Jobs set for earlier times are executed earlier. If multiple jobs expire
at exactly the same time, then they are executed in registration order. at exactly the same time, then they are executed in registration order.
* `time` is a lower bound. The job is executed in the first server-step that
started at least `time` seconds after the last time a server-step started,
measured with globalstep dtime.
* In particular this can result in relatively large delays if `time` is close
to the server-step dtime. For example, with a target server-step of 0.09 s,
`core.after(0.09, ...)` often waits two steps, resulting in a delay of about
0.18 s.
* If `time` is `0`, the job is executed in the next step.
* `job:cancel()` * `job:cancel()`
* Cancels the job function from being called * Cancels the job function from being called