Timer commands - Hotride/OrionUO GitHub Wiki
Command format:
ReturnType NameSpace.name(requiredParameters, [optionalParameters=defaultValue]);
-
ReturnType - the return value of the function (void - the function returns nothing);
-
NameSpace - the scope of the function;
-
name - the name of the function;
-
requiredParameters - required parameters;
-
optionalParameters - optional parameters, the default value is indicated after the = sign
bool Orion.TimerExists('name');
Check if timer with given name exists.
Returns true if such timer exists.
void Orion.SetTimer('name', [delay=0]);
Create/Change timer with 'delay' as initial value. Default is 0.
int Orion.Timer('name');
Get current value of timer by name.
Returns -1 if such timer doesn't exist .
Returns time passed from timer initiation in ms.
void Orion.RemoveTimer('name');
Removes timer with a given name.
void Orion.ClearTimers();
Removes all existing timers.