Project

General

Profile

Timer » History » Revision 5

Revision 4 (Per Amundsen, 02/26/2017 12:11 AM) → Revision 5/17 (Per Amundsen, 02/26/2017 12:11 AM)

_Added in 1.9.0_ 

 */timers [off]* 
 */timer[n|name] [off]* 
 */timer[n|name] [-cdehimopr] [time] <repetitions> <interval> <code>* 

 Creates a timer that runs <code> at an interval. 

 If you are connected to server when the timer is started, it defaults to being a online timer, otherwise it will be a offline timer. 

 A offline timer will continue to run even if the server is disconnected, while a online timer will stop the timer when disconnected. 

 *Switches* 

 -c - TODO 
 -d - TODO 
 -e - Executes the code associated with a timer. 
 -h - Creates a high-resolution timer. 
 -i - Dynamically associates itself with the active connection. 
 -m - Treats the interval parameter as milliseconds instead of seconds. 
 -o - Creates a offline timer. 
 -p - Pauses a timer. 
 -r - Resumes a timer. 

 *Parameters* 

 [off] - Turns of a timer. 
 [n|name] - The name or index of the timer. 
 [time] - TODO 
 <repetitions> - The amount of timer the timers should repeat itself. An repetition value of '0' will repeat for ever. 
 <interval> - The delay between two consecutive timer executions 
 <code> - Code to be executed.  

 *Example* 

 <pre> 
 alias example { 
   ; Create a variable and set value to 5. 
   var %reps = 5 
 
   ; Call the timer %reps times after 1 second delay. delay each. 
   .timer %reps 1 countdown  
 
   ; Print the first count. 
   count-down 
 } 

 alias -l countdown { 
   echo -ag Count: $timer($ltimer).reps 
 } 
 </pre>