Scriptwiki - User contributions [en]

$script

2010-11-05T15:26:52Z

Daveoh:

Returns the full file path of the currently executing remote script.
$script

== Example ==
[[alias]] hello {
[[echo]] -ag We're running from script file $script
}
This may return something like:
We're running from script file C:\Users\Dana\AppData\Roaming\mIRC\scripts\remote.ini

== See Also ==
* [[$scriptline]] - Returns the current script line.
* [[$scriptdir]] - Returns the directory the current script is saved.

[[Category:Remote Identifiers]]

Category:Beta

2010-04-13T02:50:43Z

Daveoh: wording

This category contains a list of all pages where the template [[Template:Beta|<nowiki>{{beta}}</nowiki>]] is used.

Admins; remember to remove <nowiki>{{beta}}</nowiki> tags from pages once the feature is introduced into a stable version of mIRC.

Category:Beta

2010-04-03T01:22:56Z

Daveoh:

This category contains a list of all pages where the template [[Template:Beta|<nowiki>{{beta}}</nowiki>]] is used.

Please remember to remove <nowiki>{{beta}}</nowiki> tags from pages when they are introduced into a stable version of mIRC.

$input

2010-04-03T01:20:38Z

Daveoh: Added beta -b switch

Input is a multi-purpose identifier for requesting input from a user in an auto-rendered pop up dialog, similar to [[$?]].

$input(prompt [,options] [,window] [,title] [,text])

* Prompt is the text you wish to display to the user. This is usually to tell the user what you wish to be inputted. You may use a [[$crlf]] to force a line break.
* Options is a list of option flags. Defaults to an "OK" and "Cancel" button which return [[$true]] or [[$false]] respetively.
* Window is the name of the window to be used as parent window.
* Title is the title you wish to give the input dialog box.
* Text is the default text to be entered when used with "e"
The options, window, title, and text are optional parameters.

==Options==
<table border=1 rules=all cellpadding=4><tr><td>e</td><td>Show an editbox for input. "OK" and "Cancel" are default buttons. [[$null]] is returned if "Cancel" is pressed, and the text is returned if "OK" is pressed.</td></tr>
<tr><td>p</td><td>Show input password editbox. (Replaces text in editbox with stars)</td></tr>
<tr><td>o</td><td>Show an "OK" button.</td></tr>
<tr><td>y</td><td>Show a "Yes" and "No" button. 
* When used with e, returns the text or [[$null]] respectively.
* When used without e, returns [[$true]] or [[$false]] respectively.</td></tr>
<tr><td>n</td><td>Show a "Yes" "No" and "Cancel" button. 
* When used with e, returns the text, [[$null]] or [[$null]] respectively. 
* When used without e, returns [[$true]] [[$false]] and [[$null]] respectively.</td></tr>
<tr><td>r</td><td>Show a "Retry" and "Cancel" button. 
* When used with e, returns the text or [[$null]] respectively. 
* When used without e, returns [[$true]] or [[$false]] respectively.</td></tr>
<tr><td>v</td><td>Return "$ok" "$yes" "$no" "$retry" or "$cancel" instead of [[$true]] or [[$false]]. Does not work when used with e.</td></tr>
<tr><td>g</td><td>Aligns buttons to the right instead of centering them.</td></tr>
<tr><td>b</td><td>Disables buttons for a second when dialog is displayed. {{beta}}</td></tr>
<tr><td>iqwhct</td><td>Shows the info, question, warning, hand, delete and star icons respectively.</td></tr>
<tr><td>d</td><td>Plays system sound associated with the specified icons.</td></tr>
<tr><td>s</td><td>Indicates that a window has been specified.</td></tr>
<tr><td>a</td><td>Actives the input dialog automatically.</td></tr>
<tr><td>u</td><td>Uses the current window as the parent. Do not use with "s" or if a window has been indicated.</td></tr>
<tr><td>kN</td><td>Gives the user N seconds to respond. If they do not, either [[$null]] is returned (when used with e), $timeout is returned (used with v), or $false is returned.</td></tr>
<tr><td>m</td><td>Indicates that multiple text parameters have been specified. They will be displayed in a combobox. The first text item is the default item (a reference to an item in the list), the rest are the items in the list.</td></tr>
</table>

==Note==
This identifier cannot be used in a script event. One way around this is to use /[[scon]] or a /[[timer]] to initiate an input request after the script ends. 
Example:
on *:text:Foo:#:{ /timer 0 0 echo -a $?="Bar?" }

==See Also==

* [[$?]]

[[Category:Remote Identifiers]]

Template:Beta

2010-04-03T01:18:28Z

Daveoh: Modified text to be more applicable to all situations

'''Note: This function is only available in the beta version of mIRC.''' [[Category:Beta]]

Speak

2010-04-03T01:16:32Z

Daveoh: Removed unneeded category tag

{{Beta}}

Speaks the specified text.

/speak -spclu [speed] [pitch] [text]

== Switches ==

<table border=0>
<tr><td>'''-s'''</td> <td> </td> <td>speed (0 to 100)</td><tr>
<tr><td>'''-p'''</td> <td></td> <td>pitch (0 to 100)</td><tr>
<tr><td>'''-c'''</td> <td></td> <td>clear all queued lines</td><tr>
<tr><td>'''-l'''</td> <td></td> <td>apply lexicon settings in speech dialog)</td><tr>
<tr><td>'''-u'''</td> <td></td> <td>apply option settings in speech dialog</td><tr>
</table>

== See Also ==

* [[$speak]]

[[Category:Commands]]

Template:Beta

2010-04-03T01:15:53Z

Daveoh: Added to beta category

'''Note: This is an mIRC beta command. You must be using the beta version of mIRC in order to use it.''' [[Category:Beta]]

Proxy

2010-04-03T01:14:16Z

Daveoh: Added {{beta}} tag

{{Beta}}

Superseded [[firewall|/firewall]], however has exactly the same functionality. /firewall is still supported as a legacy.

Proxy

2010-04-03T01:13:41Z

Daveoh:

Superseded [[firewall|/firewall]], however has exactly the same functionality. /firewall is still supported as a legacy.

Speak

2010-04-03T01:04:20Z

Daveoh: Switches were not meant to be in code form

Speak

2010-04-03T00:54:47Z

Daveoh:

{{Beta}}

Speaks the specified text.

/speak -spclu [speed] [pitch] [text]

== Switches ==

* -s = speed (0 to 100)
* -p = pitch (0 to 100)
* -c = clear all queued lines
* -l = apply lexicon settings in speech dialog
* -u = apply option settings in speech dialog

== See Also ==

* [[$speak]]

[[Category:Commands]] [[Category:Beta]]

Template:Beta

2010-04-03T00:54:22Z

Daveoh:

'''Note: This is an mIRC beta command. You must be using the beta version of mIRC in order to use it.'''

Resetidle

2010-04-03T00:34:14Z

Daveoh:

This resets the [[$idle]] identifier to zero or to the number of seconds you specify.

/resetidle [seconds]

== See Also ==
* [[$idle]]

[[Category:Commands]]

User:Daveoh

2010-03-28T02:26:29Z

Daveoh: now a real man...

{{Babel-1|en}}
<table border="0">
<tr>
<td>[[Image:Daveoh.jpg]]</td>
<td>
<table border="0">
<tr><td>Age</td><td>18</td></tr>
<tr valign="top" height="40"><td>Country</td><td>United Kingdom of Great Britain (and Northern Ireland)</td></tr>

<tr><td>Words of wisdom</td><td>Sarcasm is the coolest way to mock people.</td></tr>
</table>
</td>
</tr>
</table>
[[Category:Members]]

$cmdbox

2009-11-29T16:29:16Z

Daveoh: removed See Also and Aliases category

Returns $true if a command or script was initiated via the command editbox in a channel window.
$cmdbox
* This function has no parameters.
== Example ==
[[alias]] whois {
;;If user types /whois then
[[If-Then-Else|if]] ($cmdbox && $1 && !$2) { [[tokenize]] 32 $1 $1 }
!whois $$1-
}

[[Category:Other Identifiers]]

Category:Aliases

2009-11-29T16:27:26Z

Daveoh: explained $prop

== 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 [[timer|timertest]], 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:

; at first we add a new alias called "me". If it is used as "$me", it's supposed to return "AveIT!", else it's the usual
; /me alias sending an action to the active channel
/alias me { [[If-Then-Else|if]] ([[$isid]]) { [[return]] AveIT! } | else { [[describe]] [[$active]] [[$1-]] } }

; this alias will return the amount of milliseconds (ticks) pasted between two callings.
; When called the first time, it will set a variable %timerstart to the current value of $ticks.
; When called the second time, it echo's the difference between the set variable and the current value of ticks.
; This difference is obviously the elapsed time.
/alias timertest { if (!%timerstart) [[set]] %timerstart [[$ticks]] | else { echo -ag [[$calc]]($ticks - %timerstart) ms | unset %timerstart } }

In the following example, both the custom 'me' and the 'timertest' alias will be used:

; call timertest the first time to set the variable %timertest
timertest

; echo $me (that's the default $me alias as it can't be overwritten in the usual way)
; and $.me (that's our custom alias returning 'AveIT!')
echo -ag I am $me but my custom identifer returns $.me

; call timertest a second time to echo the amount of elapsed milliseconds
timertest

Finally, the example above would 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 used only as an identifier or vice versa, you can use the identifier [[$isid]]. This will return [[$true]] if the alias was called as an $identifier or [[$false]] if it was called as a /command.
; 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.

=== Properties ===
Custom identifiers can use their own properties, which can be checked by using the [[$prop]] identifier.

In the example below, $value can have either .squared or .sqrt appended to it in order to change its function. For example, $value(4).squared would return 16, whilst $value(4).sqrt would return 2. Without a property, the alias returns the value provided unmodified.
alias value {
if ($isid && $1 isnum) {
if (!$prop) return $1
elseif ($prop == squared) return $calc($1 ^ 2)
elseif ($prop == sqrt) return $calc($1 ^ 0.5)
}
}

== See Also ==
* [[$isid]]
* [[$prop]]
* [[$show]]

[[Category:mIRC_Help]]

$prop

2009-11-29T16:26:21Z

Daveoh: spelling

Returns the property of a custom alias.
$prop
* This function has no parameters.
== Example ==
[[alias]] value {
[[if]] ([[$isid]] && $1 isnum) {
if (!$prop) [[return]] $1
[[elseif]] ($prop == squared) return [[$calc|$calc($1 ^ 2)]]
elseif ($prop == sqrt) return $calc($1 ^ 0.5)
}
}
In the above custom identifier, calling $value(4).squared would return 16, $value(4).sqrt would return 2 and $value(3.14) would return 3.14.
[[Category:Identifiers]]
[[Category:Aliases]]

$prop

2009-11-29T16:13:39Z

Daveoh: added to aliases category

Returns the property of a custom alias.
$prop
* This function has no parameters.
== Example ==
[[alias]] value {
[[if]] ([[$isid]] && $1 isnum) {
if (!$prop) [[return]] $1
[[elseif]] ($prop == squared) return [[$calc|$calc($1 ^ 2)]]
elseif ($prop == sqrt) return $calc($1 ^ 0.5)
}
return 0
}
In the above custom identifier, calling $value(2).square would return 4, $value(16).sqrt would return 4 and $value(3.14) would return 3.14
[[Category:Identifiers]]
[[Category:Aliases]]

$isalias

2009-11-29T16:12:04Z

Daveoh: added to aliases category

Returns [[$true]] if the specified name is an alias that exists in your aliases or scripts.
$isalias(name)
===Properties===
* '''fname''' - returns the filename in which the alias exists
* '''alias''' - returns the alias definition
==Example==
[[alias]] -l cow { [[say]] Cows go moo! }
alias fish {
[[if]] (fishbot [[If-then-else#ison|ison]] [[$active]]) say I love the smell of fish in the morning.
else say I wish I could smell fish.
}

$isalias(cow) returns $true since we have a cow alias.
$isalias(fish).fname returns the filename in which the alias is saved or ''[[$null|null]]'' if the alias doesn't exist.
$isalias(fish).alias returns fish {
$isalias(cow).alias returns cow -l { say Cows go moo! }

If the above $isalias() calls are being called from outside the same remote file as the cow alias mirc would return $false since cow is a local alias and the .alias property would return null.
==See Also==
* [[alias|/alias]]
[[Category:Identifiers]]
[[Category:Aliases]]

Limits

2009-09-16T20:49:56Z

Daveoh: Calculations: although it's not a length limit, it's still a limit. Added text to show it's a value limit

'''Warning: Not all of these values are updated for mIRC v6.32 and above. Sections which remain to be confirmed are marked with (Untested)'''

This page explains various limits imposed by mIRC, however this may not be a complete list. The length is measured in bytes (equivalent to ASCII characters, including spaces.)

You can find the original limits page [http://www.xise.nl/mirc/wiki/doku.php?id=limits here.]

= mIRC =
<table border=2 rules=all cellpadding=4 style=text-align:center><tr>
<td>'''Name'''</td><td>'''Length'''</td><td>'''When exceeded'''</td><td>'''Description'''</td></tr><tr>
<td colspan=0>'''Global limits'''</td></tr><tr>
<td>'''Line Length Limit''' (''LLL'')</td><td>4150</td><td>Truncated or error<td style=text-align:left>To be precise: 4150 for evaluation results, 4151 for command lines (excluding command prefixes.)</td></tr><tr>
<td>'''Variables''' (local or global)</td><td>4150</td><td>Unset</td><td style=text-align:left>This limit includes the variable's name. Example: using "%a" as a name uses 3 bytes (2 for the name and 1 for a space.) This means that for every extra character in the variable name, the maximum length of the value is reduced. '''Note:''' the /set command further reduces the length limit to 4144 due to the 4 characters used by "set ". (LLL)</td></tr><tr>
<td>'''Calculations'''</td><td>'''Max value:''' 9007199254740992</td><td>Inaccurate</td><td style=text-align:left>Calculations past this number will generally be incorrect. Only the first 15 numbers of the result will be accurately calculated.</td></tr><tr>
<td colspan=0>'''IRC server related'''</td></tr><tr>
<td>'''Incoming lines'''</td><td>601</td><td>Truncated</td><td style=text-align:left>'''(Untested)''' Excludes CR/LF.</td></tr><tr>
<td>'''Outgoing lines'''</td><td>LLL</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Joined channel names'''</td><td>255</td><td>Parted immediately</td><td style=text-align:left>Includes channel prefix.</td></tr><tr>
<td>'''Channel keys'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Addresses'''</td><td>90</td><td>Truncated</td><td style=text-align:left>'''(Untested)''' The part of the full address after the "!"; only with JOIN/QUIT messages, addresses from WHO replies are not truncated.</td></tr><tr>
<td>'''Nicknames'''</td><td>50</td><td>Truncated</td><td style=text-align:left>'''(Untested)'''</td></tr><tr>
<td>'''Server passwords'''</td><td>50</td><td>Truncated</td><td style=text-align:left>'''(Untested)''' As associated with server entries</td></tr><tr>
<td colspan=0>'''CTCPs'''</td></tr><tr>
<td>'''Incoming PING argument'''</td><td>24</td><td>No reply sent</td><td style=text-align:left>'''(Untested)''' First character must be a digit; leading spaces ignored.</td></tr><tr>
<td colspan=0>'''Sockets'''</td></tr><tr>
<td>'''Socket name'''</td><td>255</td><td>Error</td><td style=text-align:left></td></tr><tr>
<td>'''Send buffer'''</td><td>16384</td><td>Error</td><td style=text-align:left>mIRC's own buffers, not WinSock's.</td></tr><tr>
<td>'''Receive buffer'''</td><td>4096</td><td>Receipt stalls</td><td style=text-align:left>mIRC's own buffers, not WinSock's.</td></tr><tr>
<td>'''Socket mark'''</td><td>LLL</td><td></td><td style=text-align:left>Not 512 as the helpfile says.</td></tr><tr>
<td colspan=0>'''Hashtables'''</td></tr><tr>
<td>'''Hashtable name'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Hashtable size'''</td><td>10000</td><td>Error</td><td style=text-align:left>In number of buckets</td></tr><tr>
<td colspan=0>'''GUI'''</td></tr><tr>
<td>'''Edit box'''</td><td>1024</td><td>Sent</td><td style=text-align:left>Edit box is cleared afterwards, similar to pressing Enter.</td></tr><tr>
<td colspan=0>'''Dialogs'''</td></tr><tr>
<td>'''Dialog name'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Input dialog text field'''</td><td>1023</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Edit box'''</td><td>30000</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td colspan=0>'''Files'''</td></tr><tr>
<td>'''Line of text'''</td><td>4149</td><td>Split</td><td style=text-align:left>Excluding CR/LF. Applies to all file-related commands/identifiers.</td>
</tr></table>

[[Category:mIRC]]

Limits

2009-09-16T20:46:48Z

Daveoh:

'''Warning: Not all of these values are updated for mIRC v6.32 and above. Sections which remain to be confirmed are marked with (Untested)'''

This page explains various limits imposed by mIRC, however this may not be a complete list. The length is measured in bytes (equivalent to ASCII characters, including spaces.)

You can find the original limits page [http://www.xise.nl/mirc/wiki/doku.php?id=limits here.]

= mIRC =
<table border=2 rules=all cellpadding=4 style=text-align:center><tr>
<td>'''Name'''</td><td>'''Length'''</td><td>'''When exceeded'''</td><td>'''Description'''</td></tr><tr>
<td colspan=0>'''Global limits'''</td></tr><tr>
<td>'''Line Length Limit''' (''LLL'')</td><td>4150</td><td>Truncated or error<td style=text-align:left>To be precise: 4150 for evaluation results, 4151 for command lines (excluding command prefixes.)</td></tr><tr>
<td>'''Variables''' (local or global)</td><td>4150</td><td>Unset</td><td style=text-align:left>This limit includes the variable's name. Example: using "%a" as a name uses 3 bytes (2 for the name and 1 for a space.) This means that for every extra character in the variable name, the maximum length of the value is reduced. '''Note:''' the /set command further reduces the length limit to 4144 due to the 4 characters used by "set ". (LLL)</td></tr><tr>
<td>'''Calculations'''</td><td>9007199254740992</td><td>Inaccurate</td><td style=text-align:left>Calculations past this number will generally be incorrect. Only the first 15 numbers of the result will be accurately calculated.</td></tr><tr>
<td colspan=0>'''IRC server related'''</td></tr><tr>
<td>'''Incoming lines'''</td><td>601</td><td>Truncated</td><td style=text-align:left>'''(Untested)''' Excludes CR/LF.</td></tr><tr>
<td>'''Outgoing lines'''</td><td>LLL</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Joined channel names'''</td><td>255</td><td>Parted immediately</td><td style=text-align:left>Includes channel prefix.</td></tr><tr>
<td>'''Channel keys'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Addresses'''</td><td>90</td><td>Truncated</td><td style=text-align:left>'''(Untested)''' The part of the full address after the "!"; only with JOIN/QUIT messages, addresses from WHO replies are not truncated.</td></tr><tr>
<td>'''Nicknames'''</td><td>50</td><td>Truncated</td><td style=text-align:left>'''(Untested)'''</td></tr><tr>
<td>'''Server passwords'''</td><td>50</td><td>Truncated</td><td style=text-align:left>'''(Untested)''' As associated with server entries</td></tr><tr>
<td colspan=0>'''CTCPs'''</td></tr><tr>
<td>'''Incoming PING argument'''</td><td>24</td><td>No reply sent</td><td style=text-align:left>'''(Untested)''' First character must be a digit; leading spaces ignored.</td></tr><tr>
<td colspan=0>'''Sockets'''</td></tr><tr>
<td>'''Socket name'''</td><td>255</td><td>Error</td><td style=text-align:left></td></tr><tr>
<td>'''Send buffer'''</td><td>16384</td><td>Error</td><td style=text-align:left>mIRC's own buffers, not WinSock's.</td></tr><tr>
<td>'''Receive buffer'''</td><td>4096</td><td>Receipt stalls</td><td style=text-align:left>mIRC's own buffers, not WinSock's.</td></tr><tr>
<td>'''Socket mark'''</td><td>LLL</td><td></td><td style=text-align:left>Not 512 as the helpfile says.</td></tr><tr>
<td colspan=0>'''Hashtables'''</td></tr><tr>
<td>'''Hashtable name'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Hashtable size'''</td><td>10000</td><td>Error</td><td style=text-align:left>In number of buckets</td></tr><tr>
<td colspan=0>'''GUI'''</td></tr><tr>
<td>'''Edit box'''</td><td>1024</td><td>Sent</td><td style=text-align:left>Edit box is cleared afterwards, similar to pressing Enter.</td></tr><tr>
<td colspan=0>'''Dialogs'''</td></tr><tr>
<td>'''Dialog name'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Input dialog text field'''</td><td>1023</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Edit box'''</td><td>30000</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td colspan=0>'''Files'''</td></tr><tr>
<td>'''Line of text'''</td><td>4149</td><td>Split</td><td style=text-align:left>Excluding CR/LF. Applies to all file-related commands/identifiers.</td>
</tr></table>

[[Category:mIRC]]

Missing pages

2009-09-06T14:06:44Z

Daveoh:

== Identifiers ==
[[$ansi2mirc]]
[[$com]]
[[$comcall]]
[[$comerr]]
[[$comval]]
[[$creq]]
[[$dbuh]]
[[$dbuw]]
[[$dccignore]]
[[$dccport]]
[[$dll]]
[[$dllcall]]
[[$dns]]
[[$get]]
[[$group]]
[[$hash]]
[[$height]]
[[$keychar]]
[[$keyrpt]]
[[$keyval]]
[[$lactivewid]]
[[$link]]
[[$menu]]
[[$menucontext]]
[[$menutype]]
[[$mididir]]
[[$passivedcc]]
[[$send]]
[[$sreq]]
[[$utfdecode]]
[[$utfencode]]
[[$vcmd]]
[[$vcmdstat]]
[[$vcmdver]]

== Commands ==
[[comclose]]
[[comopen]]
[[comreg]]
[[creq]]
[[dcc chat]]
[[dcc get]]
[[dcc ignore]]
[[dcc nick]]
[[dcc passive]]
[[dcc reject]]
[[dcc send]]
[[dcc trust]]
[[dccserver]]
[[dll]]
[[drawcopy]]
[[drawdot]]
[[drawfill]]
[[drawline]]
[[drawpic]]
[[drawrect]]
[[drawreplace]]
[[drawrot]]
[[drawsave]]
[[drawscroll]]
[[drawtext]]
[[finger]]
[[font]]
[[fsend]]
[[fserve]]
[[identd]]
[[links]]
[[mdi]]
[[pdcc]]
[[perform]]
[[playctrl]]
[[renwin]]
[[reseterror]]
[[resetidle]]
[[savebuf]]
[[showmirc]]
[[sockpause]]
[[sound]]
[[speak]]
[[sreq]]
[[strip]]
[[tray]]
[[unload]]
[[url]]
[[vcadd]]
[[vcmd]]
[[vcrem]]

== Events ==
[[On connectfail]]
[[On ctcpreply]]
[[On dccserver]]
[[On dns]]
[[On error]]
[[On filercvd]]
[[On filesent]]
[[On getfail]]
[[On nosound]]
[[On sendfail]]
[[On serverop]]
[[On top]]
[[On user]]
[[On vcmd]]

Updatenl

2009-09-06T14:06:29Z

Daveoh:

Updates the nicklist and [[:Category:IAL|IAL]].
/updatenl

Usually the channel nicknames list and IAL in a kick/part/quit script event are updated after the script finishes, this command updates them immediately.
[[Category:IAL]]
[[Category:Commands]]

Updatenl

2009-08-22T08:18:35Z

Daveoh:

$input

2009-08-15T18:00:33Z

Daveoh: missing options

Input is a multi-purpose identifier for requesting input from a user in an auto-rendered pop up dialog, similar to [[$?]].

$input(prompt [,options] [,window] [,title] [,text])

* Prompt is the text you wish to display to the user. This is usually to tell the user what you wish to be inputted. You may use a [[$crlf]] to force a line break.
* Options is a list of option flags. Defaults to an "OK" and "Cancel" button which return [[$true]] or [[$false]] respetively.
* Window is the name of the window to be used as parent window.
* Title is the title you wish to give the input dialog box.
* Text is the default text to be entered when used with "e"
The options, window, title, and text are optional parameters.

==Options==
<table border=1 rules=all cellpadding=4><tr><td>e</td><td>Show an editbox for input. "OK" and "Cancel" are default buttons. [[$null]] is returned if "Cancel" is pressed, and the text is returned if "OK" is pressed.</td></tr>
<tr><td>p</td><td>Show input password editbox. (Replaces text in editbox with stars)</td></tr>
<tr><td>o</td><td>Show an "OK" button.</td></tr>
<tr><td>y</td><td>Show a "Yes" and "No" button. 
* When used with e, returns the text or [[$null]] respectively.
* When used without e, returns [[$true]] or [[$false]] respectively.</td></tr>
<tr><td>n</td><td>Show a "Yes" "No" and "Cancel" button. 
* When used with e, returns the text, [[$null]] or [[$null]] respectively. 
* When used without e, returns [[$true]] [[$false]] and [[$null]] respectively.</td></tr>
<tr><td>r</td><td>Show a "Retry" and "Cancel" button. 
* When used with e, returns the text or [[$null]] respectively. 
* When used without e, returns [[$true]] or [[$false]] respectively.</td></tr>
<tr><td>v</td><td>Return "$ok" "$yes" "$no" "$retry" or "$cancel" instead of [[$true]] or [[$false]]. Does not work when used with e.</td></tr>
<tr><td>g</td><td>Aligns buttons to the right instead of centering them.</td></tr>
<tr><td>iqwhct</td><td>Shows the info, question, warning, hand, delete and star icons respectively.</td></tr>
<tr><td>d</td><td>Plays system sound associated with the specified icons.</td></tr>
<tr><td>s</td><td>Indicates that a window has been specified.</td></tr>
<tr><td>a</td><td>Actives the input dialog automatically.</td></tr>
<tr><td>u</td><td>Uses the current window as the parent. Do not use with "s" or if a window has been indicated.</td></tr>
<tr><td>kN</td><td>Gives the user N seconds to respond. If they do not, either [[$null]] is returned (when used with e), $timeout is returned (used with v), or $false is returned.</td></tr>
<tr><td>m</td><td>Indicates that multiple text parameters have been specified. They will be displayed in a combobox. The first text item is the default item (a reference to an item in the list), the rest are the items in the list.</td></tr>
</table>

==Note==
This identifier cannot be used in a script event. One way around this is to use /[[scon]] or a /[[timer]] to initiate an input request after the script ends. 
Example:
on *:text:Foo:#:{ /timer 0 0 echo -a $?="Bar?" }

==See Also==

* [[$?]]

[[Category:Remote Identifiers]]

$input

2009-08-15T17:56:56Z

Daveoh:

Input is a multi-purpose identifier for requesting input from a user in an auto-rendered pop up dialog, similar to [[$?]].

$input(prompt [,options] [,window] [,title] [,text])

* Prompt is the text you wish to display to the user. This is usually to tell the user what you wish to be inputted. You may use a [[$crlf]] to force a line break.
* Options is a list of option flags. Defaults to an "OK" and "Cancel" button which return [[$true]] or [[$false]] respetively.
* Title is the title you wish to give the input dialog box.
* Text is the default text to be entered when used with "e"

==Options==
<table border=1 rules=all cellpadding=4><tr><td>e</td><td>Show an editbox for input. "OK" and "Cancel" are default buttons. [[$null]] is returned if "Cancel" is pressed, and the text is returned if "OK" is pressed.</td></tr>
<tr><td>o</td><td>Show an "OK" button.</td></tr>
<tr><td>y</td><td>Show a "Yes" and "No" button. 
* When used with e, returns the text or [[$null]] respectively.
* When used without e, returns [[$true]] or [[$false]] respectively.</td></tr>
<tr><td>n</td><td>Show a "Yes" "No" and "Cancel" button. 
* When used with e, returns the text, [[$null]] or [[$null]] respectively. 
* When used without e, returns [[$true]] [[$false]] and [[$null]] respectively.</td></tr>
<tr><td>r</td><td>Show a "Retry" and "Cancel" button. 
* When used with e, returns the text or [[$null]] respectively. 
* When used without e, returns [[$true]] or [[$false]] respectively.</td></tr>
<tr><td>v</td><td>Return "$ok" "$yes" "$no" "$retry" or "$cancel" instead of [[$true]] or [[$false]]. Does not work when used with e.</td></tr>
<tr><td>g</td><td>Aligns buttons to the right instead of centering them.</td></tr>
<tr><td>iqwhct</td><td>Shows the info, question, warning, hand, delete and star icons respectively.</td></tr>
<tr><td>d</td><td>Plays system sound associated with the specified icons.</td></tr>
<tr><td>s</td><td>Indicates that a window has been specified.</td></tr>
<tr><td>a</td><td>Actives the input dialog automatically.</td></tr>
<tr><td>u</td><td>Uses the current window as the parent. Do not use with "s" or if a window has been indicated.</td></tr>
<tr><td>kN</td><td>Gives the user N seconds to respond. If they do not, either [[$null]] is returned (when used with e), $timeout is returned (used with v), or $false is returned.</td></tr>
</table>

==Note==
This identifier cannot be used in a script event. One way around this is to use /[[scon]] or a /[[timer]] to initiate an input request after the script ends. 
Example:
on *:text:Foo:#:{ /timer 0 0 echo -a $?="Bar?" }

==See Also==

* [[$?]]

[[Category:Remote Identifiers]]

$var

2009-07-23T21:09:50Z

Daveoh:

Returns information about currently set [[:Category:Variables|variables]], [[Local Variables|local]] or [[set]].

$var(variable name [,N])[.value|.local]

* Variable name is a wild card value.
* N tells us we want the Nth matching variable.
** N is 0 by default, and therefore can be used to check for existence without it
* Returns
** Variable name by default
** Value if .value is specified
** If .local is specified, returns [[$true]] or [[$false]] based on whether or not the matching variable is a [[Local Variables|local variable]]

==Examples==

How to search through local variables only:
[[var]] %i = 1
[[while]] ($var(%varwildcard*,%i).local) {
[[echo]] -ag $var(%varwildcard*,%i) is a local variable
[[inc]] %i
}

==See Also==
* [[set|/set]] - sets global variables
* [[var|/var]] - sets local variables
* [[Local Variables]]

[[Category:Variables]][[Category:Remote Identifiers]]

$hotline

2009-05-30T15:01:21Z

Daveoh:

Returns the full line which contained the hotlink trigger.
$hotline

== Example ==
[[On hotlink|on 1:HOTLINK]]:*:*:[[echo]] clicked word [[$1-|$1]] in line $hotline [[$hotlinepos]]
Echoes the word clicked within the line, the line itself and the position of the clicked word.

== See Also ==
* [[On hotlink|On Hotlink]] - the triggering event.
* [[$hotlinepos]] - returns the line number and word position of the trigger.

[[Category:Identifiers]]

If-Then-Else

2009-05-30T14:34:05Z

Daveoh: /* Notes */ Wording

__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
[[#!=|!]] negation operator (!= is opposite of == and !isin is "is not in")

[[#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 (!$away) ;Returns $true if you are NOT away ($away returns $false and ! negates it to $true).

=== < ===
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. Note the $( ), it is needed to prevent mirc treat this statement as bitwise comparison.

=== isnum ===

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

The examples above checks $1, to see;

Is it a number? 
Is it a number above 10? 
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- contains only uppercase letters. So ABCD returns true, but even one lowercase letter makes it return false.

====''Use parenthesis correctly''====
(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 the content of a text file, use [[$read]] to search through a file via its search switches.

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

[[Category:Commands]]

Limits

2009-05-02T21:43:21Z

Daveoh: Dialog edit boxes have a limit of 30,000 characters

'''Warning: Not all of these values are updated for mIRC v6.32 and above. Sections which remain to be confirmed are marked with (Untested)'''

This page explains various limits imposed by mIRC, however this may not be a complete list. The length is measured in bytes (equivalent to ASCII characters, including spaces.)

You can find the original limits page [http://www.xise.nl/mirc/wiki/doku.php?id=limits here.]

= mIRC =
<table border=2 rules=all cellpadding=4 style=text-align:center><tr>
<td>'''Name'''</td><td>'''Length'''</td><td>'''When exceeded'''</td><td>'''Description'''</td></tr><tr>
<td colspan=0>'''Global limits'''</td></tr><tr>
<td>'''Line Length Limit''' (''LLL'')</td><td>4150</td><td>Truncated or error<td style=text-align:left>To be precise: 4150 for evaluation results, 4151 for command lines (excluding command prefixes.)</td></tr><tr>
<td>'''Variables''' (local or global)</td><td>4150</td><td>Unset</td><td style=text-align:left>This limit includes the variable's name. Example: using "%a" as a name uses 3 bytes (2 for the name and 1 for a space.) This means that for every extra character in the variable name, the maximum length of the value is reduced. '''Note:''' the /set command further reduces the length limit to 4144 due to the 4 characters used by "set ". (LLL)</td></tr><tr>
<td colspan=0>'''IRC server specific'''</td></tr><tr>
<td>'''Incoming lines'''</td><td>601</td><td>Truncated</td><td style=text-align:left>'''(Untested)''' Excludes CR/LF.</td></tr><tr>
<td>'''Outgoing lines'''</td><td>LLL</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Joined channel names'''</td><td>255</td><td>Parted immediately</td><td style=text-align:left>Includes channel prefix.</td></tr><tr>
<td>'''Channel keys'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Addresses'''</td><td>90</td><td>Truncated</td><td style=text-align:left>'''(Untested)''' The part of the full address after the "!"; only with JOIN/QUIT messages, addresses from WHO replies are not truncated.</td></tr><tr>
<td>'''Nicknames'''</td><td>50</td><td>Truncated</td><td style=text-align:left>'''(Untested)'''</td></tr><tr>
<td>'''Server passwords'''</td><td>50</td><td>Truncated</td><td style=text-align:left>'''(Untested)''' As associated with server entries</td></tr><tr>
<td colspan=0>'''CTCPs'''</td></tr><tr>
<td>'''Incoming PING argument'''</td><td>24</td><td>No reply sent</td><td style=text-align:left>'''(Untested)''' First character must be a digit; leading spaces ignored.</td></tr><tr>
<td colspan=0>'''Sockets'''</td></tr><tr>
<td>'''Socket name'''</td><td>255</td><td>Error</td><td style=text-align:left></td></tr><tr>
<td>'''Send buffer'''</td><td>16384</td><td>Error</td><td style=text-align:left>mIRC's own buffers, not WinSock's.</td></tr><tr>
<td>'''Receive buffer'''</td><td>4096</td><td>Receipt stalls</td><td style=text-align:left>mIRC's own buffers, not WinSock's.</td></tr><tr>
<td>'''Socket mark'''</td><td>LLL</td><td></td><td style=text-align:left>Not 512 as the helpfile says.</td></tr><tr>
<td colspan=0>'''Hashtables'''</td></tr><tr>
<td>'''Hashtable name'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Hashtable size'''</td><td>10000</td><td>Error</td><td style=text-align:left>In number of buckets</td></tr><tr>
<td colspan=0>'''GUI'''</td></tr><tr>
<td>'''Edit box'''</td><td>1024</td><td>Sent</td><td style=text-align:left>Edit box is cleared afterwards, similar to pressing Enter.</td></tr><tr>
<td colspan=0>'''Dialogs'''</td></tr><tr>
<td>'''Dialog name'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Input dialog text field'''</td><td>1023</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Edit box'''</td><td>30000</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td colspan=0>'''Files'''</td></tr><tr>
<td>'''Line of text'''</td><td>4149</td><td>Split</td><td style=text-align:left>Excluding CR/LF. Applies to all file-related commands/identifiers.</td>
</tr></table>

[[Category:mIRC]]

User:Daveoh

2009-04-03T13:29:39Z

Daveoh: update

{{Babel-1|en}}
<table border="0">
<tr>
<td>[[Image:Daveoh.jpg]]</td>
<td>
<table border="0">
<tr><td>Age</td><td>17</td></tr>
<tr valign="top" height="40"><td>Country</td><td>Great Britain</td></tr>

<tr><td>Words of wisdom</td><td>None for you</td></tr>
</table>
</td>
</tr>
</table>
[[Category:Members]]

On start

2009-04-03T13:28:00Z

Daveoh: wording + example

The on START event triggers the first time a script file is ever loaded and also every time after that, including when mIRC is started.
on <level>:START:<commands>

You can use this event as a point of initialization for the script to run commands which are needed before use (e.g. creating and loading data in [[:Category:Hash Table|hash tables]], initializing variables, loading dialogs, connecting to several servers, updating some stats, etc.).

== Example ==
on *:START: {
[[echo]] -s Connecting to QuakeNet
[[server]] irc.quakenet.org:6667
}
This example would make mIRC connect to QuakeNet whenever you start it.

on *:START:{
hmake table 10
if ([[$isfile|$isfile(table.hsh)]]) { [[hload]] table table.hsh }
}
This example creates a hash table when the script is started and, if the file "table.hsh" exists, loads that file into the table.

== See Also ==
* [[On_load|On load event]] - triggers when a script file is loaded for the first time.

[[Category:Events]]

Dialog basics

2008-11-10T00:11:32Z

Daveoh: tabs + radio button groups

Basic dialog commands and switches

'''/dialog -mdtsonkcvie name [table] [x y w h] [text]''' 
Where name is the name by which you'll refer to the dialog, and table is the dialog table name used to create dialog

-m create a modeless dialog using 'table' /dialog -m name table
-a used with -m, uses currently active window as the parent
-x close a dialog without triggering any events
-d open dialog on the desktop, used with -m
-h make dialog work with active server connection
-t set dialog title /dialog -t name text
-s set dialog size/pos /dialog -s name x y w h
-r centers dialog
-bp interprets size as dbu or pixels
-o set dialog ontop of all windows
-n unset ontop setting
-k click ok button
-c click cancel button
-v makes the dialog the active window
-ie minimize/restore the dialog if created on the desktop
-g renames existing dialog using <name> <newname>

'''The dialog table''' 
You can use the dialog prefix to create a dialog table called name in a script using this format:

dialog [-l] name {
title "text"
icon filename, index
size x y w h
option type (dbu, pixels, notheme)

text "text", id, x y w h, style (right, center, nowrap)
edit "text", id, x y w h, style (right, center, multi, pass, read, return, hsbar, vsbar, autohs, autovs, limit N)
button "text", id, x y w h, style (default, ok, cancel, flat, multi)
check "text", id, x y w h, style (left, push, 3state)
radio "text", id, x y w h, style (left, push, group)
box "text", id, x y w h, style
scroll "text", id, x y w h, style (top left bottom right horizontal range N N)

list id, x y w h, style (sort, extsel, multsel, size, vsbar, hsbar, check, radio)
combo id, x y w h, style (sort, edit, drop, size, vsbar, hsbar)

icon id, x y w h, filename, index, style (noborder top left bottom right small large actual)

link "text", id, x y w h

tab "text", id, x y w h
tab "text", id

menu "text", menuid [, menuid]
item "text", id [, menuid]
item break, id [, menuid]
}

The -l switch makes a dialog table local, so that it can only be accessed by other scripts in the same file.

'''Dbu vs. Pixels''' 
The dbu option makes mIRC use dialog base units when creating the dialog, this ensures that the dialog will look the same for all users under any size display, etc. Pixels is the default however to maintain compatibility with previous scripts.
The identifiers $dbuw and $dbuh return the dbu per pixel width and height values for the current display. This may or may not be an integer value.
 
'''Ok and Cancel buttons''' 
You can specify an ok and/or cancel button, and when a user clicks the ok or cancel buttons, the dialog is closed. You can prevent the dialog from closing if a user clicks the ok button by using /halt.
 
'''Grouping radio buttons''' 
Radio buttons can be grouped together using the 'group' style, followed by the radio buttons you want in the group without the 'group' style. E.g;
radio "Group 1 Option 1", 1, 10 10 100 20, group
radio "Group 1 Option 2", 2, 10 30 100 20
radio "Group 2 Option 1", 3, 10 50 100 20, group
radio "Group 2 Option 2", 4, 10 70 100 20
The above would create two radio button groups, each starting where the 'group' style is entered.
 
'''Default position and size''' 
If you specify -1 for any of the x y w h values in the size setting for the dialog, a default setting is used. To make mIRC center the dialog in a window, specify x y as -1 -1. The size setting can be over-ridden in the init event (see below) by using /dialog -s name x y w h.

'''Example'''
;create a dialog table with name 'dialogtest'
dialog dialogtest {

;set the titlebar text of the dialog to "testing dialog"
title "testing dialog"

;define the position and size of the dialog, x and y set to -1 so the dialog is created to the middle of mirc window, width set to 150 and height to 200
size -1 -1 150 200

;dpu, dialog basic units, so the dialog will be the same size in every resolution
option dbu

;a text item that says "Random text", assigning id 1 for the item, x=5, y=10, w=100, h=10, no style
text "Random text", 1, 5 10 100 10,
}

;now you can call this dialog by writing: /dialog -m dialogtest dialogtest

'''A bit more in-depth example'''
; this dialog will calculate how long it is since/untill a specific day
; alias to open the dialog faster
alias dt { .dialog -m dialogtest dialogtest }

; the dialog table
dialog dialogtest {
title "Testing"
size -1 -1 200 200
option dbu

; we'll use 2 tabs here, make them start from x/y -1 and w/h 202 so we'll have nice borders when it goes a bit over
tab "From ", 1, -1 -1 202 202
tab "Untill", 2, -1 -1 202 202

; 2 boxes for both tabs to create a nice title and frame (note tab1 and tab2 at the end)
box "Time from date calculator" , 3, 2 15 195 183, tab1
box "Time untill date calculator", 4, 2 15 195 183, tab2

; the dropdown combo boxes for date/month/year selection, we'll do 2 different boxes for the year selection
; one that has past years, and the other one has upcoming years (for different tabs)
; this way we don't have to update the one everytime you change the tab
combo 5, 10 25 20 10, drop
combo 6, 31 25 20 10, drop
combo 7, 52 25 24 10, drop tab1
combo 8, 52 25 24 10, drop tab2

; buttons for calcultaing the result and to clear the list
button "Calculate", 9, 78 24 37 12,
button "Reset" , 10, 153 24 37 12,

; show the text above the list, and the empty one (ID 12) is there for an error message, empty at the time being
text "Last calculations:", 11, 12 42 50 20,
text "", 12, 105 42 100 8,

; then the lists to store earlier calculations, 1 for each tab
list 13, 10 50 180 80, sort tab1
list 14, 10 50 180 80, sort tab2
}

; the init event, this event triggers every time the dialog opens, so here we will fill those controls
on *:dialog:dialogtest:init:0:{
; 2 first ones loops through days/months and adds them into dropdown combos
var %x = 1 | while (%x <= 31) { did -a $dname 5 %x | inc %x }
var %x = 1 | while (%x <= 12) { did -a $dname 6 %x | inc %x }

; these two are for the year selection, first starts from "this year -10 years", and is shown in the 1st tab
; second one starts from this year and goes 10 years forward, this is for the second tab
var %x = $calc($asctime(yyyy) -10) | while (%x <= $asctime(yyyy)) { did -a $dname 7 %x | inc %x }
var %x = $asctime(yyyy) | while (%x <= $calc($asctime(yyyy) +10)) { did -a $dname 8 %x | inc %x }
}

; sclick event for the "Calculate" button
on *:dialog:dialogtest:sclick:9:{
; we'll use these variables for the sake of clarity
; so %day, %month, %year to implode into %date ($base for zeropadding 5 -> 05 etc.)
var %day = $base($did($dname,5),10,10,2)
var %month = $base($did($dname,6),10,10,2)
var %year = $did($dname,$iif($dialog($dname).tab == 1,7,8))
var %date = $+(%year,-,%month,-,%day)

; from $dialog().tab we'll see which tab is active, and choose the right list ID by that
var %target = $iif($dialog($dname).tab == 1,13,14)

; again check the tab, and calculate the right duration (ctime - %date, or %date - ctime)
if ($dialog($dname).tab == 1) { var %duration = - $duration($calc($ctime - $ctime(%date))) }
else { var %duration = + $duration($calc($ctime(%date) - $ctime)) }

; check for errors, if day/month/year is empty (not inputted), or if the calculation returns a negative number
if ($mid(%duration,3,1) == -) || (!%day) || (!%month) || (!%year) {
; so we have an error, show it in the empty text field we created, and use timer to clear it after 4 seconds (/did -r)
did -a $dname 12 Parameters missing, or wrong date
.timerClearError 1 4 did -r $dname 12
halt
}

; no errors if we're here, so, just show the result in %target ID in the form of "yyyy-mm-dd + 3days"
did -a $dname %target %date %duration
}

; sclick event for the reset button
on *:dialog:dialogtest:sclick:10:{
did -r $dname $iif($dialog($dname).tab == 1,13,14)
}

; dclick event just for echoing a line from the list, when you double click it
on *:dialog:dialogtest:dclick:13,14:{
echo -ag $did($dname,$did,1).seltext
}

[[Category:Dialogs]]

Limits

2008-09-26T16:13:39Z

Daveoh: Sockets verified

'''Warning: These values may be outdated for mIRC v6.32. Updated and confirmed sections are marked with (Updated)'''

This page explains various limits imposed by mIRC, however this may not be a complete list. The length is measured in bytes (equivalent to ASCII characters, including spaces.)

You can find the original limits page [http://www.xise.nl/mirc/wiki/doku.php?id=limits here.]

= mIRC =
<table border=2 rules=all cellpadding=4 style=text-align:center><tr>
<td>'''Name'''</td><td>'''Length'''</td><td>'''When exceeded'''</td><td>'''Description'''</td></tr><tr>
<td colspan=0>'''Global limits (Updated)'''</td></tr><tr>
<td>'''Line Length Limit''' (''LLL'')</td><td>4150</td><td>Truncated or error<td style=text-align:left>To be precise: 4150 for evaluation results, 4151 for command lines (excluding command prefixes.)</td></tr><tr>
<td>'''Variables''' (local or global)</td><td>4150</td><td>Unset</td><td style=text-align:left>This limit includes the variable's name. Example: using "%a" as a name uses 3 bytes (2 for the name and 1 for a space.) This means that for every extra character in the variable name, the maximum length of the value is reduced. '''Note:''' the /set command further reduces the length limit to 9144 due to the 4 characters used by "set ". (LLL)</td></tr><tr>
<td colspan=0>'''IRC server specific'''</td></tr><tr>
<td>'''Incoming lines'''</td><td>601</td><td>Truncated</td><td style=text-align:left>Excludes CR/LF.</td></tr><tr>
<td>'''Outgoing lines'''</td><td>LLL</td><td>Truncated</td><td style=text-align:left>'''(Updated)'''</td></tr><tr>
<td>'''Joined channel names'''</td><td>255</td><td>Parted immediately</td><td style=text-align:left>'''(Updated)''' Includes channel prefix.</td></tr><tr>
<td>'''Channel keys'''</td><td>256</td><td>Truncated</td><td style=text-align:left>'''(Updated)'''</td></tr><tr>
<td>'''Addresses'''</td><td>90</td><td>Truncated</td><td style=text-align:left>The part of the full address after the "!"; only with JOIN/QUIT messages, addresses from WHO replies are not truncated.</td></tr><tr>
<td>'''Nicknames'''</td><td>50</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Server passwords'''</td><td>50</td><td>Truncated</td><td style=text-align:left>As associated with server entries</td></tr><tr>
<td colspan=0>'''CTCPs'''</td></tr><tr>
<td>'''Incoming PING argument'''</td><td>24</td><td>No reply sent</td><td style=text-align:left>First character must be a digit; leading spaces ignored.</td></tr><tr>
<td colspan=0>'''Sockets (Updated)'''</td></tr><tr>
<td>'''Socket name'''</td><td>255</td><td>Error</td><td style=text-align:left></td></tr><tr>
<td>'''Send buffer'''</td><td>16384</td><td>Error</td><td style=text-align:left>mIRC's own buffers, not WinSock's.</td></tr><tr>
<td>'''Receive buffer'''</td><td>4096</td><td>Receipt stalls</td><td style=text-align:left>mIRC's own buffers, not WinSock's.</td></tr><tr>
<td>'''Socket mark'''</td><td>LLL</td><td></td><td style=text-align:left>Not 512 as the helpfile says.</td></tr><tr>
<td colspan=0>'''Hashtables (Updated)'''</td></tr><tr>
<td>'''Hashtable name'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Hashtable size'''</td><td>10000</td><td>Error</td><td style=text-align:left>In number of buckets</td></tr><tr>
<td colspan=0>'''GUI (Updated)'''</td></tr><tr>
<td>'''Editbox'''</td><td>1024</td><td>Sent</td><td style=text-align:left>Editbox is cleared afterwards, similar to pressing Enter.</td></tr><tr>
<td colspan=0>'''Dialogs (Updated)'''</td></tr><tr>
<td>'''Dialog name'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Input dialog text field'''</td><td>1023</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td colspan=0>'''Files (Updated)'''</td></tr><tr>
<td>'''Line of text'''</td><td>4149</td><td>Split</td><td style=text-align:left>Excluding CR/LF. Applies to all file-related commands/identifiers.</td>
</tr></table>

$$

2008-08-11T05:24:44Z

Daveoh:

Any identifier can be prefixed with another $ to prevent execution without a certain parameter.

For example, using $$1 in a command means the command will only run if $1 is filled.

If the specified identifier does not exist, execution of commands will be [[halt|halted]].

You can also use $$?1 or $?1 which will try to fill the value with parameter one if it exists. If parameter one doesn't exist, it will ask for it. In the first case the parameter is necessary for the command to be executed, in the second case it isn't.

== Example ==

/op $$1
Will run the /op command if $1 is filled.

/nick [[$gettok|$$gettok(%nicks,5,44)]]
Will run the [[nick|/nick]] command if a 5th comma-delimited [[:Category:Token Identifiers|token]] in %nicks exists.

== See Also ==

* [[$?]]

Pvoice

2008-08-11T05:13:04Z

Daveoh:

Works the same way as the [[pop|/pop]] command except that it voices a user.
/pvoice <delay> [#channel] <nickname>

== Example ==

/pvoice 4 #help.script Dana
Waits 4 seconds and then voices Dana on #help.script if she is not already voiced.

== See Also ==

* [[pop|/pop]]

[[Category:Commands]]

Pop

2008-08-11T05:11:27Z

Daveoh:

Performs a delayed op on a nickname.
/pop <delay> [#channel] <nickname>

The purpose of this command is to prevent a channel window filling up with op mode changes whenever several users have the same nickname in their auto-op section.

mIRC will pause around <delay> seconds before performing the op. If <delay> is zero, it does an immediate op. Before performing the op it checks if the user is already opped. If you do not specify the #channel, the current channel is assumed.

== Example ==

/pop 4 #help.script Dana
Waits 4 seconds and then ops Dana on #help.script if she is not already opped.

== See Also ==

* [[pvoice|/pvoice]]

[[Category:Commands]]

$width

2008-08-11T04:59:55Z

Daveoh:

Returns width of text in pixels for the specified font.
$width(text,font,size,B,C)

If B is non-zero, the font is bold, if C is non-zero, control codes are processed. Both B and C are optional.

'''Note:''' If you use a negative number for the font size, it will match the size of fonts in the font dialog.

== Example ==

$width(Lorem ispum,Arial,12)
Returns 74.

== See Also ==

* [[$wrap]]
* [[font|/font]]

[[Category:Picture Windows]]

$wrap

2008-08-11T04:59:38Z

Daveoh:

Returns Nth line in text wrapped to the specified width in pixels.
$wrap(text, font, size, width, [word,] N)

If the optional word parameter is 1, text is wrapped at whole words (which is the default).

You can specify 0 for N to return the total number of wrapped lines.

== Example ==

$wrap(The quick brown fox jumped over the lazy dog., Arial, 12, 100, 0)
Returns "3" for the total number of lines.

$wrap(The quick brown fox jumped over the lazy dog., Arial, 12, 100, 3)
Returns "the lazy dog."

$wrap(The quick brown fox jumped over the lazy dog., Arial, 12, 100, 0, 2)
Returns "ox jumped over th"

== See Also ==

* [[$width]]

[[Category:Text and Number Identifiers]]

$width

2008-08-11T04:55:39Z

Daveoh:

Missing pages

2008-08-11T04:47:17Z

Daveoh: oh god

== Identifiers ==
[[$$]]
[[$activewid]]
[[$ansi2mirc]]
[[$cd]]
[[$clevel]]
[[$com]]
[[$comcall]]
[[$comerr]]
[[$comval]]
[[$crc]]
[[$creq]]
[[$dbuh]]
[[$dbuw]]
[[$dccignore]]
[[$dccport]]
[[$dll]]
[[$dllcall]]
[[$dns]]
[[$filename]]
[[$fserve]]
[[$get]]
[[$group]]
[[$hash]]
[[$height]]
[[$hotline]]
[[$hotlinepos]]
[[$keychar]]
[[$keyrpt]]
[[$keyval]]
[[$lactivewid]]
[[$link]]
[[$menu]]
[[$menucontext]]
[[$menutype]]
[[$mididir]]
[[$notags]]
[[$passivedcc]]
[[$send]]
[[$sound]]
[[$sreq]]
[[$trust]]
[[$vcmd]]
[[$vcmdstat]]
[[$vcmdver]]
[[$width]]
[[$wrap]]

== Commands ==
[[background]]
[[comclose]]
[[comopen]]
[[comreg]]
[[creq]]
[[ctcpreply]]
[[ctcps]]
[[dcc chat]]
[[dcc get]]
[[dcc ignore]]
[[dcc nick]]
[[dcc passive]]
[[dcc reject]]
[[dcc send]]
[[dcc trust]]
[[dccserver]]
[[dll]]
[[drawcopy]]
[[drawdot]]
[[drawfill]]
[[drawline]]
[[drawpic]]
[[drawrect]]
[[drawreplace]]
[[drawrot]]
[[drawsave]]
[[drawscroll]]
[[drawtext]]
[[finger]]
[[font]]
[[fsend]]
[[fserve]]
[[identd]]
[[linesep]]
[[links]]
[[mdi]]
[[pdcc]]
[[perform]]
[[playctrl]]
[[pop]]
[[pvoice]]
[[remote]]
[[renwin]]
[[reseterror]]
[[resetidle]]
[[savebuf]]
[[showmirc]]
[[socklist]]
[[sockpause]]
[[sockudp]]
[[sound]]
[[speak]]
[[splay]]
[[sreq]]
[[strip]]
[[tray]]
[[unload]]
[[updatenl]]
[[url]]
[[vcadd]]
[[vcmd]]
[[vcrem]]

== Events ==
[[On chat]]
[[On connectfail]]
[[On ctcpreply]]
[[On dccserver]]
[[On dns]]
[[On error]]
[[On filercvd]]
[[On filesent]]
[[On getfail]]
[[On hotlink]]
[[On keydown]]
[[On keyup]]
[[On mp3End]]
[[On nosound]]
[[On sendfail]]
[[On serv]]
[[On serverop]]
[[On snotice]]
[[On top]]
[[On udpread]]
[[On user]]
[[On vcmd]]

Limits

2008-05-29T00:37:34Z

Daveoh: more mIRC 6.32 limits info

'''Warning: These values may be outdated for mIRC v6.32. Updated and confirmed sections are marked with (Updated)'''

This page explains various limits imposed by mIRC, however this may not be a complete list. The length is measured in bytes (equivalent to ASCII characters, including spaces.)

You can find the original limits page [http://www.xise.nl/mirc/wiki/doku.php?id=limits here.]

= mIRC =
<table border=2 rules=all cellpadding=4 style=text-align:center><tr>
<td>'''Name'''</td><td>'''Length'''</td><td>'''When exceeded'''</td><td>'''Description'''</td></tr><tr>
<td colspan=0>'''Global limits (Updated)'''</td></tr><tr>
<td>'''Line Length Limit''' (''LLL'')</td><td>4150</td><td>Truncated or error<td style=text-align:left>To be precise: 4150 for evaluation results, 4151 for command lines (excluding command prefixes.)</td></tr><tr>
<td>'''Variables''' (local or global)</td><td>4150</td><td>Unset</td><td style=text-align:left>This limit includes the variable's name. Example: using "%a" as a name uses 3 bytes (2 for the name and 1 for a space.) This means that for every extra character in the variable name, the maximum length of the value is reduced. '''Note:''' the /set command further reduces the length limit to 9144 due to the 4 characters used by "set ". (LLL)</td></tr><tr>
<td colspan=0>'''IRC server specific'''</td></tr><tr>
<td>'''Incoming lines'''</td><td>601</td><td>Truncated</td><td style=text-align:left>Excludes CR/LF.</td></tr><tr>
<td>'''Outgoing lines'''</td><td>LLL</td><td>Truncated</td><td style=text-align:left>'''(Updated)'''</td></tr><tr>
<td>'''Joined channel names'''</td><td>255</td><td>Parted immediately</td><td style=text-align:left>'''(Updated)''' Includes channel prefix.</td></tr><tr>
<td>'''Channel keys'''</td><td>90</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Addresses'''</td><td>90</td><td>Truncated</td><td style=text-align:left>The part of the full address after the "!"; only with JOIN/QUIT messages, addresses from WHO replies are not truncated.</td></tr><tr>
<td>'''Nicknames'''</td><td>50</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Server passwords'''</td><td>50</td><td>Truncated</td><td style=text-align:left>As associated with server entries</td></tr><tr>
<td colspan=0>'''CTCPs'''</td></tr><tr>
<td>'''Incoming PING argument'''</td><td>24</td><td>No reply sent</td><td style=text-align:left>First character must be a digit; leading spaces ignored.</td></tr><tr>
<td colspan=0>'''Sockets'''</td></tr><tr>
<td>'''Socket name'''</td><td>255</td><td>Error</td><td style=text-align:left>'''(Updated)'''</td></tr><tr>
<td>'''Send buffer'''</td><td>16384</td><td>Error</td><td style=text-align:left>mIRC's own buffers, not WinSock's.</td></tr><tr>
<td>'''Receive buffer'''</td><td>4096</td><td>Receipt stalls</td><td style=text-align:left>mIRC's own buffers, not WinSock's.</td></tr><tr>
<td>'''Socket mark'''</td><td>LLL</td><td></td><td style=text-align:left>'''(Updated)''' Not 512 as the helpfile says.</td></tr><tr>
<td colspan=0>'''Hashtables (Updated)'''</td></tr><tr>
<td>'''Hashtable name'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Hashtable size'''</td><td>10000</td><td>Error</td><td style=text-align:left>In number of buckets</td></tr><tr>
<td colspan=0>'''GUI (Updated)'''</td></tr><tr>
<td>'''Editbox'''</td><td>1024</td><td>Sent</td><td style=text-align:left>Editbox is cleared afterwards, similar to pressing Enter.</td></tr><tr>
<td colspan=0>'''Dialogs (Updated)'''</td></tr><tr>
<td>'''Dialog name'''</td><td>256</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td>'''Input dialog text field'''</td><td>1023</td><td>Truncated</td><td style=text-align:left></td></tr><tr>
<td colspan=0>'''Files (Updated)'''</td></tr><tr>
<td>'''Line of text'''</td><td>4149</td><td>Split</td><td style=text-align:left>Excluding CR/LF. Applies to all file-related commands/identifiers.</td>
</tr></table>

Custom Windows

2008-05-23T15:25:50Z

Daveoh: new -M switch

{{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.
M = chops text at tab stops.
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.

[[Category:MIRC Help]] [[Category:Custom Windows]]

$compact

2008-05-23T14:43:44Z

Daveoh:

Returns 1 if compact mode is enabled, 0 if otherwise.
$compact
* This function has no parameters.

[[Category:Identifiers]]

$treebar

2008-05-23T14:43:42Z

Daveoh:

Returns 1 if the treebar is enabled, 0 if otherwise.
$treebar
* This function has no parameters.

[[Category:Identifiers]]

$switchbar

2008-05-23T14:43:40Z

Daveoh:

Returns 1 if the switchbar is enabled, 0 if otherwise.
$switchbar
* This function has no parameters.

[[Category:Identifiers]]

$toolbar

2008-05-23T14:43:39Z

Daveoh:

Returns 1 if the toolbar is enabled, 0 if otherwise.
$toolbar
* This function has no parameters.

[[Category:Identifiers]]

$menubar

2008-05-23T14:43:37Z

Daveoh:

Returns 1 if the menubar is enabled, 0 if otherwise.
$menubar
* This function has no parameters.

[[Category:Identifiers]]

$remtok

2008-05-23T14:32:52Z

Daveoh:

Removes the Nth matching token from text.
$remtok(text,token,N,C)
If N is 0, removes all matching tokens.

If N is not specified, removes the first matching token.

== Example ==
[[echo]] -ag $remtok(This is a moo test,moo,1,32)
This echoes ''This is a test'', as ''moo'' is removed from the text.

[[var]] %mytext = This word will remove a word
var %token = word
echo -ag $remtok(%mytext,%token,32)
This example will remove the first instance of the word ''word'' and echo: ''This will remove a word''.

var %mytoks = House Tree Bear Ship
var %mytoks = $remtok(%mytoks,Tree,32)
echo -ag Ours tokens are now: %mytoks
The above example shows how you can remove a token from a varible. Echoes ''Ours tokens are now: House Bear Ship''

var %mytext = lol some people lol too often in lol sentences, lol
echo -ag $remtok(%mytext,lol,0,32)
This example shows how you can remove all matching tokens in a string by using N = 0. Echoes ''some people too often in sentences,''

[[Category:Token Identifiers]]

$reptok

2008-05-23T14:18:54Z

Daveoh: N=0 update

Replaces the Nth matching token in text with a new token.
$reptok(text,token,new,N,C)
If N is 0, replaces all matching tokens.

'''Note''' that $reptokcs() is the case-sensitive version.
== Example ==

[[var]] %myoldtext = This is my old text
var %mynewtext = $reptok(%myoldtext, old, new, 1, 32)
[[echo]] -a %mynewtext
This example echoes ''This is my new text'', as it replaced ''old'' with ''new''.

var %numbers = 4,5,6,6,8,9
var %numbers = $reptok(%numbers,6,7,2,44)
echo -a %numbers
This echoes ''4,5,6,7,8,9'', as it replaced the second ''6'' with ''7''.

var %numbers = 0,1,2,0,2,2,0,1,2,1,0
echo -ag $reptok(%numbers,0,1,0,44)
This echoes ''1,1,2,1,2,2,1,1,2,1,1'' as all 0's are replaced with the number 1 due to N being 0.

[[Category:Token Identifiers]]