$timer » History » Version 10
Per Amundsen, 02/23/2023 07:46 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 | 10 | Per Amundsen | table(ktable). |
10 | |*Parameter*|*Description*| |
||
11 | | N<notextile>|</notextile>name | Name of the timer, if N = 0, number of timers, otherwise the Nth timer. | |
||
12 | 1 | Per Amundsen | |
13 | *Properties* |
||
14 | |||
15 | 10 | Per Amundsen | table(ktable). |
16 | |*Property*|*Description*| |
||
17 | | .cid | Returns [[$cid<notextile>|</notextile>connection id]] associated with the timer. | |
||
18 | | .wid | Returns [[$wid<notextile>|</notextile>window id]] associated with the timer. | |
||
19 | | .hwnd | Returns window handle associated with the timer. | |
||
20 | | .delay | Returns the timer interval. | |
||
21 | | .pause | Returns [[$true]] if the timer is paused, otherwise [[$false]]. | |
||
22 | | .reps | Returns number of repetitions left. | |
||
23 | | .com | Returns the command the timer runs. | |
||
24 | | .type | Returns online or offline. | |
||
25 | | .mmt | Returns [[$true]] if the timer is a multimedia timer, otherwise [[$false]]. | |
||
26 | | .anysc | Returns [[$true]] if the timer is set to dynamically associates itself with the active connection, otherwise [[$false]]. | |
||
27 | | .time | Returns the HH:MM time to run the timer at, if specified. | |
||
28 | | .name | Returns the timers N position even if the timer name is a number. | |
||
29 | | .secs | Returns the number of seconds before the next time the timer executes. | |
||
30 | | .ms | Returns the number of milliseconds before the next time the timer executes. | |
||
31 | 1 | Per Amundsen | |
32 | *Example* |
||
33 | |||
34 | <pre> |
||
35 | ; List number of running timers. |
||
36 | //echo -ag $timer(0) |
||
37 | |||
38 | ; List the first timer. |
||
39 | //echo -ag $timer(1) |
||
40 | </pre> |