FrameworkZ::Timers Class Reference

Timers module for FrameworkZ. Allows for the creation of timers for delaying code executions. More...

Public Member Functions
void	Create (name, delay, repetitions, func)
void	Exists (name)
void	NextTimeLeft (name)
void	Pause (name)
void	Remove (name)
void	RepsLeft (name)
void	Simple (delay, func)
	Creates a simple timer that executes a function after a delay.
void	Start (name)
void	TimeLeft (name)
void	Toggle (name)
void	UnPause (name)

Data Fields
FrameworkZ Timers	AdvancedTimers
local	assert
local	os_time
local	pairs
FrameworkZ Timers	SimpleTimers
local	table_insert
local	table_remove
FrameworkZ	Timers
local	type

Detailed Description

Timers module for FrameworkZ. Allows for the creation of timers for delaying code executions.

Definition at line 5 of file Timers.lua.

Member Function Documentation

Create()

void Create	(	name	,
		delay	,
		repetitions	,
		func	)

Exists()

void Exists

(

name

)

NextTimeLeft()

void NextTimeLeft

(

name

)

Pause()

void Pause

(

name

)

Remove()

void Remove

(

name

)

RepsLeft()

void RepsLeft

(

name

)

Simple()

void Simple	(	delay	,
		func	)

Creates a simple timer that executes a function after a delay.

Parameters

<a	href="variable_types.html#integer" >integer delay The delay in seconds before the function is executed.
<a	href="variable_types.html#function" >function func The function to execute after the delay.

Start()

void Start

(

name

)

TimeLeft()

void TimeLeft

(

name

)

Toggle()

void Toggle

(

name

)

UnPause()

void UnPause

(

name

)

Field Documentation

AdvancedTimers

FrameworkZ Timers AdvancedTimers

Definition at line 9 of file Timers.lua.

assert

local assert

Definition at line 19 of file Timers.lua.

os_time

local os_time

Definition at line 13 of file Timers.lua.

pairs

local pairs

Definition at line 23 of file Timers.lua.

SimpleTimers

FrameworkZ Timers SimpleTimers

Definition at line 11 of file Timers.lua.

table_insert

local table_insert

Definition at line 15 of file Timers.lua.

table_remove

local table_remove

Definition at line 17 of file Timers.lua.

Timers

FrameworkZ Timers

Definition at line 7 of file Timers.lua.

type

local type

Definition at line 21 of file Timers.lua.

---

The documentation for this class was generated from the following file:

• Timers.lua