Hilbish/docs/api/hilbish/hilbish.timers.md

title	description	layout	menu
Module hilbish.timers	timeout and interval API	doc	docs parent API

Introduction

If you ever want to run a piece of code on a timed interval, or want to wait a few seconds, you don't have to rely on timing tricks, as Hilbish has a timer API to set intervals and timeouts.

These are the simple functions hilbish.interval and hilbish.timeout (doc accessible with doc hilbish). But if you want slightly more control over them, there is the hilbish.timers interface. It allows you to get a timer via ID and control them.

All functions documented with the Timer type refer to a Timer object.

An example of usage:

local t = hilbish.timers.create(hilbish.timers.TIMEOUT, 5000, function()
	print 'hello!'
end)

t:start()
print(t.running) // true

Functions

create(type, time, callback) -> @Timer	Creates a timer that runs based on the specified time in milliseconds.
get(id) -> @Timer	Retrieves a timer via its ID.

Static module fields

INTERVAL	Constant for an interval timer type
TIMEOUT	Constant for a timeout timer type

---

hilbish.timers.create(type, time, callback) -> Timer

Creates a timer that runs based on the specified time in milliseconds. The type can either be hilbish.timers.INTERVAL or hilbish.timers.TIMEOUT

Parameters

This function has no parameters.

---

hilbish.timers.get(id) -> Timer

Retrieves a timer via its ID.

Parameters

This function has no parameters.

Types

---

Timer

The Job type describes a Hilbish timer.

Object properties

type	What type of timer it is
running	If the timer is running
duration	The duration in milliseconds that the timer will run

Methods

start()

Starts a timer.

stop()

Stops a timer.