Scriptwiki - User contributions [en]

Rawdb

2016-11-29T12:29:27Z

Microbe: Updated dead links

User:Microbe

2010-04-20T09:22:11Z

Microbe: Yearly update, this time the last :)

{{Babel-4|fi|en-3|sv-2|fr-2|sl-1}}

<table border="0">
<tr>
<td>[[Image:Microbe.jpg]]</td>
<td>
<table border="0">
<tr><td><b>Name</b></td><td>Lauri Peltonen</td></tr>
<tr><td><b>Age</b></td><td>Born in '83 so you do the math!</td></tr>
<tr valign="top" height="40"><td><b>Country</b></td><td>Finland</td></tr>

<tr><td><b>Words of wisdom</b></td><td>Still searching wisdom.</td></tr>
</table>
</td>
</tr>
</table>
[[Category:Members]]

User:Microbe

2009-04-03T13:02:21Z

Microbe: Wrong language tag

{{Babel-4|fi|en-3|sv-2|fr-2|sl-1}}

<table border="0">
<tr>
<td>[[Image:Microbe.jpg]]</td>
<td>
<table border="0">
<tr><td><b>Name</b></td><td>Lauri Peltonen</td></tr>
<tr><td><b>Age</b></td><td>26</td></tr>
<tr valign="top" height="40"><td><b>Country</b></td><td>Finland</td></tr>

<tr><td><b>Words of wisdom</b></td><td>Still searching wisdom.</td></tr>
</table>
</td>
</tr>
</table>
[[Category:Members]]

User:Microbe

2009-04-03T12:59:33Z

Microbe: Yearly update.

{{Babel-4|fi|en-3|sv-2|fr-2|si-1}}

<table border="0">
<tr>
<td>[[Image:Microbe.jpg]]</td>
<td>
<table border="0">
<tr><td><b>Name</b></td><td>Lauri Peltonen</td></tr>
<tr><td><b>Age</b></td><td>26</td></tr>
<tr valign="top" height="40"><td><b>Country</b></td><td>Finland</td></tr>

<tr><td><b>Words of wisdom</b></td><td>Still searching wisdom.</td></tr>
</table>
</td>
</tr>
</table>
[[Category:Members]]

How to start

2009-01-13T20:02:25Z

Microbe: was missing a newline that messed it all up

This tutorial is supposed to give an introduction into scripting in mIRC. It will explain the so-called ''Scripts-Editor'' and its functions, followed by a little example. At the end it will give some hints about how to debug a script.

== The Remote Editor ==

If you want to begin to script in mIRC, you need to open the Script-Editor. You can do it in two ways: pressing "Alt + R" or with mIRC's menubar (Tools -> Scripts Editor).

If you are using a premade script (for example nnscript), you will probably see a lot of code. Note that it is difficult to implement own scripts in such a premade one, as your code may interfere with the existing code (if you want to change mIRC's default output for example).

At first, you should open a '''new remote file'''. To do it, click on File -> New (see picture below).

[[Image:Newfile.png]]

Note that your script files will be saved '''automatically'''; all you need to do is pressing 'Ok'.

The next part is about the five different tabs of mIRC's Scripts Editor:

[[Image:scriptseditortabs.png]]

=== Aliases-Tab ===

Basically, you do not need to use aliases.ini (that you can edit using this tab). Usually, if you want to add a new alias, it would look like:

[[alias]] moo { [[return]] moo }

in your 'Remote-Section' of the editor (the one that's active after pressing Alt + R).

You can add the same alias in your Aliases-Section:

moo { return moo }

Notice that you don't need to write 'alias' infront of the new alias if it's in the Aliases section and note that you cannot add events in this section.

=== Popups-Tab ===

Again you do not need to use this section. It's the same as using the [[Popup_Menus#MENU_prefix|menus]] alias in the remote section. Usually, there will be some menus added in this section (for example your nicklist-menu).

[[Image:Popupsview.png]]

=== Remote-Tab ===

This is the "maintab". Every script is supposed to be saved in here.

'''Note''' that you should not have two same events in one file, as only the first matching one will be triggered. Two separate examples:

; will be triggered
on *:Text:*:*: { echo moo }

; will never be triggered
on 10:Text:*:*: { echo maa }

; will be triggered for level 10
on 10:Text:*:*: { echo maa }

; will be triggered for all but level 10
on *:Text:*:*: { echo moo }

So if you aren't sure whether it will work or not, just use another (a new) file (look the image below to see how to make a new file).

The following script will trigger on every "!moo" in every channel and response with "moo00oo00":

[[On_text|on *:TEXT]]:!moo:#: {
[[msg]] [[$chan]] moo00oo00
}

This would look like:

[[Image:Firstscript.png]]

If you are scripting something more complex, you want to use the "{}"-button in the upper right corner (see below). That button is used to check for bracket mis-matches in the scriptfile.

[[Image:Bracket-button.png]]

If you've pressed it and nothing happended, everything is ok (note that it doesn't mean that your scripts will work, just that there are no obvious bracket mistakes (mIRC just counts the open and closed brackets)). If something's wrong, you will get the following popup:

[[Image:Bracketerror.png]]

Even if it says that the bracket error is ''around'' line 1, it could be almost anywhere. Start you search from that line and look at the indentations to find out where you're missing a bracket.

The remote tab contains scripts that are triggered by events, such as [[On text|when someone speaks]] or [[On join|when someone joins a channel]]. For example, the following 'remote script' would tell user's who join a channel hello!

[[On join|on *:JOIN]]:#: {
[[msg]] [[$nick]] Hello. Welcome to [[$chan]] [[DollarPlus|$+]] !!!
}

If you would like to learn scripting, you should familiarize yourself with this tab.
You should also learn [[:Category:Events|event names]] and understand how to run commands, such as the [[msg]] command above which messages a channel or nick name. You should also learn what [[:Category:Remote Identifiers|identifiers]] are and how to use them. An example of an identifier in the above script is [[$nick]] and [[$chan]] which tell us the user's nick name and the channel's name.
You may click on any blue hyperlink for more information about a a command or identifier that you see in any of this wiki's examples. Please use the examples and test them, to try and understand what they do. Keep in mind, mIRC is a high level language and almost everything sounds like it is. For example, if you want to know when someone quites you would use the [[on quit]] event! One of the most common script events used is the [[on text]] event, which triggers when someone speaks either in a channel or a private message.
If you are interested in these events, you should move on to [[How to start (part 2)|part 2]] of this introduction.

=== Users-Tab ===

In this file your userlist is saved. You don't need to edit it manually, as there are commands to do it. See [[Access_Levels|access levels in general]], [[auser]], [[guser]] and [[ruser]].

=== Variables-Tab ===

All your global variables are saved in here. Again, you don't need to edit it manually, as you can use [[set]], [[unset]] or [[unsetall]].

== How to debug ==

After you've written some lines and you've tested it, you will most likely notice, that it doesn't do what you expect it to do. The next step is to '''debug''' your script. At first take a look at your Status Window and check for error messages. If there are any, search for these errors in your script and correct them. If they aren't any, you should add [[echo]]'s in your script to see where it stops to work. For example:

on *:TEXT:*:*: {
if (%moo) { echo -a we are here }
elseif (%moo2) { echo -a we are here 2 }
echo -a after the if clauses
}

With this method, you can see exactly where it stops to work and correct this part.<br>
'''Note''' You cannot trigger on text, on notice, on action... events by yourself, you will need someone's help or another client or multiserver (/[[server]] -m ...) to test them.

If some of the built-in commands don't work, ie. /kick, /away ... etc. you might have a custom alias that overrides them, you can test it with /!command, ie. /!kick #channel nick.
/!command will use the default mIRC command and bypass any custom aliases.

'''For more info on debugging, see [[Debugging (Find The Bug)]]'''.

== See also ==
* [[How to start (part 2)]]

[[Category:Tutorials]]

User:Microbe

2008-03-31T13:25:52Z

Microbe: Yearly update (and no, I'm not coming online today, hah!)

{{Babel-4|fi|en-3|sv-2|fr-2}}

<table border="0">
<tr>
<td>[[Image:Microbe.jpg]]</td>
<td>
<table border="0">
<tr><td><b>Name</b></td><td>Lauri Peltonen</td></tr>
<tr><td><b>Age</b></td><td>25</td></tr>
<tr valign="top" height="40"><td><b>Country</b></td><td>Finland</td></tr>

<tr><td><b>Words of wisdom</b></td><td>Still searching wisdom.</td></tr>
</table>
</td>
</tr>
</table>
[[Category:Members]]

News

2007-07-02T10:02:53Z

Microbe: News about the wiki move

== Wiki moved ==

{{newsWriter|[[User:Microbe|Microbe]] 12:02, 2 Jul 2007 (CEST)}}

This Scriptwiki was moved to its new permanent home some time ago. The address is now easier to remember and it contains a hint of the wiki's origins. Hope you all find your way here :)

== mIRC 6.21 is out ==
{{newsWriter|[[User:Microbe|Microbe]] 23:03, 23 Nov 2006 (CET)}}

mIRC version 6.21 was just released. Read more about it and download it at [http://www.mirc.com www.mirc.com].

== mIRC 6.2 is out ==
{{newsWriter|[[User:Cail|Cail]] 14:48, 27 Aug 2006 (CET)}}

mIRC 6.2 was released July 28th 2006, get it at [http://www.mirc.com www.mirc.com]. Take a look at the [http://www.mirc.co.uk/versions.txt list of changes] aswell.

== Changes to Scriptwiki ==
{{newsWriter|[[User:Microbe|Microbe]] 00:39, 5 May 2006 (CEST)}}

Scriptwiki has gone through some changes, again. It has been made an official QuakeNet wiki and recruiting new editors has been made easier - the process should now be far faster and more user-friendly. So if you're interested in contributing to this wiki, have a look at the front page's instructions.

== mIRC 6.17 is out ==
{{newsWriter|[[User:Microbe|Microbe]] 00:31, 18 Feb 2006 (CET)}}

mIRC version 6.17 has been released an hour ago. Read more about it and download it at [http://www.mirc.com www.mirc.com].

== Scriptwiki has been globalized ==
{{newsWriter|[[User:Microbe|Microbe]] 04:03, 4 Feb 2006 (CET)}}

Scriptwiki has gone through some changes. The project started as a small one-channel project, but it is now released "to the wild". People interested to contribute to this wiki are encouraged to contact us, especially from other networks than QuakeNet. At the moment this wiki is dedicated more towards QuakeNet users, but we are hoping that this will change in the future. Users from every network should be able to get the information they need from here, especially network-specific raw events.

So if you want to contribute to the only wiki dedicated to mIRC scripting (at least at the moment), see the main page for more information.

== Welcome to Scriptwiki ==
{{newsWriter|[[User:Tovrleaf|Tovrleaf]] 22:53, 15 Sep 2005 (CEST)}}

Hi, and welcome to our new published '''Scriptwiki'''. Scriptwiki (as we call it) is our new lifelong project which won't probably ever be finished. It shall be developed and expanded along with mIRC and new scripting skills.

Special thanks to all users who have helped us to get this to shape and to create a more user friendly wiki and articles.

If you think this wiki is missing some essential articles, there's a page to [[Special:Request|request]] new articles for it. And don't forget to give us [[:Special:SendComment|feedback]], comments, ideas or new suggestions.

== Scriptwiki starting ==
{{newsWriter|[[User:Microbe|Microbe]] 12:53, 24 Aug 2005 (CEST)}}

Scriptwiki starting to get in shape

__NOTOC__

News

2007-07-02T09:55:38Z

Microbe: fixed url

== mIRC 6.21 is out ==
{{newsWriter|[[User:Microbe|Microbe]] 23:03, 23 Nov 2006 (CET)}}

mIRC version 6.21 was just released. Read more about it and download it at [http://www.mirc.com www.mirc.com].

== mIRC 6.2 is out ==
{{newsWriter|[[User:Cail|Cail]] 14:48, 27 Aug 2006 (CET)}}

mIRC 6.2 was released July 28th 2006, get it at [http://www.mirc.com www.mirc.com]. Take a look at the [http://www.mirc.co.uk/versions.txt list of changes] aswell.

== Changes to Scriptwiki ==
{{newsWriter|[[User:Microbe|Microbe]] 00:39, 5 May 2006 (CEST)}}

Scriptwiki has gone through some changes, again. It has been made an official QuakeNet wiki and recruiting new editors has been made easier - the process should now be far faster and more user-friendly. So if you're interested in contributing to this wiki, have a look at the front page's instructions.

== mIRC 6.17 is out ==
{{newsWriter|[[User:Microbe|Microbe]] 00:31, 18 Feb 2006 (CET)}}

mIRC version 6.17 has been released an hour ago. Read more about it and download it at [http://www.mirc.com www.mirc.com].

== Scriptwiki has been globalized ==
{{newsWriter|[[User:Microbe|Microbe]] 04:03, 4 Feb 2006 (CET)}}

Scriptwiki has gone through some changes. The project started as a small one-channel project, but it is now released "to the wild". People interested to contribute to this wiki are encouraged to contact us, especially from other networks than QuakeNet. At the moment this wiki is dedicated more towards QuakeNet users, but we are hoping that this will change in the future. Users from every network should be able to get the information they need from here, especially network-specific raw events.

So if you want to contribute to the only wiki dedicated to mIRC scripting (at least at the moment), see the main page for more information.

== Welcome to Scriptwiki ==
{{newsWriter|[[User:Tovrleaf|Tovrleaf]] 22:53, 15 Sep 2005 (CEST)}}

Hi, and welcome to our new published '''Scriptwiki'''. Scriptwiki (as we call it) is our new lifelong project which won't probably ever be finished. It shall be developed and expanded along with mIRC and new scripting skills.

Special thanks to all users who have helped us to get this to shape and to create a more user friendly wiki and articles.

If you think this wiki is missing some essential articles, there's a page to [[Special:Request|request]] new articles for it. And don't forget to give us [[:Special:SendComment|feedback]], comments, ideas or new suggestions.

== Scriptwiki starting ==
{{newsWriter|[[User:Microbe|Microbe]] 12:53, 24 Aug 2005 (CEST)}}

Scriptwiki starting to get in shape

__NOTOC__

News

2007-07-02T09:52:05Z

Microbe: Changed "list of changes" link to mirc.co.uk/versions.txt

== mIRC 6.21 is out ==
{{newsWriter|[[User:Microbe|Microbe]] 23:03, 23 Nov 2006 (CET)}}

mIRC version 6.21 was just released. Read more about it and download it at [http://www.mirc.com www.mirc.com].

== mIRC 6.2 is out ==
{{newsWriter|[[User:Cail|Cail]] 14:48, 27 Aug 2006 (CET)}}

mIRC 6.2 was released July 28th 2006, get it at [http://www.mirc.com www.mirc.com]. Take a look at the [http://mirc.co.uk/versions.txt| list of changes] aswell.

== Changes to Scriptwiki ==
{{newsWriter|[[User:Microbe|Microbe]] 00:39, 5 May 2006 (CEST)}}

Scriptwiki has gone through some changes, again. It has been made an official QuakeNet wiki and recruiting new editors has been made easier - the process should now be far faster and more user-friendly. So if you're interested in contributing to this wiki, have a look at the front page's instructions.

== mIRC 6.17 is out ==
{{newsWriter|[[User:Microbe|Microbe]] 00:31, 18 Feb 2006 (CET)}}

mIRC version 6.17 has been released an hour ago. Read more about it and download it at [http://www.mirc.com www.mirc.com].

== Scriptwiki has been globalized ==
{{newsWriter|[[User:Microbe|Microbe]] 04:03, 4 Feb 2006 (CET)}}

Scriptwiki has gone through some changes. The project started as a small one-channel project, but it is now released "to the wild". People interested to contribute to this wiki are encouraged to contact us, especially from other networks than QuakeNet. At the moment this wiki is dedicated more towards QuakeNet users, but we are hoping that this will change in the future. Users from every network should be able to get the information they need from here, especially network-specific raw events.

So if you want to contribute to the only wiki dedicated to mIRC scripting (at least at the moment), see the main page for more information.

== Welcome to Scriptwiki ==
{{newsWriter|[[User:Tovrleaf|Tovrleaf]] 22:53, 15 Sep 2005 (CEST)}}

Hi, and welcome to our new published '''Scriptwiki'''. Scriptwiki (as we call it) is our new lifelong project which won't probably ever be finished. It shall be developed and expanded along with mIRC and new scripting skills.

Special thanks to all users who have helped us to get this to shape and to create a more user friendly wiki and articles.

If you think this wiki is missing some essential articles, there's a page to [[Special:Request|request]] new articles for it. And don't forget to give us [[:Special:SendComment|feedback]], comments, ideas or new suggestions.

== Scriptwiki starting ==
{{newsWriter|[[User:Microbe|Microbe]] 12:53, 24 Aug 2005 (CEST)}}

Scriptwiki starting to get in shape

__NOTOC__

Category:Token Identifiers

2007-05-03T22:03:31Z

Microbe: added some examples

== Definition ==
Tokens are strings of characters that are separated by a certain character.

Tokens are a very useful way to handle strings of text from which you need to separate shorter strings that are separated by a character. Usually the separating character (delimiter) is a space.

'''Note''' that token strings can be anything, and you could delimiter them with every character that exist (but only '''one''' character).

== What are they good for ==

In a line like ''This is just a little line'' each word represents a token if you separate them with a space. The space in this case is called the 'delimiter'.

If you want to, for example, get the third and fourth word from the above line, you could do it with [[$gettok]] and by using space as the delimiter. If you have a line like ''My brothers are called Bob, David, Elton, Joe, Jack, Tim'' you could get the names of the third and fourth brother easily with token idenfifiers. Without token identifiers it would be painful to find the names automatically.

== Appearance in mIRC ==
You will see tokens in three categories:
*[[:Category:Events|Events]] ([[$1-]], [[$0]], etc.)
*[[Tokenize|/tokenize]]
*Token Identifiers

[[Category:Identifiers]]

$sockbr

2007-05-03T21:50:21Z

Microbe: added category

$sockbr is set to the number of bytes read by a [[Sockread|/sockread]] command. It is used to test whether any information was in fact read from the buffer.

'''Example'''
on 1:sockread:testing:{
if ([[$sockerr]] > 0) [[return]]
:nextread
sockread %temp
if ($sockbr == 0) return
if (%temp == [[$null]]) %temp = -
echo 4 %temp
goto nextread
}

[[Category:socket]]

If-Then-Else

2007-05-03T21:45:13Z

Microbe: added info, mostly about !=

__NOTOC__
The If-then-else statement allows you to compare values and execute different parts of a script based on that comparison. This is a basic structure for any script that includes anything more than one-liners!

if (v1 operator v2) { commands1 }
elseif (v1 operator v2) { commands2 }
else { commands3 }

If the first statement (line) is [[$true]], commands inside the first brackets are executed. If the first if-statement returns [[$false]], script starts looking for an elseif-statement. An elseif-statement is only triggered if the group's if-statement returned $false before. And at last, if none of the if or elseif statements were triggered, commands in else-statement are executed.

One if structure/group can consist of one main if-statement, after it there can be 0 .. N elseif-statements. There can be only one else, which can be understood as the default statement, if none one before were triggered. There doesn't need to be else-statement though.

Every if statement is handled separatly and none of others affect in another.

if (A) { ... }
elseif (B) {
if (C) { ... }
elseif (D) { ... }
elseif (E) { ... }
else { F }
}
elseif (G) { ... }
else { H }

If structure would be hierarchical represented it would look something like this

A If A is true, execute its commands and skip the rest
B If B is true,
\
C check if C, D or E returns true
D
E
F If none of these got triggered, return F
G If A and B were false and G is true, execute this
H If A, B and G were all false, execute H

== The Operators ==

[[#==|==]] equal to
[[#==|===]] equal to (case-sensitive)
[[#<|<]] less than
[[#>|>]] larger than
[[#<=|<=]] less than or equal to
[[#>=|>=]] larger than or equal to
[[#//|//]] v2 is a multiple of v1
[[#\\|\\]] v2 is not a multiple of v1
[[#&|&]] bitwise comparison

[[#isin|isin]] string v1 is in string v2
[[#isin|isincs]] string v1 is in string v2 (case sensitive)
[[#iswm|iswm]] wildcard string v1 matches string v2
[[#iswm|iswmcs]] wildcard string v1 matches string v2 (case sensitive)
[[#isnum|isnum]] number v1 is a number in the range v2 which is in the form n1-n2 (v2 optional)
[[#isletter|isletter]] letter v1 is a letter in the list of letters in v2 (v2 optional)

[[#isalnum|isalnum]] text contains only letters and numbers
[[#isalpha|isalpha]] text contains only letters
[[#islower|islower]] text contains only lower case letters
[[#isupper|isupper]] text contains only upper case letters

[[#ison|ison]] if v1 is on channel v2
[[#isop|isop]] if v1 is an op on channel v2
[[#ishop|ishop]] if v1 is a halfop on channel v2
[[#isvoice|isvoice]] if v1 has a voice on channel v2
[[#isreg|isreg]] if v1 is a normal nick on channel v2
[[#ischan|ischan]] if v1 is a channel which you are on.
[[#isban|isban]] if v1 is a banned address in the internal ban list for channel v2

[[#isaop|isaop]] if v1 is a user in your auto-op list for channel v2 (v2 optional)
[[#isavoice|isavoice]] if v1 is a user in your auto-voice list for channel v2 (v2 optional)
[[#isignore|isignore]] if v1 is a user in your ignore list with the ignore switch v2 (v2 optional)
[[#isprotect|isprotect]] if v1 is a user in your protect list for channel v2 (v2 optional)
[[#isnotify|isnotify]] if v1 is a user in your notify list.

''Note:'' To negate an operator you can prefix it with an exclamation mark (!).

=== == ===
if (cat == cAt) ;Returns true since == is case-insensitive.
if (cat === cAt) ;Returns false since === is case-sensitive.
The above checks that v1 (cat) matches v2 (cAt).

=== != ===
This isn't actually an operator, but a combination of two operators ! and =. And actually, = isn't an operator either, but in mIRC scripting it can be used instead of == and it works just the way == works. In most mIRC scripts you only see !=, which actually shouldn't be used. Instead, !== should be used to negate ==.

if (cat != cAt) ;Returns false since != is case-insensitive and both values v1 and v2 are equal.
if (cat !== caT) ;Returns false since !== is the same as !=
if (cat !=== cAt) ;Returns true since !=== is case-sensitive and both values v1 and v2 are not equal when case is taken in to consideration.

=== < ===
if (6 < 9) ;Returns true because the numerical value 6 is less than 9.
Checks that v1 (6) has a lower numerical value than v2 (9)

=== > ===
if (6 > 9) ;Returns false because the numerical value 6 is not greater than 9.
Checks that v1 (6) has a higher numerical value than v2 (9)

=== <= ===
if (6 <= 9) ;Returns true because the numerical value 6 is less than or equal to 9.
Checks that v1 (6) has a lower or equal numerical value than v2 (9).

=== >= ===
if (6 >= 9) ;Returns false because the numerical value 6 is not greater than or equal to 9.
Checks that v1 (6) has a greater or equal numerical value than v2 (9).

=== // ===
if (3 // 9) ;Returns true because 3 is a multiple of 9.
Multiples of 9 are numbers that when devided in to 9 result in an integer.
You are not limited to positive numbers.

=== \\ ===
if (3 \\ 9) ;Returns false because 3 is a multiple of 9.
\\ is the negate of //

=== & ===
if (N1 & N2) ; This will compare the bits that are [[$biton|turned on]] in the decimal N1 AND N2 in the same way [[$and]]() would.
As long as N1 and N2 share atleast 1 bit the condition is returned as true.

if (13 & 11) ;Is true, see the table below for explanation.
echo -ag $and(13,11) ;returns 9.

If you break down 13 and 11 into their bits as below:
{|class="gallery"
|-
| style="width:100px" | '''''Binary''''' || '''''Value'''''
|-
| 1101 || 13
|-
| 1011 || 11
|-
| style="border:1px dotted #2f6fab; color: Black;" | 1001 || style="border:1px dotted #2f6fab; color: Black;" | 9
|}
if (11 & 4) ;Is false.
echo -ag $and(11,4) ;returns 0.
{|class="gallery"
|-
| style="width:100px" | '''''Binary''''' || '''''Value'''''
|-
| 1011 || 11
|-
| 0100 || 4
|-
| style="border:1px dotted #2f6fab; color: Black;" | 0000 || style="border:1px dotted #2f6fab; color: Black;" | 0
|}
Above you can see, 13 and 11 both have the first bit AND fourth bit on, so the statement is true. The binary 1001 value has a decimal value of 9.
Also you can see, 11 and 4 do not share any common bits, so the statement is false.

=== isin ===
if (cat isin [[$1-]])
Matches for "a ''cat''", "''cat''alog", "impli''cat''e " and any string where "cat" '''is in'''.

=== iswm ===
iswm stands for ''is wildcard match''.

Operators:
* 0 or more characters
? 1 character
& 1 word (atleast 1 or more non-space characters)

if (home*away*lost iswm $1-)
This would match anything starting with home and ending in lost, with away being between home and lost.
It would match, "homeawaylost", "home away lost", "home is missed when you are away or lost", etc.

if (ca?* iswm $1-)
Requires one character after "ca" and allows 0 or more character after it. So it would match for cat, cab, cabin etc.

if (I & you iswm $1-)
Matches any string that consists of "I + one word + you".
Examples would be, "I love you", "I hate you", "I moo you", it would not however match, "I don't love you" since "don't love" contains a space.

=== isnum ===

if ($1 isnum) ;Returns true if $1 is of numeric value
if ($1 isnum 10-) ;Returns true if $1 is number higher than 10
if ($1 isnum 20-30) ;Returns true if $1 is a number between 20 and 30

The examples above checks $1, to see;

Is it a number?<br />
Is it a number above 10?<br />
Is it a number between 20 and 30?

=== isletter ===

if ($1 isletter) ;Returns true if ''$1'' is a letter, any letter
if ($1 isletter abcdefg) ;Returns true if ''$1'' is in the string of letters ''abcdefg''
if ($1 isletter HelloWorld) ;Returns true if ''$1'' is in the string of letters ''HeloWrd''

* Note that the checking is case-sensitive, the letter ''h'' will not return true if checked against the string ''HelloWorld''.

=== isalnum ===
if (Dana34 isalnum) ;returns true as ''Dana34'' contains letters and numbers only
if (Dana_ isalnum) ;returns false as ''_'' is neither letter nor number

Matches whether the string consists of letters and numbers only.

=== isalpha ===
if (Dana isalpha) ; returns true as ''Dana'' consists of letters only
if (foo42 isalpha) ; returns false as ''42'' is no letter

Isalpha checks whether the word consists of letters only. It doesn't matter whether there are upper or lower case.

=== islower ===
if (moo islower) ; returns true as all letters in ''moo'' are lower case.
if (m0o islower) ; returns true as well as all letters in ''m0o'' are lower case.
if (mooO islower) ; retursn false as there is an upper ''O'' in ''mooO''.
'''Note''' that islower checks whether all letters in the string are lower case. There can still be numbers or other characters in the string $1.

=== isupper ===
if (MOO isupper) ; returns true as ''MOO'' consists of upper case letters only
if (1234 isupper) ; returns true as all letters in ''1234'' are upper case, as there are none.
'''Note''' that it checks whether all letters in $1 are upper case. There can still be numbers or other characters in $1.

=== ison ===
if (Dana ison #help.script) ; returns true as ''Dana'' is in the channel #help.script
if (foo !ison #help.script) ; returns true as ''foo'' is not in #help.script

This checks whether $1 is in the channel $2. Note that you need to be in the same channel to use this.

=== isop ===
if (Dana isop #help.script) ; returns true as ''Dana'' is an operator in #help.script
if (foo isop #help.script) ; returns false as ''foo'' is no operator in #help.script

Checks whether $1 is an operator in $2. Note that you need to be in the same channel to use this.

=== ishop ===
if (moo ishop #mIRC) ; returns true if ''moo'' is an half operator in #mIRC
'''Note''' that QuakeNet does not support halfops. Note also that you need to be in the same channel to use this.

=== isvoice ===
if (Dana isvoice #help.script) ; returns true as ''Dana'' has voice in #help.script.
if (foobar isvoice #help.script) ; returns false as ''foobar'' has no voice in #help.script.
This checks if $1 has voice in $2 or not. Note that you need to be in the same channel to use this.

=== isreg ===
if (Dana isreg #help.script) ; returns false as Dana is no regular user in #help.script.
if (foobar isreg #help.script) ; returns true as foobar is a regular user in #help.script.
This checks whether $1 is a regular user (no voice, no half operator, no operator) in $2. Note that you need to be in the same channel to use this.

=== ischan ===
if (#help.script ischan) ; returns true as you are in #help.script.
if (#foobar ischan) ; returns false as you are no in #foobar.
'''Note''' that it returns true only if you are in this channel.

=== isban ===
if (idiot!*@* isban #mychan) ; returns $true if ''idiot!*@*'' is in your [[:Category:IBL|Internal Ban List]] for the channel #mychan.
if ($ial($me) isban $chan) ; returns $true if you are banned on the current channel.
'''Note''' that isban performs two different checks, depending on whether v1 contains wildcards or not:
* if v1 contains wildcards, isban will return $true if v1 is an exact ban in the IBL;
* if v1 does not contain wildcards, isban will return $true if one or more bans match that address.

=== isaop ===
if (foobar isaop) ; returns true if ''foobar'' is in your autoop list for any channel.
if (foobar isaop #help.script) ; returns true if ''foobar'' is in your autoop list for #help.script.
To put someone in your autoop-list, take a look at [[Aop|/aop]].

=== isavoice ===
if (foobar isavoice) ; returns true if ''foobar'' is in your autovoicelist for any channel.
if (foobar isavoice #help.script) ; returns true if ''foobar'' is your autovoicelist for #help.script.
To put someone in your autovoicelist, take a look at [[Avoice|/avoice]].

=== isignore ===
if (foobar isignore) ; returns true if ''foobar'' is in your ignore list.
if (foobar isignore c) ; returns true if ''foobar'' is in your ignore list with switch -c.
To get a more in detail explanation of these switches, take a look at [[Ignore|/ignore]].

=== isprotect ===
if (foobar isprotect) ; returns true if ''foobar'' is in your protect list.
if (foobar isprotect #help.script) ; returns true if ''foobar'' is in your protect list for #help.script.
To get more information about protection, see [[Protect|/protect]].

=== isnotify ===
if (Dana isnotify) ; returns true if Dana is in your notify list.
Take a look at [[Notify|/notify]] to add someone to your notifylist. If someone in your notifylist connects (disconnects), the [[On_notify|On notify event]] ([[On_unotify|On Unotify event]]) is triggered.

== Combining comparisons ==

You can combine comparisons by using the && for AND and || for OR characters.

[[var]] %c = 5
if (%c < 6) && (%c > 0) ; returns true because %c is both, smaller than 6 and greater than 0
if (%c < 6) || (%c isalpha) ; returns true because %c is lower than 6.
; note that %c is not alphapetical and returns false, but || matches for 1 .. N true values.
if (%c < 6) && (%c isalpha) ; returns false
if (%c < 6) && (%c !isalpha) ; ! negates the operator, this this returns true

== Notes ==
====''Not all comparations need two parameters''====
if ($1- isupper)
returns true, if $1- only contain uppercase letters. So ABCD returns true, but even one lowercase letter makes it return false.

====''Use parenthesis right''====
(A) || (B) && (C) <- logical order for this is to check if either one of A or B is true, and C is true, but if you wish to check that B and C must be true, or A is true, you'll need to do (A) || ((B) && (C))

====''This article covers only if-then-else '''string''' operators''====
You '''can't''' use
if (foo isin test.txt)
To check content of text-files. You can use [[$read]] instead to read the content of a text file and then use the return value returned by that $read.

== Also see ==
* [[$v1]] & [[$v1|$v2]] These identifiers allow you to retrieve the values of the last if condition.

[[Category:Commands]]

Noop

2007-04-18T18:30:08Z

Microbe: Added as new

Noop is a command that does literally nothing and doesn't care about any parameters.

/noop

What is it good for, then?

It is a handy command when you need to evaluate some identifier without using the actual result. For example, you may want to evaluate a [[$regex]] identifier without using the information how many results it returns, just to later use the back-references it creates. Another example is [[$findfile]] which has a command option in itself, and therefore doesn't need any outside commands to handle its results.

For example:
noop $regex(I have 6 brothers,/I have (\d+) brothers/) | [[echo|echo -ag]] The number of brothers is [[$regml|$regml(1)]]

[[Category:Commands]]

Category:Members

2007-04-08T14:52:43Z

Microbe: Moved Blackshroud to be a wiki editor

Category:Members

2007-04-08T14:47:57Z

Microbe: Added Aca20031 and capitalized his name

Category:Members

2007-04-08T14:42:12Z

Microbe:

Status window

2007-04-08T14:30:50Z

Microbe:

In mIRC, status window is the window that is first displayed for every connection. Its titlebar contains usually stuff like your nick, user modes, network, server you are connected to and connection time.

Nothing typed in the status window's editbox can accidentally be posted to a channel, so status window is the right place for all sensitive commands (like authing).

Map

2007-04-08T14:24:35Z

Microbe: Added as new

Displays a "graphical" map of the network.

/map

Displays a treebar style version of how the network's servers are connected to each other. Used mostly for routing purposes.

'''Note:''' you can use this command only if you are [[Oper|opered up]].

[[Category:Oper commands]]

Rehash

2007-04-08T14:19:53Z

Microbe: Added as new

The rehash command tells the server to reload its configuration file.

/rehash

'''Note:''' you can use this command only if you are [[Oper|opered up]].

[[Category:Oper commands]]

Oper

2007-04-08T14:06:40Z

Microbe: Added as new.

This command set you as an IRC Operator in the network.

/oper <name> <password>

For the opering to be succesful, you must be added to the IRC server's configuration file as an oper. Whether you get to be a local or a global oper depends on the settings in the configuration file.

== What can an oper do ==

IRC Operators (opers or ircops) are there to help their network admininstrator to maintain the servers and the network.

'''Local opers''' have the power to
* Reconnect their server to the network
* [[Kill|/Kill]] anyone from their server (disconnect from the network)
* Set [[K-line|K-lines]] on their server (ban someone from the server)
* See all available information of users on the oper's own server
* Manage channels to some extent, depending on the server configuration

'''Global opers''' have the power to
* Reconnect any server to the network
* /Kill anyone from any server
* Set K-lines on all servers in the network and set [[G-line|G-lines]] (a K-line on all servers)
* See all available information on users on every server
* Usually manage all channels without restrictions, depending on the server configuration

So basically a global oper can do for any server what a local oper can do only for his own server. In theory, all of the actions in the above lists could be denied from both local and global opers by modifying the server configuration, but this would make opers rather pointless to have. Depending on the network, opers can also control the network services to some extent.

=== Opers in QuakeNet ===

All opers in QuakeNet are global opers. They can control all the services that are available to users and have access to other services that help them keeping the network clean.

== See also ==

* [[:Category:Oper commands|Oper commands]] for commands available only for opers

[[Category:IRC]]

User:Microbe

2007-03-31T20:26:10Z

Microbe: Yearly update

{{Babel-4|fi|en-3|sv-2|fr-2}}

<table border="0">
<tr>
<td>[[Image:Microbe.jpg]]</td>
<td>
<table border="0">
<tr><td><b>Name</b></td><td>Lauri Peltonen</td></tr>
<tr><td><b>Age</b></td><td>24</td></tr>
<tr valign="top" height="40"><td><b>Country</b></td><td>Finland</td></tr>

<tr><td><b>Words of wisdom</b></td><td>Still searching wisdom.</td></tr>
</table>
</td>
</tr>
</table>
[[Category:Members]]

Filter

2007-02-07T12:02:53Z

Microbe: added some lil info

This command scans lines of text in a window or file and if any of them contain matchtext, they are written out to another window or file which you can then use.
/filter [-asdfkwxnpriocteubglLz] [n-n2] [c s] <infile | dialog id> <outfile | dialog id | alias> [alias] [matchtext]

The explanation of all switches at first:

{| style="width:100%"
|-
| '''''Switch''''' || '''''Meaning'''''
|-
| a || sorts filtered lines by calling the optional [alias]. The alias is passed two lines in $1 and $2, it must compare these and return -1, 0, or 1 to indicate relative sort order of these lines to each other. This can't be used with the t switch.
|-
| s || makes the status window the infile.
|-
| d || makes the single message window the infile.
|-
| f || tells mIRC that the infile is actually a file.
|-
| k || indicates that you have specified an <alias> as the output instead of a window name. The alias will be called with the result of each filtered line.
|-
| w || tells mIRC that the infile is actually a window.
|-
| x || excludes matching lines.
|-
| n || prefixes lines with a line number.
|-
| p || wraps the text output in a custom window.
|-
| r || specifies the range of lines n to n2 for filtering.
|-
| i || indicates that you have provided a [dialog id] custom dialog control as the input.
|-
| o || indicates that you have provided a [dialog id] custom dialog control as the output.
|-
| c || clears the output window/file before writing to it.
|-
| t || sorts the output based on [c s], column C (number) using character S (ascii-code) as the columns separator. This can't be used with the a switch.
|-
| e || specifies a descending sort.
|-
| u || specifies a numeric sort.
|-
| b || strips BURK codes when matching text.
|-
| g || indicates that matchtext is a regular expression.
|-
| l || filters from the side-listbox in the first window.
|-
| L || filters from the side-listbox in the second window
|-
| z || retains line colors when filtering between custom windows.
|}

'''Note''' that you can filter blank lines by specifying $crlf for the matchtext.

The $filtered identifier is filled with the number of matches found, if any.

Some important facts about /filter:
* If you specify an window as output, it has to be created '''first'''. mIRC will not create one. Contrary to that, mIRC will create files, if they do not exist.
* If no matchtext is specified, all lines with be copied.
* The specied windows / files must be in the correct order (-fw copies from file to window, -wf from window to file).
== Example ==
For some of the examples, you will need:
* a custom window. Open it with [[Window|/window]] -e @filtertest
* a text file. Make a blank one with [[Write|/write]] -c filtertest.txt

=== Simple copying from files and windows ===
; This will copy your entire mIRC.ini in the @filtertest window.
filter -fw mIRC.ini @filtertest
; creates another window called @filtertest2, then copies only lines from @filtertest that begin with a open square bracket [.
[[window]] @filtertest2 | filter -ww @filtertest @filtertest2 [*

; Copies the entire versions.txt to your filtertest window, with clearing it before.
filter -cfw versions.txt @filtertest
; Copies all lines with ''change'' in it to @filtertest, with clearing it before again.
filter -cww @filtertest @filtertest *change*

=== Filtering lines ===
; This will filter every line in the Status Window that ends with "Unknown command." into a file called unknown.txt
filter -sf unknown.txt *Unknown command.

; Loads all lines from versions.txt into the Status Window
filter -fs versions.txt anytext

; Filter only lines 56 to 87 of versions.txt to the Status Window
filter -rfs 56-87 versions.txt anytext

=== Excluding text ===
; Filters all lines from #help.script to our @filtertest window but exclude lines that contain "you suck"
filter -cxww #help.script @filtertest *you suck*

; Remove all lines from #help.script.log that start with -AnnoyingNoticer-.
; Note that ''ff'' tells mIRC that we want to filter the files, not the channel window.
filter -cxff #help.script.log #help.script.log -AnnoyingNoticer-*

=== Filtering Dialogs ===
; Save the contents of a listbox ID 3 in a dialog called "jukebox" to favorites.txt, making sure the text file is cleared before outputting to it
filter -cif jukebox 3 favorites.txt

; Example 28: Another similar song list, this time we don't want to save the songs that are in C:\Music\Awful\
filter -xcif jukebox 3 favorites.txt *C:\Music\Awful\*

=== Filtering nicklist ===
; Filter the nicklist in the channel #help.script to a custom window called @#help.script_filter
filter -lw #help.script @#help.script_filter

=== Filtering with custom alias ===
; lets make a little alias comparing two numbers
[[alias]] sortnumber {
[[return]] [[$iif]]([[$1-|$1]] > $2, 1, $iif($1 == $2,0,-1))
}

; now let's fill a window with 1000 random numbers
[[var]] %i = 1
; lets loop from 1 to 1000
[[while]] (%i <= 1000) {
; and add a random number to the window
aline @filtertest $rand(1,999999)
[[inc]] %i
}
; lets make a second custom window
[[window]] @filtertest2
; now lets sort all the numbers and put them to the new window
filter -aww @filtertest @filtertest2 sortnumber

=== Filtering a scoreboard file ===
Lets say this is our scoreboard.txt file:
Albie 666 Ave IT :f
Dana 123 I'm the queen!
Q 690 I love my 69...0
God 34 I wish I was Albie
G 1 I wish i was dana :<
Fishbot 17 Fish go moo.
First is the nick, then their score, followed by their comment.

filter -tffceu 2 32 scoreboard.txt scoreboard.txt

The output now looks like this, with the highest score on top (Q with 690) and the lowest on the bottem (G with 1):
Q 690 I love my 69...0
Albie 666 Ave IT :f
Dana 123 I'm the queen!
God 34 I wish I was Albie
Fishbot 17 Fish go moo.
G 1 I wish i was dana :<

==== ''Explanation'' ====
*The -t flag means that filter will sort using the options ''2 32''. The second token, delimited by ascii 32 (space)
*The -ff flags mean the input and output is both scoreboard.txt, which is a filename.
*The -c clears the output target before writing the output.
*The -eu mean sort numerically (u) in descending order (e).
[[Category:Commands]]

While loops

2007-01-27T13:35:28Z

Microbe: mostly modified links

==While loops==

While loops allow you to repeat a set of commands while the expression inside the brackets is [[$true]].

while (expression) { commands }

The expression is evaluated in the same manner as [[If-Then-Else]] expressions are evaluted and it uses the same operators. If the expression is $true the commands inside the brackets are run while the expression remains $true.

You can break out of the while loop by issuing the [[break]] command, or jump to the start of the while loop by issuing the [[continue]] command.

Every time the while loop jumps back to the top, the expression is re-evaluated.

'''Note:''' If the expression evaluation changes to [[$false]] during the while loop you will not break out of the while loop until the while loop has reached the end of its contents.
== Examples ==

Example shows how to get a list of users in the channel:
[[var]] %i = [[$nick]](#,0) ;Sets ''%i'' to the amount of users in the channel.
while (%i) {
var %nick = $nick(#,%i) ;Find the ''n<sup>th</sup>'' user in the channel.
var %people = [[$addtok]](%people,%nick,44) ;Add ''%nick'' to ''%people'' using [[$chr]](44) (a comma) as the delimiter.
[[dec]] %i
}
[[echo]] -ag Current channel users: %people

Example shows how to loop through all channels and echo the number of people in these channels.
var %i = 1
; loop from 1 to total number of channels
while (%i <= [[$chan]](0)) {
; echo it
echo -ag Channel: $chan(%i) Nicks: $nick($chan(%i),0)
; increase looping variable
inc %i
}

Example shows how to loop though from 1 to 50:
var %from = 1
var %to = 50
while (%from <= %to) {
echo -ag I know I can count to %from
[[inc]] %from
}

Example shows how to use the break command:
var %i = 1
while (%i) {
echo -ag [[$chr]](37) [[DollarPlus|$+]] i = %i
if (%i == 10) { break } ;If ''%i'' has a value of ''10'' then exit the while loop, missing out any commands still left to be executed inside the while loop.
inc %i
}

Example shows how to use the continue command. It will echo everything from 1 to 10 except 5, as it jumps to the begin of the loop before coming to the echo command.
var %i = 0
while (%i < 10) {
inc %i
if (%i == 5) { continue } ;If ''%i'' has a value of ''5'' then jump to the start of the while loop, missing out the echo below.
echo -ag $chr(37) $+ i == %i
}

Example shows how to loop through a text file. Let's assume we have a "foo.txt" looking like
This is line1
This is line2
This is line3

To loop through it, you'd have to use:
var %i = 1
; $lines returns the total number of lines in a file
while (%i <= [[$lines]](foo.txt)) {
echo -a [[$read]](foo.txt,%i)
inc %i
}
== See Also ==
* [[If-Then-Else]]

[[Category:Commands]]

Custom Windows

2006-11-23T23:06:18Z

Microbe: NOW continued a bit. hopefully works.

{{Stub}}

Custom windows are windows that can be created by the user and modified to look like almost anything. They can play any type or a role you wish: they can for example replace normal channel windows or they can be used to filter messages from queries.

'''/window [-abBcCdeEfg[N]hikl[N]mnoprRsvwxz] [-tN,..,N] [+bdeflLmnstx] <@name> [x y [w h]] [/command] [popup.txt] [font [size]] [iconfile [N]]'''

Explanations of the different switches:

a = activate the window
b = update horizontal scrollbar width for listbox (TODO: better explanation?)
B = prevent the window from using an internal border
c = close the window
C = center window when first created
d = open the window as a desktop window
D = allows toggling of the window between mirc window and desktop
e = add a single-line editbox to the window
E = add a multi-line editbox to the window
f = indicates that w h are the required width and height of the text display area as opposed to the window's size (TODO: huh?)
g[N] = sets/removes hilight for a window button, 0 = none, 1 = message color, 2 = hilight color. Default = TODO?
h = hide window button from the switchbar. The window can still be modified and closed normally. To reverse, use -w or -z.
H = enables auto-hide for a side-listbox (TODO: huh?)
i = dynamically associate with whatever happens to be the active connection (TODO: huh?)
k[N] = hides the @ prefix in the window name, 0 = hide prefix, 1 = show prefix. Default = 0.
l[N] = listbox, if N is specified then a side-listbox N characters wide is created. If no N is given, the default size is used.
m = allow line marker to be used in window. The line marker can be turned on by Ctrl+L.
n[N] = minimize window, 2 = minimize without auto-expanding item in treebar (TODO: huh?)
o = if opened on desktop, place ontop of all other desktop windows
p = creates a [[Picture_Windows|picture window]]
r = restore window (TODO: huh?)
R = reset window's size and position to previously saved values
s = sort the main window, whether text or listbox (TODO: alphabetically or what?)
S = sort the side-listbox (TODO: ...)
u = if the window was created with -o, remove ontop setting of the window
v = close window when associated status window is closed (TODO: huh?)
w[N] = where 0 = hide from switchbar/treebar, 1 = show in switchbar, 2 = show in treebar, 3 = show in both (TODO: Default?)
x = maximize window
z = place window button at the end of the switchbar
t[N,...,N] = tab positions in a listbox. If text contains tabs it will be spaced out according to these tab settings (TODO: doesn't explain anything?)

The switches that start with + are used to change the appearance of the window:

b = use a border
d = don't use a border
e = 3d edges
f = dialog frame (make it look more like a dialog)
l = tool window (TODO: huh? can't remember)
L = tool window but window won't appear in taskbar (TODO: ...)
n = minimize box (TODO: what box?)
s = make the window sizable
t = add only the "x" button to the upper right corner
x = maximize box (TODO: what box?)

'''Note:''' some switches may automatically turn other switches on/off.

The rest of the command options:

@name = window name (must prefix with a @ even if the @ would be left out from its title)
x,y,w,h = position in x-axis, position in y-axis, width, height
popup.txt = popup filename to be used for the window, loaded when needed (must be a plain non-ini text file)
/command = default command (executed whenever you enter text in an editbox) (TODO: in any editbox or?)
font/size = font name and size to be used in the window (defaults to status window font)
iconfile/N = sets the titlebar icon for the window

'''Note:''' if you use -1 for any of the x,y,w,h values, the default value is used unless the window already exists in which case the current value is used.

It isn't easy to understand what all of these switches are for. If you are new to custom windows, you should simply try them out and see what they do. Pretty fast you will be able to make the window look like what you want it to.
When you have created a window that looks what you want it to look like, the next step is to add functionality and content to it.

Custom Windows

2006-11-23T23:02:44Z

Microbe: Reverted edit of Microbe, changed back to last version by Cail

{{Stub}}

Custom windows are windows that can be created by the user and modified to look like almost anything. They can play any type or a role you wish: they can for example replace normal channel windows or they can be used to filter messages from queries.

'''/window [-abBcCdeEfg[N]hikl[N]mnoprRsvwxz] [-tN,..,N] [+bdeflLmnstx] <@name> [x y [w h]] [/command] [popup.txt] [font [size]] [iconfile [N]]'''

Explanations of the different switches:

a = activate the window
b = update horizontal scrollbar width for listbox (TODO: better explanation?)
B = prevent the window from using an internal border
c = close the window
C = center window when first created
d = open the window as a desktop window
D = allows toggling of the window between mdi and desktop (TODO: what's this?)
e = add a single-line editbox to the window
E = add a multi-line editbox to the window
f = indicates that w h are the required width and height of the text display area as opposed to the window's size (TODO: huh?)
g[N] = sets/removes hilight for a window button, 0 = none, 1 = message color, 2 = hilight color. Default = TODO?
h = hide window button from the switchbar. The window can still be modified and closed normally. To reverse, use -w or -z.
H = enables auto-hide for a side-listbox (TODO: huh?)
i = dynamically associate with whatever happens to be the active connection (TODO: huh?)
k[N] = hides the @ prefix in the window name, 0 = hide prefix, 1 = show prefix. Default = 0.
l[N] = listbox, if N is specified then a side-listbox N characters wide is created. If no N is given, the default size is used.
m = allow line marker to be used in window. The line marker can be turned on by Ctrl+L.
n[N] = minimize window, 2 = minimize without auto-expanding item in treebar (TODO: huh?)
o = if opened on desktop, place ontop of all other desktop windows
p = creates a [[Picture_Windows|picture window]]
r = restore window (TODO: huh?)
R = reset window's size and position to previously saved values
s = sort the main window, whether text or listbox (TODO: alphabetically or what?)
S = sort the side-listbox (TODO: ...)
u = if the window was created with -o, remove ontop setting of the window
v = close window when associated status window is closed (TODO: huh?)
w[N] = where 0 = hide from switchbar/treebar, 1 = show in switchbar, 2 = show in treebar, 3 = show in both (TODO: Default?)
x = maximize window
z = place window button at the end of the switchbar
t[N,...,N] = tab positions in a listbox. if text contains tabs it will be spaced out according to these tab settings

The switches that start with + are used to change the appearance of the window:

b = use a border
d = don't use a border
e = 3d edges
f = dialog frame (make it look more like a dialog)
l = tool window (TODO: huh? can't remember)
L = tool window but window won't appear in taskbar (TODO: ...)
n = minimize box (TODO: what box?)
s = make the window sizable
t = add only the "x" button to the upper right corner
x = maximize box (TODO: what box?)

'''Note:''' some switches may automatically turn other switches on/off.

The rest of the command options:

@name = window name (must prefix with a @ even if the @ would be left out from its title)
x,y,w,h = position in x-axis, position in y-axis, width, height
popup.txt = popup filename to be used for the window, loaded when needed (must be a plain non-ini text file)
/command = default command (executed whenever you enter text in an editbox) (TODO: in any editbox or?)
font/size = font name and size to be used in the window (defaults to status window font)
iconfile/N = sets the titlebar icon for the window

'''Note:''' if you use -1 for any of the x,y,w,h values, the default value is used unless the window already exists in which case the current value is used.

Custom Windows

2006-11-23T23:01:14Z

Microbe: continued a bit

Custom Windows

2006-11-23T22:41:44Z

Microbe: Start for custom windows page

{{Stub}}

Custom windows are windows that can be created by the user and modified to look like almost anything. They can play any type or a role you wish: they can for example replace normal channel windows or they can be used to filter messages from queries.

'''/window [-abBcCdeEfg[N]hikl[N]mnoprRsvwxz] [-tN,..,N] [+bdeflLmnstx] <@name> [x y [w h]] [/command] [popup.txt] [font [size]] [iconfile [N]]'''

Explanations of the different switches:

a = activate the window
b = update horizontal scrollbar width for listbox (TODO: better explanation?)
B = prevent the window from using an internal border
c = close the window
C = center window when first created
d = open the window as a desktop window
D = allows toggling of the window between mdi and desktop (TODO: what's this?)
e = add a single-line editbox to the window
E = add a multi-line editbox to the window
f = indicates that w h are the required width and height of the text display area as opposed to the window's size (TODO: huh?)
g[N] = sets/removes hilight for a window button, 0 = none, 1 = message color, 2 = hilight color. Default = TODO?
h = hide window button from the switchbar. The window can still be modified and closed normally. To reverse, use -w or -z.
H = enables auto-hide for a side-listbox (TODO: huh?)
i = dynamically associate with whatever happens to be the active connection (TODO: huh?)
k[N] = hides the @ prefix in the window name, 0 = hide prefix, 1 = show prefix. Default = 0.
l[N] = listbox, if N is specified then a side-listbox N characters wide is created. If no N is given, the default size is used.
m = allow line marker to be used in window. The line marker can be turned on by Ctrl+L.
n[N] = minimize window, 2 = minimize without auto-expanding item in treebar (TODO: huh?)
o = if opened on desktop, place ontop of all other desktop windows
p = creates a [[Picture_Windows|picture window]]
r = restore window (TODO: huh?)
R = reset window's size and position to previously saved values
s = sort the main window, whether text or listbox (TODO: alphabetically or what?)
S = sort the side-listbox (TODO: ...)
u = if the window was created with -o, remove ontop setting of the window
v = close window when associated status window is closed (TODO: huh?)
w[N] = where 0 = hide from switchbar/treebar, 1 = show in switchbar, 2 = show in treebar, 3 = show in both (TODO: Default?)
x = maximize window
z = place window button at the end of the switchbar

(TODO: Someone explain -t)

The switches that start with + are used to change the appearance of the window:

b = use a border
d = don't use a border
e = 3d edges
f = dialog frame (make it look more like a dialog)
l = tool window (TODO: huh? can't remember)
L = tool window but window won't appear in taskbar (TODO: ...)
n = minimize box (TODO: what box?)
s = make the window sizable
t = add only the "x" button to the upper right corner
x = maximize box (TODO: what box?)

'''Note:''' some switches may automatically turn other switches on/off.

The rest of the command options:

@name = window name (must prefix with a @ even if the @ would be left out from its title)
x,y,w,h = position in x-axis, position in y-axis, width, height
popup.txt = popup filename to be used for the window, loaded when needed (must be a plain non-ini text file)
/command = default command (executed whenever you enter text in an editbox) (TODO: in any editbox or?)
font/size = font name and size to be used in the window (defaults to status window font)
iconfile/N = sets the titlebar icon for the window

'''Note:''' if you use -1 for any of the x,y,w,h values, the default value is used unless the window already exists in which case the current value is used.

News

2006-11-23T22:03:49Z

Microbe: mIRC 6.21 news

== mIRC 6.21 is out ==
{{newsWriter|[[User:Microbe|Microbe]] 23:03, 23 Nov 2006 (CET)}}

mIRC version 6.21 was just released. Read more about it and download it at [http://www.mirc.com www.mirc.com].

== mIRC 6.2 is out ==
{{newsWriter|[[User:Cail|Cail]] 14:48, 27 Aug 2006 (CET)}}

mIRC 6.2 was released July 28th 2006, get it at [http://www.mirc.com www.mirc.com]. Take a look at the [[MIRC 6.2|list of changes]] aswell.

== Changes to Scriptwiki ==
{{newsWriter|[[User:Microbe|Microbe]] 00:39, 5 May 2006 (CEST)}}

Scriptwiki has gone through some changes, again. It has been made an official QuakeNet wiki and recruiting new editors has been made easier - the process should now be far faster and more user-friendly. So if you're interested in contributing to this wiki, have a look at the front page's instructions.

== mIRC 6.17 is out ==
{{newsWriter|[[User:Microbe|Microbe]] 00:31, 18 Feb 2006 (CET)}}

mIRC version 6.17 has been released an hour ago. Read more about it and download it at [http://www.mirc.com www.mirc.com].

== Scriptwiki has been globalized ==
{{newsWriter|[[User:Microbe|Microbe]] 04:03, 4 Feb 2006 (CET)}}

Scriptwiki has gone through some changes. The project started as a small one-channel project, but it is now released "to the wild". People interested to contribute to this wiki are encouraged to contact us, especially from other networks than QuakeNet. At the moment this wiki is dedicated more towards QuakeNet users, but we are hoping that this will change in the future. Users from every network should be able to get the information they need from here, especially network-specific raw events.

So if you want to contribute to the only wiki dedicated to mIRC scripting (at least at the moment), see the main page for more information.

== Welcome to Scriptwiki ==
{{newsWriter|[[User:Tovrleaf|Tovrleaf]] 22:53, 15 Sep 2005 (CEST)}}

Hi, and welcome to our new published '''Scriptwiki'''. Scriptwiki (as we call it) is our new lifelong project which won't probably ever be finished. It shall be developed and expanded along with mIRC and new scripting skills.

Special thanks to all users who have helped us to get this to shape and to create a more user friendly wiki and articles.

If you think this wiki is missing some essential articles, there's a page to [[Special:Request|request]] new articles for it. And don't forget to give us [[:Special:SendComment|feedback]], comments, ideas or new suggestions.

== Scriptwiki starting ==
{{newsWriter|[[User:Microbe|Microbe]] 12:53, 24 Aug 2005 (CEST)}}

Scriptwiki starting to get in shape

__NOTOC__

Category:Members

2006-10-07T17:39:30Z

Microbe: added Ollie as a new editor

$regml

2006-09-11T09:17:21Z

Microbe: Added a null page

{{Stub}}
[[Category:Regular_Expression]]

$regex

2006-09-11T09:16:57Z

Microbe: added stub

{{Stub}}
[[Category:Regular_Expression]]

$regsub

2006-09-11T09:16:34Z

Microbe: added null page

{{Stub}}
[[Category:Regular_Expression]]

$regsub

2006-09-11T09:15:51Z

Microbe: added null page

[[Category:Regular_Expression]]

$regex

2006-09-11T09:15:03Z

Microbe: added null page

[[Category:Regular_Expression]]

Category:Regular Expression

2006-09-11T09:12:45Z

Microbe: blah

[[Category:MIRC Help]]

Regular Expression basics

2006-09-11T09:09:52Z

Microbe: fixed category

Regular expressions are a powerful tool for searching and replacing patterns in text. They are not among the easiest subjects in mIRC scripting, but once you learn them you can use them in any common coding language (Java, C, Perl, etc). As there are plenty of good websites around that explain regular expressions, it is pointless to start explaining it all in here.

== Links ==
* http://regular-expressions.info/
* http://www.mircscripts.org/showdoc.php?type=tutorial&id=989

[[Category:Regular_Expression]]

Regular Expression basics

2006-09-11T09:07:49Z

Microbe: Added regex basics

How to start

2006-09-11T08:50:55Z

Microbe: added some info here and there

Category:Members

2006-09-10T11:59:35Z

Microbe: added cail to editors list

Q

2006-06-05T20:47:30Z

Microbe: added as new

Q is a service bot on [http://www.quakenet.org QuakeNet] which is meant only for big channels. You can read more about it from the [http://www.quakenet.org/faq/faq.php?c=1 Q FAQ].

Random password generator

2006-06-05T20:44:38Z

Microbe: added category

This script will allow you to generate a random password, of required length and using characters you want to.

; Usage: $pwgen(length,used characters)
; Examples
; $pwgen(10,a-z A-Z)
; $pwgen(20,a-z 0-9 0-9)
; $pwgen(17,0-9 [[$chr]](36) $+ - $+ $chr(41))

[[alias]] pwgen {
; first we check if this alias is used as identifier
if (![[$isid]]) { [[return]] }
; the next part will fill &chars with characters that can be picked to make the password
;
; we cycle the different sets of "used characters"
[[var]] %i = [[$numtok]]($2,32)
[[while]] (%i > 0) {
var %set = [[$gettok]]($2,%i,32)
; if the length of the current set is 3, we assume its the right syntax
[[if]] ([[$len]](%set) == 3) {
; get the ascii values of the two characters
var %asc1 = [[$asc]]([[$left]](%set,1)) , %asc2 = $asc([[$right]](%set,1))
var %j = [[$iif]](%asc1 < %asc2,%asc1,%asc2) , %max = $iif(%asc1 < %asc2,%asc2,%asc1)
; we will loop from the smallest ascii number to the largest
while (%j <= %max) {
; we add the ascii value to the &chars binvar
[[bset]] &chars [[$calc]]([[$bvar]](&chars,0) + 1) %j
[[inc]] %j
}
}
[[dec]] %i
}
;
; now we filled &chars we randomly pick characters out of &chars to make the password
var %i = $iif([[$abs]]([[$int]]($1)) > 900,900,[[$v1]])
; we do this $1 times, as long as its not larger then 900
; (wich is approximate the limit of commands)
while (%i > 0) {
var %pw = %pw $+ [[$mid]](%chars,$rand(1,$len(%chars)),1)
dec %i
}
; and its done
return %pw
}

[[Category:Script Archive]]

Category:MIRC Help

2006-05-05T12:26:53Z

Microbe: added guidelines link

'''mIRC Help''' is based on [[mIRC]]'s own help file.

It basically covers everything what can be found from the original help, but is commented and expanded with wiki staff [[:Category:Members|members]]' knowledge, tutorials and scripting examples.

Syntax used in the help pages (and generally in all scripting/coding in the world):
* [ ] mean an optional parameter.
* < > mean a required parameter.
* a|b means either a or b (sometimes / is used aswell).
* -abc mean the possible switches

Before adding or modifying '''anything''' in here, read the [[Guidelines|general editing guidelines]].

[[Category:mIRC]]

Guidelines

2006-05-05T12:22:29Z

Microbe: clarified some places and removed irrelevant parts

As this wiki is supposed to be very user-friendly, all articles should follow the guidelines listed in here. Please note that we will not accept any articles not following these rules and reserve the right to block your account in case you break these rules repeatedly.

Feel free to ask any editor if you are unsure about specific subjects. To get an example, just take a look at already added articles.

== Guidelines ==

If you wish to add comments to your examples (to the same 'example box') in the article, you can do it either by adding two spaces and a ; (like: echo -a blah ;this is an echo) OR adding the comment to the next line, starting it with a space and a ;. Comments outside the 'example box' shouldn't include the ;.

'''Topic (the name of the page) examples'''
* $variable
* Command
* On_join
* If-Then-Else

'''First line of the text'''
* Short description what it does / what it's good for.
** Example: Returns the Nth token in text. A token is blah blah blah.

'''Second line of the text'''
* The syntax, starting with a space to get a box around it.
** Example: (space)$gettok(text,N,C)

'''Next one/few line(s) of the text'''
* Explanation what the non-trivial parameters mean. The parameter(s) is/are to be inside <nowiki>'' ''</nowiki> to make it italic.
** Example: ''C'' is the [[ascii]] number of the character that is set to separate the tokens blah blah.

'''Next one/few line(s) of the text'''
* Short example(s) how to use the command/identifier/whatever. The (possible) return value is to be inside <nowiki>'' ''</nowiki> to make it italic.
** Example: //echo -a $gettok(this.is.text,2,46) returns ''is''.

'''Sections'''
* If the command/identifier/whatever is complex enough to be needed to demonstrate further, use <nowiki>== Examples ==</nowiki> to start a section with more examples. Remember to add links to other wiki items such as <nowiki>[[var]]</nowiki> for the first occurence in each article. All example lines are to be started with a space and all return values are to be put inside <nowiki>'' ''</nowiki>.

'''Add "See also" and Category'''
* It's good to add a 'see also' section with <nowiki>== See also ==</nowiki> at the end of the article that contains useful links to similar commands/identifiers/whatever. Remember also to add the article to the correct category/categories with adding <nowiki>[[Category:name_of_the_category]] at the end. Like [[Category:Text and Number Identifiers]]</nowiki>.

'''Stubs'''
* If you know your article is incomplete you can add <nowiki>{{Stub}}</nowiki> marking it as incomplete for others/yourself to complete later on. It appears to look the best if you add the <nowiki>{{Stub}}</nowiki> at the top of the page.

'''Shared articles'''
* <nowiki>{{Disambling}}</nowiki> is used to split articles into smaller pieces when article holds reference to more than one article and it's '''not''' unambiguous where it should belong. (For example [[$chan]])

News

2006-05-04T22:39:16Z

Microbe: added news about making the wiki official quakenet wiki

== Changes to Scriptwiki ==
{{newsWriter|[[User:Microbe|Microbe]] 00:39, 5 May 2006 (CEST)}}

Scriptwiki has gone through some changes, again. It has been made an official QuakeNet wiki and recruiting new editors has been made easier - the process should now be far faster and more user-friendly. So if you're interested in contributing to this wiki, have a look at the front page's instructions.

== mIRC 6.17 is out ==
{{newsWriter|[[User:Microbe|Microbe]] 00:31, 18 Feb 2006 (CET)}}

mIRC version 6.17 has been released an hour ago. Read more about it and download it at [http://www.mirc.com www.mirc.com].

== Scriptwiki has been globalized ==
{{newsWriter|[[User:Microbe|Microbe]] 04:03, 4 Feb 2006 (CET)}}

Scriptwiki has gone through some changes. The project started as a small one-channel project, but it is now released "to the wild". People interested to contribute to this wiki are encouraged to contact us, especially from other networks than QuakeNet. At the moment this wiki is dedicated more towards QuakeNet users, but we are hoping that this will change in the future. Users from every network should be able to get the information they need from here, especially network-specific raw events.

So if you want to contribute to the only wiki dedicated to mIRC scripting (at least at the moment), see the main page for more information.

== Welcome to Scriptwiki ==
{{newsWriter|[[User:Tovrleaf|Tovrleaf]] 22:53, 15 Sep 2005 (CEST)}}

Hi, and welcome to our new published '''Scriptwiki'''. Scriptwiki (as we call it) is our new lifelong project which won't probably ever be finished. It shall be developed and expanded along with mIRC and new scripting skills.

Special thanks to all users who have helped us to get this to shape and to create a more user friendly wiki and articles.

If you think this wiki is missing some essential articles, there's a page to [[Special:Request|request]] new articles for it. And don't forget to give us [[:Special:SendComment|feedback]], comments, ideas or new suggestions.

== Scriptwiki starting ==
{{newsWriter|[[User:Microbe|Microbe]] 12:53, 24 Aug 2005 (CEST)}}

Scriptwiki starting to get in shape

__NOTOC__

Main Page

2006-05-04T22:11:48Z

Microbe: changed according to #help.script'ialization

== This Wiki ==

Welcome to QuakeNet's Official Scriptwiki! This wiki provides you with all the necessary information to write your own scripts in mIRC's scripting language, and also offers a number of tutorials and pre-made scripts designed to make your daily life on QuakeNet easier.

In contrast to many other wikis, normal users aren't allowed to make changes to this wiki. This way, we can ensure a certain level of quality. You are totally free to read the material, but if you want to contribute to this wiki, you have to either send an email (including your Q account name and nick) to blackshroud@quakenet.org or ask an [[Members|admin]] on #help.script to add you.

== Script Archive ==

You can find several prefabricated scripts in our [[:Category:Script Archive|Script Archive]], which serve as examples and can be used to build more complex scripts.

== mIRC help ==

If you're not sure how a command or an identifier works, you can check it from our [[:Category:MIRC_Help|mIRC Help]] pages.

== Tutorials ==

Our [[:Category:Tutorials|tutorials]] aim to provide a step-by-step introduction to various mIRC scripting related topics.

------

This wiki is a project launched by [http://script.quakenet.org #help.script] on [http://www.quakenet.org QuakeNet].
__NOTOC__

How to query a CS Server

2006-04-27T11:25:06Z

Microbe: plenty of typos and lil changed wording

If you want to e.g. get the number and names of all player who are currently playing on a CS-server, you have to send a so-called "query" to this server (using UDP) and handle everything the server sends back to you. This isn't as easy as it sounds. At first, you would have to 'learn', or, at least, understand the protocol a CS-server uses (e.g. what do I have to send to the server to get a 'good' reply and what's the structure of this reply). If you want to learn more about these protocols, take a look at http://dev.kquery.com/ or http://www.valve-erc.com/srcsdk/Code/Networking/serverqueries.html.

The following script '''echo'''s the output to your active window. You will have to modify it to be able to use it as 'bot'. It's a more complex script and you don't need to understand it (completely) to be able to use it.

; HL server query snippet by Saturn
;
; usage:
; /hlinfo <ip> <port>
; /hlplay <ip> <port>

; the alias that opens a new socket if you want to get general information about a running CS-server
[[alias]] hlinfo {
; using a dynamic socket name so we can use multiple instances at once
[[var]] %sock = $+(hlinfo-,[[$ticks]])
; actually open the socket
[[sockudp]] -k %sock [[$1]]-2 [[$str]]([[$chr]](255),4) [[DollarPlus|$+]] TSource Engine Query
; closing the socket after 60seconds if there is no response (else it will be closed by another event (see below))
.[[timer]] $+ %sock 1 60 [[sockclose]] %sock
}

; this event will get all data sent back from the server
[[on_udpread|on *:UDPREAD]]:hlinfo-*:{
; save it in a binary variable
[[sockread]] -f &reply

; set some local variables that we will use below
var %offset, %name, %map, %game, %num, %max, %ip, %dir

; following the protocol, this "m" shows us that we queried a Half-Life 1 server
if ($chr([[$bvar]](&reply,5)) == m) {
; Half-Life 1 info reply

%offset = 6

; save the ip
%ip = $bvar(&reply,%offset,128).text
[[inc]] %offset [[$calc]]([[$len]](%ip) + 1)

; the same
%name = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%name) + 1)

; the current map
%map = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%map) + 1)

; the game directory
%dir = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%dir) + 1)

; the name of the game
%game = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%game) + 1)

; current and maximum players
%num = $bvar(&reply,%offset)
%max = $bvar(&reply,$calc(%offset + 1))
}

; else we get data for a CS:Source game
else {
; Source info reply
; we do the same as above
%offset = 7

%name = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%name) + 1)

%map = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%map) + 1)

%dir = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%dir) + 1)

%game = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%game) + 1)

%num = $bvar(&reply,$calc(%offset + 2))
%max = $bvar(&reply,$calc(%offset + 3))
}

; now we echo all stored details to the active window
[[echo]] -a Info for [[$sock]]([[$sockname]]).saddr $+ : $+ $sock($sockname).sport
echo -a Name: %name
echo -a Map: %map
echo -a Game: %game
echo -a Players: %num $+ / $+ %max

; and turn off the timer closing the socket
.timer $+ $sockname off
; as we can close it now manually
sockclose $sockname
}

; this is the alias that will be called from hlplay to open the socket
alias hlchal {
; $1 = ip, $2 = port, $3- = what to call when received
; use dynamic socket name as above
var %sock = $+(hlchal-,$ticks)
; open the socket
sockudp -k %sock $1-2 $str($chr(255),4) $+ W
; mark it with the ip and port (and the query we want to call when we've received something from the server)
[[sockmark]] %sock $3- $1-2
; and make a new timer to close it after 60 seconds
.timer $+ %sock 1 60 sockclose %sock
}

; read everything that comes back from the hlchal-* query
on *:UDPREAD:hlchal-*:{
; and save it in the binary variable called &reply
sockread -f &reply
; actually call the alias saved in the sockmark (hlplay_query)
$sock($sockname).mark $bvar(&reply,6,4)
; and turn the timer off because we can close it manually
.timer $+ $sockname off
sockclose $sockname
}

; the alias we can call to make everything easier
; it will call other aliases to open sockets etc.
alias hlplay {
hlchal $1-2 hlplay_query
}

; the alias that opens the _real_ socket to receive data (everything before was just to challenge the server (read the website mentioned above))
alias hlplay_query {
; set a binary variable
bset &query 1 255 255 255 255 85 $3-
; use dynamic socket names again
var %sock = $+(hlplay-,$ticks)
; open the socket
sockudp -k %sock $1-2 &query
; and turn on the timer closing the socket after 60seconds
.timer $+ %sock 1 60 sockclose %sock
}

; this event will receive all data from the server as response to our query
on *:UDPREAD:hlplay-*:{
; we save it in &reply
sockread -f &reply

; set some local variables we will use later
var %i = 1, %num = $bvar(&reply,6), %offset = 7
var %count = 0, %name, %kills

; and echo the number of players
echo -a Players on $sock($sockname).saddr $+ : $+ $sock($sockname).sport

; now we can loop through all player and save some details about them
[[while]] (%i [[If-Then-Else#<=|<=]] %num) {
inc %offset

; the name
%name = $bvar(&reply,%offset,128).text
inc %offset $calc($len(%name) + 1)

; the kills
%kills = $bvar(&reply,%offset).long
[[If-Then-Else|if]] ([[$isbit]](%kills,32)) [[dec]] %kills $calc(2^32)
inc %offset 8

; and if there was a player
if (%name [[If-Then-Else#!=|!=]] [[$null]]) {
; increase the variable that shows us the number of the player
inc %count
; and echo it to the active window with the kills saved above
echo -a %count $+ . %name - %kills
}

; increase %i so we go on with the next player
inc %i
}

; if there are no players online, echo it aswell
if (%count [[If-Then-Else#==|==]] 0) echo -a No players found!

; turn off the timer
.timer $+ $sockname off
; and close the socket manually
sockclose $sockname
}

[[Category:Tutorials]]
[[Category:Socket]]

Category:Aliases

2006-04-25T12:20:56Z

Microbe: one space missing

== Basic ==
mIRC script allows you to create your own set of commands and identifiers, refered to as aliases. Aliases can be called from the command line, from other aliases, from popup and from remote scripts. An alias in mIRC can not be called recursively. They can be created by either putting them in the <nowiki>"Aliases"</nowiki> section of the mIRC Scripts Editor, by using the /alias command from either the command line or in the <nowiki>"Remote"</nowiki> section of the Scripts Editor. Creating an alias in the command line results in it being placed in the "Aliases" section of the Script Editor.

=== Example ===
; These two work exactly the same way although they are stored in different places

; this is placed in the "Aliases" section
moo { [[echo]] -ag moo }

; this is placed in the "Remote" section
[[alias]] moo { [[echo]] -ag moo }

== Naming aliases ==
You can give an alias virtually any name you want, but keep a few things in mind:

* When you give an alias used as a command the same name as an existing mIRC command, your alias gets preference.
* Some inbuilt commands act differently than the rest, if you have an alias called [[timertest|Timer]], you will not be able to start a timer called test, like this: /timertest 0 1 MyTestFunction in this situation you can prefix the command with an exclamation mark (!) as shown below in the example.
* When you give an alias used as an identifier the same name as an existing mIRC identifier, mIRC's identifier gets preference, unless you prefix your alias with a period.

Example:
/alias me { [[If-Then-Else|if]] ([[$isid]]) { [[return]] AveIT! } | else { [[describe]] [[$active]] [[$1-]] } }
/alias timertest { if (!%timerstart) [[set]] %timerstart [[$ticks]] | else { echo -ag [[$calc]]($ticks - %timerstart) ms | unset %timerstart } }

Here, the $isid identifer is checked to make sure we're calling $me and not /me, if we are calling /me make sure we do /describe to the active channel with the parameters supplied.
timertest
echo -ag I am $me but my custom identifer returns $.me
timertest
This should return:
I am Dana but my custom identifer returns AveIT!
16 ms

'''''Note:''''' If you want to start a timer called test with the alias called timertest, you have to prefix the timer with the ! to use the inbuilt mIRC timer command:
!timertest 1 1 echo -ag This is my test.
It is not encouraged to call an alias starting with timer, or identifers with mircdir, getdir, mididir, or any other alias which can be used with a suffix.

== Aliases: parameters and events ==
mIRC script allows you to pass parameters to your aliases, just like you pass parameters into built-in mIRC commands or identifiers. They can be referred to as [[$0]], $1, $2 ... $N.

=== Parameters ===
[[alias]] moo { echo -ag m $+ [[$str]](o,$$1) }

Assuming you pass a number as parameter this would echo an <nowiki>"m"</nowiki> folowed by a number of <nowiki>"o's"</nowiki>, depending on the number you specified as parameter. This alias can be called in 2 different ways:
/moo 12
$moo(27)
Note that $moo doesn't return anything in this case, it will simply echo the message.

=== Events ===
When calling an alias from an event, the identifiers related to that event will still be available in that alias.
on *:[[On_text|TEXT]]:hi:#: { myAlias }

[[alias]] myAlias { [[msg]] [[$chan]] [[$nick]] said hi! }

This would be exactly the same as:
on *:TEXT:hi:#: { msg $chan $nick said hi! }
This in turn means that you don't have to pass a identifier supplied by an event into your alias as parameter.

== Commands vs identifiers ==
Being that you can use your aliases as both commands and identifiers, the question may rise which you should pick. The general answer is quite simple: if you want your alias to have a return value use identifiers and in any other case use commands.

=== Error handling ===
However, mIRC's built-in error handling cannot be used for your aliases, so for proper error handling you might want to use return values. For example, you could use return value 1 when an action was succesfull and 0 when it was not.
; this identifier returns 1 if it was succesfull in what it would do and 0 if it wasn't
; the (useless) idea of the following identifier is to message "moo" to the currently active channel
; if it is on QuakeNet
alias moo {
if ([[$network]] != QuakeNet) || (!$chan) { return 0 }
else {
msg $chan moo
return 1
}
}

To use this as error handling you could do the following:
%error = $moo
if (!%error) {
; do what you want to do if the command failed
; in this case when there was no channel active
; or the server was not QuakeNet
}
[[elseif]] (%error = 1) {
; do what you want to do if the command succeeded
; in this case when there was an active channel and
; the server was QuakeNet
}
else {
; the script should never reach this place!
}
Although the same identifier could have been run as a command as well, error handling would not have been possible that way. Of course the alias itself has some error handling already, but there are cases in which you want an action to be able to fail.

Another reason to prefer identifiers over comands are parameters. When you call an alias as a command every space will result in a new parameter and there is no way you can get around that. Using an alias as an identifier it is possible to get around the comma and thus have your parameters contain a comma. Here's how to do that:
; calling an identifier with a comma in a parameter
[[alias]] test {
; the while loop will echo every parameter
[[var]] %i = $0
[[while]] (%i) {
[[echo]] -ag $ [ $+ [ %i ] ]
[[dec]] %i
}
}

var %param = abcdef,ghijk
%someVar = $test(%param)
The snippets above would result in having the identifier $test echo only 1 parameter: the data which was set in %param. Would you do the same for a command -- replacing the comma with a space -- it would result in /test getting 2 parameters. Handling parameters is much easier if you are a 100% sure which parameter will contain which data, and an identifier is more reliable in doing so.

=== Forced identifiers ===
To force an alias to be an identifier -- it can't be used as a command -- or vice versa you can use the identifier [[$isid]].
; this alias can only be called as an identifier
[[alias]] qnet {
if ([[$isid]]) {
; the following code only gets executed if the alias was called as an identifier
[[if]] ([[$network]] === QuakeNet) { [[return]] 1 }
[[else]] { [[return]] 0 }
}
}
Calling the alias will result in a return value of either 0 or 1, while calling it as a command will do completely nothing.

== Also See ==
* [[$isid]]
[[Category:mIRC_Help]]

Category:Aliases

2006-04-25T12:19:51Z

Microbe: removed plenty of extra links, fixed typos etc small

Category:Variables

2006-04-25T12:03:37Z

Microbe: added some info about variables

Variables are a way in mIRC (and in every other language) to store (temporary) data for convenience and modification reasons.

In mIRC, all variables are either [[Local_Variables|local]] or global. Local variables are lost as soon as the executing script ends and global variables are stored until they are unset. Therefore local variables are good for really temporary storing inside the script, for example while loop iterators (increasing some variable until the while loop's condition isn't [[$true]] anymore) and global variables are good for storing data for a longer duration, for example keeping track of a channel's peak.

[[Category:mIRC_Help]]

Category:Dialogs

2006-04-25T11:30:34Z

Microbe:

[[Category:MIRC Help]]