FrameworkZ API Documentation - FrameworkZ.Timers

FrameworkZ.Timers

library

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

0
Functions
11
Methods
2
Fields

Fields

2
FrameworkZ.Timers 📋 table
Timers module for FrameworkZ. Allows for the creation of timers for delaying code executions.
Initial value: {}
FrameworkZ.Timers.Resume ❓ unknown inferred
Initial value: FrameworkZ.Timers.UnPause

Methods

11

FrameworkZ.Timers:Create(name, delay, repetitions, func)

method undocumented
No documentation available

Parameters (inferred)

name unknown
Parameter inferred from function signature
delay unknown
Parameter inferred from function signature
repetitions unknown
Parameter inferred from function signature
func unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Timers:Exists(name)

method undocumented
No documentation available

Parameters (inferred)

name unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Timers:NextTimeLeft(name)

method undocumented
No documentation available

Parameters (inferred)

name unknown
Parameter inferred from function signature

FrameworkZ.Timers:Pause(name)

method undocumented
No documentation available

Parameters (inferred)

name unknown
Parameter inferred from function signature

FrameworkZ.Timers:Remove(name)

method undocumented
No documentation available

Parameters (inferred)

name unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Timers:RepsLeft(name)

method undocumented
No documentation available

Parameters (inferred)

name unknown
Parameter inferred from function signature

FrameworkZ.Timers:Simple(delay, func)

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

Parameters

integer 🏷️ delay
The delay in seconds before the function is executed.
function 🏷️ func
The function to execute after the delay.

FrameworkZ.Timers:Start(name)

method undocumented
No documentation available

Parameters (inferred)

name unknown
Parameter inferred from function signature

FrameworkZ.Timers:TimeLeft(name)

method undocumented
No documentation available

Parameters (inferred)

name unknown
Parameter inferred from function signature

FrameworkZ.Timers:Toggle(name)

method undocumented
No documentation available

Parameters (inferred)

name unknown
Parameter inferred from function signature

FrameworkZ.Timers:UnPause(name)

method undocumented
No documentation available

Parameters (inferred)

name unknown
Parameter inferred from function signature