Semiconductor & Computer Engineering
(typo fix (for ever --> forever)) |
|||
| Line 31: | Line 31: | ||
* '''<interval>''' - The delay between two consecutive timer executions | * '''<interval>''' - The delay between two consecutive timer executions | ||
* '''<nowiki><code></nowiki>''' - Code to be executed. | * '''<nowiki><code></nowiki>''' - Code to be executed. | ||
| + | |||
| + | == {{mIRC|$ctimer}} & {{mIRC|$ltimer}} == | ||
| + | |||
| + | {{mIRC|$ctimer}} can be used to return the name of the timer which triggered the current script while {{mIRC|$ltimer}} returns the name of the last timer which triggered. | ||
== Example == | == Example == | ||
| Line 79: | Line 83: | ||
* {{mIRC|$timer}} | * {{mIRC|$timer}} | ||
* {{mIRC|$ctimer}} | * {{mIRC|$ctimer}} | ||
| + | * {{mIRC|$ltimer}} | ||
* {{mIRC|$time}} | * {{mIRC|$time}} | ||
* {{mIRC|$date}} | * {{mIRC|$date}} | ||
Revision as of 11:26, 25 October 2018
The /timer command can be used to create a general purpose timer. A timer is a way to execute code at some specific interval or time and delay. Timers can be named and unnamed. Unnamed timers will get the lowest numeric timer index available. Named timers are specifically useful if you need to recall that timer at a later period - to pause it, resume it, or simply reset it. Starting a timer with a name that already exists will override the old timer. Timers only get execute on the main mIRC message loop. I.E. after the alias/event are complete.
Contents
Synopsis
/timers [off] /timer[n|name] [off] /timer[n|name] [-cdeomhiprzN] [time] <repetitions> <interval> <code>
Switches
Creation Manipulators
- -o - Creates a offline timer
- -c - Creates a catch-up timer
- -h - Creates a high-resolution timer (interval is in millisecond just like -m)
Attributes
- -m - Treats the interval parameter as milliseconds instead of seconds
- -d - Keeps the order of all -d timers
- -i - Dynamically associates itself with the active connection
Manipulator
- -e - Executes the code associated with a timer
- -p - Pauses a timer
- -r - Resumes a timer
- -zN - Resets an online timer; N=2 resets total time, N=1, resets current time, and N=0 is the same as N=1 AND N=2
Parameters
- [off] - A literal 'off' keyword, used to turn off a timer.
- [n|name] - The name or index of the timer
- [time] - Time to activate the timer, for example '15:30' for 3:30PM
- <repetitions> - The amount of times the timer should repeat itself. A repetition value of '0' will repeat forever.
- <interval> - The delay between two consecutive timer executions
- <code> - Code to be executed.
$ctimer & $ltimer
$ctimer can be used to return the name of the timer which triggered the current script while $ltimer returns the name of the last timer which triggered.
Example
Below is a simple count down timer that uses a call-back alias once per second:
alias example { ; start cou var %reps = 5 ; call the timer %reps times after 1 second delay each .timer %reps 1 count-down ; print the first count count-down } alias -l count-down { echo -a Count: $timer($ltimer).reps }
The above code will generate the following output:
Count: 5 Count: 4 Count: 3 Count: 2 Count: 1 Count: 0
A more basic example of a message being delayed for 3 seconds:
on *:text:!foo:#foo:{ ; delay the message for 3 seconds timer 1 3 msg #foo Bar! }
A repetition of '0' can also be used to mean an repeat for ever:
alias cur_time { timer 0 1 echo -s $!time(hh:nn:ss) }
Compatibility
Added: mIRC 3.3, 3.4