Skip to content

Commit

Permalink
core.after: Improve documentation details about how time is handled
Browse files Browse the repository at this point in the history
  • Loading branch information
Desour committed Oct 23, 2024
1 parent 9f43018 commit 2265205
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/lua_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6922,6 +6922,9 @@ Timing
* Optional: Variable number of arguments that are passed to `func`
* Jobs set for earlier times are executed earlier. If multiple jobs expire
at exactly the same time, then they are executed in registration order.
* `time` is a lower bound. The job is executed in the first globalstep that
started at least `time` seconds after the current globalstep started.
If `time` is `0`, it's executed in the next step.

* `job:cancel()`
* Cancels the job function from being called
Expand Down

0 comments on commit 2265205

Please sign in to comment.