util.timer.create

Shared

Creates a new timer instance that executes specified function on a given interval


Syntax

local instance = util.timer.create(
    exec,
    interval,
    executions
)

Parameters

TypeNameDescription
functionexecFunction to execute by the timer
intintervalInterval in milliseconds between each execution
Must be >= 0
intexecutionsNumber of times to execute (0 means infinite)
Must be >= 0

Returns

TypeNameDescription
timerinstanceCreated timer instance

Callback: exec

exec(count)
TypeNameDescription
intcountNumber of times the timer has executed

Create a one-shot timer
local entity = util.timer.create(function(count)
    core.engine.print("info", "Counter:", count)
end, 1000, 1)
Create a repeating timer
local entity = util.timer.create(function(count)
    core.engine.print("info", "Counter:", count)
end, 500, 0)
Create a timer that fires 3 times then auto-destroys
local entity = util.timer.create(function(count)
    core.engine.print("info", count.."/3")
end, 1000, 3)

On this page