$timer » History » Version 6
Per Amundsen, 03/02/2018 06:39 PM
| 1 | 1 | Per Amundsen | _Added in 1.9.0_ |
|---|---|---|---|
| 2 | |||
| 3 | *$timer(N|name)* |
||
| 4 | |||
| 5 | Returns the timer id of the name or Nth timer in the timers list. |
||
| 6 | |||
| 7 | *Parameters* |
||
| 8 | |||
| 9 | N|name - Name of the timer, if N = 0, number of timers, otherwise the Nth timer. |
||
| 10 | |||
| 11 | *Properties* |
||
| 12 | |||
| 13 | 3 | Per Amundsen | .cid - Returns [[$cid|connection id]] associated with the timer. |
| 14 | .wid - Returns [[$wid|window id]] associated with the timer. |
||
| 15 | 1 | Per Amundsen | .hwnd - Returns window handle associated with the timer. |
| 16 | .delay - Returns the timer interval. |
||
| 17 | .pause - Returns [[$true]] if the timer is paused, otherwise [[$false]]. |
||
| 18 | .reps - Returns number of repetitions left. |
||
| 19 | .com - Returns the command the timer runs. |
||
| 20 | .type - Returns online or offline. |
||
| 21 | 2 | Per Amundsen | .mmt - Returns [[$true]] if the timer is a multimedia timer, otherwise [[$false]]. |
| 22 | .anysc - Returns [[$true]] if the timer is set to dynamically associates itself with the active connection, otherwise [[$false]]. |
||
| 23 | 4 | Per Amundsen | .time - Returns the HH:MM time to run the timer at, if specified. |
| 24 | 6 | Per Amundsen | .name - Returns the timers N position even if the timer name is a number. |
| 25 | 1 | Per Amundsen | |
| 26 | *Example* |
||
| 27 | |||
| 28 | <pre> |
||
| 29 | ; List number of running timers. |
||
| 30 | //echo -ag $timer(0) |
||
| 31 | |||
| 32 | ; List the first timer. |
||
| 33 | //echo -ag $timer(1) |
||
| 34 | </pre> |