View source for $timer

Returns information about a timer.
 $timer(N/name)

Returns the timer id of the Nth timer in the timers list or the one you have specified by its name.


$timer has the following properties:
<table>
<tr><td width="10%"><b>property</b></td><td width="90%"><b>explanation</b></td></tr>
<tr><td>com</td><td>returns the command</td></tr>
<tr><td>time</td><td>returns the time when the timer will be triggered (if you have specified one)</td></tr><tr><td>reps</td><td>returns the repetitions the timer will have</td></tr>
<tr><td>delay</td><td>returns the delay between two triggers</td></tr>
<tr><td>type</td><td>returns online/offline status</td></tr>
<tr><td>secs</td><td>returns number of seconds left before timer is triggered</td></tr>
<tr><td>mmt</td><td>returns $true if timer is a multimedia timer</td></tr>
<tr><td>anysc</td><td>returns $true if the /timer -i switch was specified</td></tr>
<tr><td valign="top">wid</td><td>returns window id of the status window of the connection the timer is related to</td></tr>
<tr><td>cid</td><td>returns connection id of the timer</td></tr>
<tr><td valign="top">hwnd</td><td>returns the handle window of the status window of the connection the timer is related to</td></tr>
</table>



== Example ==
 [[alias]] timertest {
  [[timer]]foo 1 10 { [[echo]] -a moo }
  echo -a $timer(foo).com
  echo -a $timer(foo).delay
  [[if]] ($timer(foo).mmt) { echo -a timer foo is a multimedia timer }
  else { echo -a timer foo is no multimedia timer }
 }
This example will create an alias called timertest. The alias will at first make a new timer called ''foo'' and then echo some information about it. After ten seconds, you will get a "moo" in your active window, as the timer has been triggered then.

[[Category:Timer]]