Add documentation to timers.lua

This commit is contained in:
NullBite 2023-06-24 23:24:11 -04:00
parent 92b4b99083
commit bf1b2d4f7c
Signed by: nullbite
GPG Key ID: 6C4D545385D4925A

View File

@ -4,6 +4,10 @@
timers={}
do
local timers = {}
--- Wait
--Wait a certain number of ticks and execute a function.
---@param ticks integer Number of ticks to wait
---@param next function Callback to run
function wait(ticks,next)
table.insert(timers, {t=world.getTime()+ticks,n=next})
end
@ -24,6 +28,12 @@ timers.wait=wait
-- if timer is armed twice before expiring it will only be called once) --
do
local timers = {}
--- Wait
--Wait a certain number of ticks and execute a function. Store the timer with a name so that
--it can be overwritten.
---@param ticks integer Number of ticks to wait
---@param next function Callback to run
---@param name function Name of callback
function namedWait(ticks, next, name)
-- main difference, this will overwrite an existing timer with
-- the same name