Scriptwiki - User contributions [en]

File:Mouse.png

2007-01-31T08:01:06Z

Zyberdog: Shows the different areas the $mouse identifier properties, .x/.y .dx/.dy and .mx/.my represent.

Shows the different areas the $mouse identifier properties, .x/.y .dx/.dy and .mx/.my represent.

Category:Multi-server

2006-05-07T14:33:46Z

Zyberdog: added parent category

== Explanation ==

mIRC allows you to connect to more than one IRC server at a time. This means that scripts need to be multi-server aware in order to behave correctly when a user is connected to more than one server. The following commands and identifiers allow a script to handle multiple server connections.

Every connection has a connection id value (cid). So you can either specify a connection using this cid or using the connection number (con).

So each window that is created, such as a channel or query window, is associated with the connection id of the server where that window was opened.

=== Commands ===
Scripts can be made to perform commands on a specific server connection by using the [[Scon|/scon]] or [[Scid|/scid]] commands.

=== Identifiers ===
To receive the server connection id for the current script, you have to use [[$cid]]. Using [[$scid]] (or [[$scon]]), you can get the connection id and the value of identifiers (custom ones too) for this special connection (e.g. [[$me]] has other values for each connection probably).

== Example ==
; lets make a new alias showing the time we are connected to all currently connected servers.
[[alias]] showuptimes {
[[var]] %i = 1
; we loop through all connections
[[while]] ([[$scon]](%i)) {
; switch to that connection id ($scon(N) returns the cid)
[[Scid|scid]] $scon(%i)
; from here onwards, the values of the identifiers are
; the ones from the cid we just switched to.
; lets echo the server and how long we're connected to
[[echo]] -a $server $uptime(server,2)
; increase the looping-variable
[[inc]] %i
}
}

[[Category:MIRC]]

Category:Members

2006-05-04T04:00:00Z

Zyberdog: moved doomie up as admin

How to query a CS Server

2006-04-25T15:29:02Z

Zyberdog: added wikilinks and some missing indenting

If you want to e.g. get the umber 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 (completly) 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 send 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 did query a Half-Life 1 server
if ($chr([[$bvar]](&reply,5)) == m) {
; Half-Life 1 info reply

%offset = 6

; saving 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 the timer to close the socket off
.timer $+ $sockname off
; as we can close it manually now
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 the alias to close the socket after 60seconds on
.timer $+ %sock 1 60 sockclose %sock
}

; this event will receive all data from the server as response to out 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 is 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]]

How to query a CS Server

2006-04-24T18:18:00Z

Zyberdog: added socket category

If you want to e.g. get the umber 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 (completly) 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 send back from the server
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 did query a Half-Life 1 server
if ($chr($bvar(&reply,5)) == m) {
; Half-Life 1 info reply

%offset = 6

; saving 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 the timer to close the socket off
.timer $+ $sockname off
; as we can close it manually now
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 the alias to close the socket after 60seconds on
.timer $+ %sock 1 60 sockclose %sock
}

; this event will receive all data from the server as response to out 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 <= %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 ($isbit(%kills,32)) dec %kills $calc(2^32)
inc %offset 8

; and if there was a player
if (%name != $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 is aswell
if (%count == 0) echo -a No players found!

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

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

How to query a CS Server

2006-04-24T18:17:25Z

Zyberdog: fix

If you want to e.g. get the umber 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 (completly) 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 send back from the server
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 did query a Half-Life 1 server
if ($chr($bvar(&reply,5)) == m) {
; Half-Life 1 info reply

%offset = 6

; saving 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 the timer to close the socket off
.timer $+ $sockname off
; as we can close it manually now
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 the alias to close the socket after 60seconds on
.timer $+ %sock 1 60 sockclose %sock
}

; this event will receive all data from the server as response to out 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 <= %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 ($isbit(%kills,32)) dec %kills $calc(2^32)
inc %offset 8

; and if there was a player
if (%name != $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 is aswell
if (%count == 0) echo -a No players found!

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

[[Category:Tutorials]]

How to query a CS Server

2006-04-24T18:16:20Z

Zyberdog: added category

If you want to e.g. get the umber 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 (completly) 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 send back from the server
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 did query a Half-Life 1 server
if ($chr($bvar(&reply,5)) == m) {
; Half-Life 1 info reply

%offset = 6

; saving 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 the timer to close the socket off
.timer $+ $sockname off
; as we can close it manually now
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 the alias to close the socket after 60seconds on
.timer $+ %sock 1 60 sockclose %sock
}

; this event will receive all data from the server as response to out 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 <= %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 ($isbit(%kills,32)) dec %kills $calc(2^32)
inc %offset 8

; and if there was a player
if (%name != $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 is aswell
if (%count == 0) echo -a No players found!

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

[[Category:Tutorials|Category:Socket]]

$

2006-04-24T18:13:58Z

Zyberdog: typo

#REDIRECT [[DollarPlus]] This page serves as a redirection for $+ as the wiki with its current version has difficulties allowing the character + in page names. Awaiting wiki upgrade.

$

2006-04-24T18:13:19Z

Zyberdog: added why its a redirect

#REDIRECT [[DollarPlus]] This page serves as a redirection for [[DollarPlus]] as the wiki with its current version has difficulties allowing the character + in page names. Awaiting wiki upgrade.

$

2006-04-24T18:12:00Z

Zyberdog: temp redirect until B upgrades wiki

#REDIRECT [[DollarPlus]]

$

2006-04-12T15:26:15Z

Zyberdog: temporary.. need a template for this kind of thing imo

If you came to this page looking for information on either [[DollarPlus|$+]] or [[DollarPlus|$+(...)]] it has been placed on the [[DollarPlus]] page due to technical limitations.

Ison

2006-04-12T08:38:58Z

Zyberdog: added stacking

Checks if a certain nick, or list of nicks, are online / in use.

/ison <nick> [nick2] [nickN]

The result is returned through [[Raw 303]] where [[$1-|$1]] will be your nick and [[$1-|$2-]] will be a list of the nicks you specified that are online, or nothing. See working example below.

== Example ==

The following example will modify the returned output of an /ison request to a more user-friendly format.

raw 303:*:{
if ($2) { echo -a User(s) $2- are online. }
else { echo -a The user(s) specified are not online. }
haltdef
}

[[Category:Basic IRC commands]]

Ison

2006-04-12T08:34:55Z

Zyberdog:

Checks if a certain nick is online / in use.

/ison <nick>

The result is returned through [[Raw 303]] where [[$1-|$1]] will be your nick and [[$1-|$2]] will be the target nick if it exist, or nothing. See working example below.

== Example ==

The following example will modify the returned output of an /ison request to a more user-friendly format.

raw 303:*:{
if ($2) { echo -a $2 is online. }
else { echo -a The user is not online. }
haltdef
}

[[Category:Basic IRC commands]]

Category:Hash Table

2006-04-12T08:24:43Z

Zyberdog: /* Basic Defintion */ Added some links

== Basic Defintion ==
Basically, hash tables are like [[:Category:Ini|ini files]], storing information in following format:

Tablename 
item1=data1 
item2=data2 
...

However, hash tables are a lot faster than ini- or text-files, which especially takes effect if you have a lot of entries. A kind of disadvantage is the missing possibility to ''see'' all entries. With some files, you can just open them and take a look on every entry, whereat hash table, you can't just ''open'' then. To have the chance to still get an overview, you can use the following script:

; lets make a little alias called ''showhash''. At the end, it will look like ''/showhash <name>''
[[alias]] showhash {
; echo the name and a kind of "table header"
[[echo]] -a [[$1-|$1]]
echo -a item => data
[[var]] %i = 1
; lets loop through all items. $hget($1,0).item will return the total amount of items.
[[while]] (%i [[If-Then-Else#<=|<=]] [[$hget]]($1,0).item) {
echo -a $hget($1,%i).item => $hget($1,%i).data
; increase looping-variable
[[inc]] %i
}
}

=== Modifying hash tables ===
You can make a new hashtable using the [[Hmake|/hmake]], respectivly delete one using the [[Hfree|/hfree]] command. Using [[Hdel|/hdel]] and [[Hadd|/hadd]], you can modify the data saved in your hashtable. Due to hash tables not being automatically saved, you have to use the [[Hsave|/hsave]] and [[Hload|/hload]] command.

=== Receiving data ===
After saving data in hash tables, you can of course receive them. Therefor, use the [[$hget]] and [[$hfind]] identifiers.

== More detailed information ==

The following explanations aren't necessary for using hashtables in mIRC scripts, however, these facts could help you make your scripts faster, especially if you are going to use hash tables for a lot of data.

A hashtable is basically an array of N buckets (N being the size from /hmake) where each bucket is just a pointer (4 bytes) to a linked list of items. In principle you could enlarge the number of buckets later on by resizing the array, but that means the hash values for items change: the bucket number for an item, i.e. the index into the array of pointers, is determined by the formula "hashfunc(itemname) modulo N". Changing N on the fly essentially means you have to reassign most of the items to other buckets, which is a nightmare with large hashtables.

This means that $hget will indeed be slower if you take a smaller hashtable and fill it with the same amount of items as before, since the average amount of items to traverse in a bucket when looking for a match is N/2, which would mean that $hget takes much longer on a big file loaded in a small hash table, compared to a big file loaded in a big hash table.
A benchmark would show this, although you'd have to repeat $hget a large number of times of course, as the speed of individual $hgets is still negligible.

On the other hand, if your file contains M entries, /hload does M implicit $hgets to ensure that item names won't be added twice. If the factor M:N (i.e. items:size) is 10:1, then it will do (on average) 5 * M lookups, if it is 100:1, then it will do 50 * M lookups and so on. For large values of M, this difference is noticeable, even with one single /hload. So you should choose N very carefully before issuing a /hload.

Note that there is no such thing as an "overflow" in hashtables; buckets point to linked lists that can be of arbitrary length. If you make a hashtable of size 1, you are essentially using a single linked list of items, and everything will still work fine (but $hget would be just as slow as $hfind in that case).

== Deleting unwanted items from a hash table ==

In some cases, you'll want to loop over ''all'' the items in the hashtable, deleting the ones you do not want anymore. It may be a bit unclear at first how to do this: deleting items while looping over them is kind of like removing the ground under your own feet; how can you be sure you don't end up skipping over items, for example?

Fortunately, there's one fundamental fact that you can use to do this: if you loop over N items using $hget().item, and then delete the N+1'th item, then those N items will remain the same. The N+1'th item, though, will be a new item (typically the N+2'th item). For example, if $hget().item returns A, B, C and D for respectively N values 1, 2, 3 and 4. and then you delete item C, then you can be sure that $hget().item with N values 1 and 2 will still return A and B after deleting C, respectively. Item D, however, will now be item 3 instead of 4, because there will never be any "gaps" between item numbers.

The following alias shows how to put this into practice, by looping over all the items in a given hashtable, and calling a custom identifier $want-to-delete on each of them, deleting the items for which $want-to-delete returns $true. The loop will always complete (no infinite loop!), and after it has completed, ''all'' the items that were to be deleted, will indeed be gone.

; usage: /purgeitems <hashtable>
[[alias]] purgeitems {
; our counter: we start off at the first item
[[var]] %i = 1

; as long as the %i-th item exists, continue looping
[[while]] ($hget($1,%i).item != $null) {
; temporarily store the name of this item in a variable
; $v1 refers to the "$hget($1,%i).item" bit above
[[var]] %t = $v1

; now perform a check to see if we still want to keep this item;
; $want-to-delete is a custom alias (not included) and returns
; either $true or $false, indicating whether we should delete %t
[[if]] ($want-to-delete(%t)) {
; yes, we want to delete this item; use its item name (%t) to
; actually delete it using /hdel
[[hdel]] $1 %t

; the important part is that we do NOT increase %i here;
; we just deleted the %i-th item, so the %i-th item is now a
; new item. due to the way hashtable iteration works, we also
; know for sure that we have not seen the %i-th item yet!
}
[[else]] {
; we're leaving this item in, so let's increase %i so that we
; move on to the next item.
[[inc]] %i
}
}
}

Note that this is a very expensive (slow) operation, you should not use $hget().item unless you have to. If you can, use [[hdel|/hdel]] with the -w (wildcard) switch instead!
[[Category:MIRC Help]]

Access Levels

2006-02-18T00:48:07Z

Zyberdog: added parent category

Access levels are assigned both to a user and to an event and serve to limit a user's access to only certain events.

The default access level is 1 for users that are not listed in the Users list. All users can access level 1 events. The higher a user's access level is, the more events that user can access. You can change the default user level to allow unlisted users to access more commands.

== Users ==
In the Users section you can specify a list of users and their access levels using the format:

<level1,level2,...,levelN>:<useraddress>
3,5,6:Dana!dana@staff.quakenet.org

The first level is a general access level, which means that the user can access all levels equal to or less than 3. All the other levels are levels that an event must specifically have to allow a user to access it.

If you want to force the first access level to be a specific level instead of a general access level, you can prefix it with an equal sign.
=3,5,6:Dana!dana@staff.quakenet.org
Now this user has access specifically to level 3, 5, and 6 event and to no other events.

== Events ==
In general, the format of an event is:
on <prefix><level>:<event>:<option/parameters>:<target>:<commands/suffix>:

on ^3:[[On_text|TEXT]]:hello:?: { [[msg]] [[$nick]] Hi, $nick }
on 5:TEXT:hello:?:=
With the exception of:
<prefix> <level>:<event>:<target>:<commands>

[[Ctcp_(event)|CTCP]] 1:HELP:*: { msg $nick No help is available for level 1 users }

''For information about the on TEXT above, please read about the [[#The_.3D_suffix|= suffix]]. ''
The above ctcp command can be accessed by all users because it is a level 1 command. So if a user with nickname goat sends you a /[[ctcp]] yournick HELP, your script will send them the above reply.

Only the highest level matching event is triggered for a user.

== Named Levels ==
You can also used named levels which work the same way as a specific level but are easier to understand and read than a number.

friend:Dana!dana@staff.quakenet.org

on @friend:[[On_join|JOIN]]:#: { msg $nick Welcome $nick ! }

This treats the word friend as a specific access level and matches the user with the event, and because the user is your friend, you welcome them.

'''''Note:''''' 
You can use '''*''' as a named level that will match ''ALL'' users.

== Prefixes ==
You can limit access to an event by specifying special prefixes which determines how an event is processed or triggered by users.

=== The + prefix ===
You can limit an event to users with a specific access level by using the + prefix.

10:Dana!dana@staff.quakenet.org

ctcp +5:HELP:*: { msg $nick You have accessed a level +5 event }

The above user can't access this ctcp event even though he has an access level higher than 5, because the event is limited only to level 5 users.

=== The ! prefix ===
You can prevent an event from being triggered if it was initiated by you by using the ! prefix.

on !*:JOIN:#: { echo $chan -t $nick join joined $chan }
You would be unable to access the above event regardless of your access level.

=== The me: prefix ===
This prefix is the negate of the ! prefix.
Using me: will only trigger the event if you are the user who triggered the event.
It would be the same as using the following code in your event:
if ($nick == $me) { ... }
'''''Note:''''' The fact this is a three character prefix makes no difference than any other prefix.

=== The @ prefix ===
You can limit events to being executed only when you have Ops on a channel by using the @ prefix.

Blacklist:Dana!dana@staff.quakenet.org

on @Blacklist:JOIN:#: { [[mode]] $chan +b [[$address]]($nick,3) | [[kick]] $chan $nick You are blacklisted. }

When the above user joins a channel you have Ops on, the associated /mode and /kick command will be executed, in this case banning and kicking the user. If you don't have Ops, the event will not trigger.

=== The & prefix ===
You can prevent an event from being triggered if a previous script used /halt or /haltdef to halt the display of default text for an event by using the & prefix.

on &1:TEXT:*:?: { echo this event won't trigger if [[$halted]] is true }

=== The $ prefix ===
Indicates that the matchtext section of a definition contains a [[Regular_Expression]].

on $*:TEXT:m/regular expression/switches:#: { echo message: [[$1-]] }

The 'm' and switches are optional. The // are required. If switches are used they must be standard PCRE switches, otherwise the match will fail. You can use switch 'S' to strip control codes from $1-.

== Suffixes ==
Suffixes are used to prevent certain users from access the commands.

=== The = suffix ===
You can prevent users with higher access levels from accessing all lower access level events by using the = suffix.

10:Dana!dana@staff.quakenet.org

ctcp 2:HELP:*: { msg $nick You have accessed a level 2 event }
ctcp 5:HELP:*:=

The above user can't access any of these events because the level 5 event prevents him from accessing all HELP events with access levels lower than 5.
The only users who can access the above event is someone with user access level 2, 3 or 4.

=== The ! suffix ===
You can prevent commands for a certain event level from being processed by using the ! suffix.

ctcp 5:PING:*: { echo PING! }
ctcp 5:*:*:!

The ! at the end of the line tells the remote to halt any further processing of level 5 commands.

== Order of definitions ==
Many of the prefixes and controls are sensitive to numerical order of the definitions. The safest thing is to order your definitions starting with the lowest access levels first and increasing numerically down the list, this makes it easier to keep track of which events should trigger first.

== Also See ==
*[[auser]] ;Used to add a users Access Level.
*[[guser]] ;This acts the same as auser except it looks up a users ident/host via the server.
*[[flush]] ;This clears the remote user list of nickname definitions that are no longer valid.
*[[ruser]] ;Used to remove a user or a users access levels.
*[[rlevel]] ;This removes all users from the remote users list with the specified general access level.
*[[ulist]] ;This lists users which have the specified access levels.

[[Category:MIRC Help]]

$mid

2006-02-18T00:45:20Z

Zyberdog: added parent category, few typos

Returns '''I''' amount of characters from the '''N'''th character in '''text'''.
$mid(<text>,N[,I])
I is optional, if I is omitted, it will return from position N onwards.

== Examples ==
var %i = abcde
echo -ag $mid(%i,2,3)
This above example will echo out bcd. This is because it grabs the text from position ''N'' which is ''2'' in this case, ''a'' being ''1'', and ''b'' being ''2''. From this spot, we now grab then next ''I'' characters (''3'') so we grab ''b=1 c=2 d=3''

This is an example to loop threw every character and check it against something.
'';Set the variable %text to the string we are going to use.''
[[var]] %text = There are 14 brown cows, they're hyperactive and jump over the 6 lazy red fish. :-(

'';Set the variable %n to 1 and %i to the length of %text.''
var %n = 1, %i = [[$len]](%text)
'';Creates these local variables so they don't save as global when used.''
var %letters = 0, %numbers = 0, %spaces = 0, %other = 0

'';Keep looping while %n is less than or equal to %i.''
[[While loops|while]] (%n [[If-Then-Else#The_Operators|<=]] %i) {
'';Set %letter to the character located at %n, only grab 1 character.''
var %letter = $mid(%text,%n,1)

'';If %letter is a letter, number, space or other set the corresponding variable.''
[[If-Then-Else|if]] (%letter [[If-Then-Else#The_Operators|isletter]]) { [[inc]] %letters }
[[If-Then-Else|elseif]] (%letter [[If-Then-Else#The_Operators|isnum]]) { inc %numbers }
elseif (%letter [[If-Then-Else#The_Operators|==]] [[$chr]](32)) { inc %spaces }
[[If-Then-Else|else]] { inc %other }

'';Increment %n by 1, so first loop %n = 1, then %n = 2 until %n is greater than %i''
inc %n
}
[[echo]] -ag String: %text
echo -ag There are %letters letters, %numbers numbers, %spaces spaces and %other other characters (punctuations etc.)

== Also See ==
* [[$right]]
* [[$left]]
[[Category:Text_and_Number_Identifiers]]

User:Zyberdog

2006-01-27T14:12:59Z

Zyberdog: removed category qnet staff

{{Babel-3|da|en-3|de-1}}
<table border="0">
<tr><td>Name</td><td>David Lorentsen</td></tr>
<tr><td>Age</td><td>20</td></tr>
<tr><td>Country</td><td>Denmark</td></tr>
<tr valign="top" height="40"><td>Access level</td><td>quakenet staff</td></tr>

<tr><td>Words of wisdom</td><td>Wisdom is highly overrated.</td></tr>
</table>

[[Category:Members]]

On action

2006-01-07T14:21:47Z

Zyberdog: proper example indentation

The on ACTION event triggers when you receive private and/or channel action.
on <level>:ACTION:<matchtext>:<*><?><#[,#]>:<commands>

The matchtext can be a [[If-Then-Else#The_Operators|wildcard]] match or even a [[Regular_Expression|regular expression]].
To use regular expressions as matchtext, you need the [[Access_Levels|$-Prefix]].

Read [[Access_Levels|access levels]] to get more info about the <level> field.

The location where this event occurrs can be either a channel (#), a query (?) or both (*).

You can also use variables as matchtext and location parameter.

'''Note''' that you can't test these events by typing it yourself. To test them, use another connection, that you can establish via [[Server|/server]].

== Example ==
on *:ACTION:*:#: {
[[If-Then-Else|if]] (*slaps [[$me]] * [[If-Then-Else#iswm|iswm]] [[$1-]]) {
[[msg]] [[$chan]] Don't slap me, [[$nick]] [[DollarPlus|$+]] !
}
}
This example will react on every slap, that hits you and sends a message to this channel: ''Dont slap me, <nickname who has slapped you>''.

on *:ACTION:*moos*:#help.script: {
msg #help.script $nick just moo'd!.
}
This example will react on every "moos" in #help.script and sends a message to this channel.

== See Also ==
To react on "normal" text, look at the [[On_text|On Text event]].
Use [[describe]] to send an action to a channel.

[[Category:Events]]

On action

2006-01-07T14:18:39Z

Zyberdog: added a few wikilinks

Main Page

2006-01-05T14:56:17Z

Zyberdog: proper link for bemember

== This Wiki ==

Welcome to the Scriptwiki, a wiki dedicated to mIRC scripting! Here, you can find information and reference material to help you write scripts for mIRC; we have information ranging from simple tutorials to extensive mIRC help, and also a number of prefabricated scripts.

In contrast to many other wikis, here normal users aren't allowed to make changes to the 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 need to be approved as a wiki editor. You can become a wiki editor in the following two ways:
* Be invited by an [[Members|existing wiki editor]] (or an admin) and approved by the admins.
* Fill in an application, found [[Special:BeMember|here]]. It will be processed by the admins and you will be notified if the result is positive. To present your article writing skills, you can write a sample article and attach it to the application.

== 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.
__NOTOC__

Category:File Handling

2005-12-22T18:17:52Z

Zyberdog: better overview

== General Explanation ==
Using the commands and identifiers in this category allows you to modify a file directly. That means that mIRC opens a connection to the specified and locks this connection when you are opening a file using [[Fopen|/fopen]]. At the same moment, a (file-)pointer is set to the start of the file. You can now read the character the pointer points to (either by using [[$fread]] that reads the entire line until the next [[$crlf]] or by using [[$fgetc]] that reads the "next" character only - note that the pointer is automatically moved to the begin of the next line / next character by using these identifiers) or move the pointer to another position in the file (by using [[Fseek|/fseek]]). After you've modified you file, you '''have to''' close it again (to unlock it and so make it accessible by other applications) using [[Fclose|/fclose]].

'''Note''' that you should check [[$ferr]] after every modification of the file (inclusive opening it).

== Difference to /write and $read ==
Contrary to this, the "usual" way to access a file ([[Write|/write]] and [[$read]] that is) work in another way. For example, if you want to echo line number 4 and 5 of a file, you would use:
[[echo]] -a $read(my.txt,4) $read(my.txt,5)
Internally, mIRC would do following:
#open the file (using fopen)
#read the first line (using $fread - check [[$read]] for more details about it)
#move the pointer to the start of line 4 (using fseek)
#read this line (using $fread)
#close the file (using fclose)
#open the file again (using fopen)
#move the pointer to the start of line 5 (using fseek)
#read this line (using $fread)
#close the file (using fclose) again

That's obviously not efficient, as we don't need to close it after our first read. So using File Handling, we could directly do:
#open the file (using fopen)
#jump to line 4 (using fseek)
#read this line (using fread)
#read the next line (and the pointer is automatically there after reading line 4 - using fread)
#close the file (using flose)
If you want to read one or two lines only, there is no need to use this way, as $read is alot easier to handle, but if you have a file of e.g. 40mb and want to read 100 lines, there is a ''big'' difference between File Handling and $read (~ factor 10).
== Example ==

[[Category:mIRC Help]]

Category:File Handling

2005-12-22T18:16:26Z

Zyberdog: test preview

== General Explanation ==
Using the commands and identifiers in this category allows you to modify a file directly. That means that mIRC opens a connection to the specified and locks this connection when you are opening a file using [[Fopen|/fopen]]. At the same moment, a (file-)pointer is set to the start of the file. You can now read the character the pointer points to (either by using [[$fread]] that reads the entire line until the next [[$crlf]] or by using [[$fgetc]] that reads the "next" character only - note that the pointer is automatically moved to the begin of the next line / next character by using these identifiers) or move the pointer to another position in the file (by using [[Fseek|/fseek]]). After you've modified you file, you '''have to''' close it again (to unlock it and so make it accessible by other applications) using [[Fclose|/fclose]].

'''Note''' that you should check [[$ferr]] after every modification of the file (inclusive opening it).

== Difference to /write and $read ==
Contrary to this, the "usual" way to access a file ([[Write|/write]] and [[$read]] that is) work in another way. For example, if you want to echo line number 4 and 5 of a file, you would use:
[[echo]] -a $read(my.txt,4) $read(my.txt,5)
Internally, mIRC would do following:
#open the file (using fopen)
#read the first line (using $fread - check [[$read]] for more details about it)
#move the pointer to the start of line 4 (using fseek)
#read this line (using $fread)
#close the file (using fclose)
#open the file again (using fopen)
#move the pointer to the start of line 5 (using fseek)
#read this line (using $fread)
#close the file (using fclose) again
That's obviously not efficient, as we don't need to close it after our first read. So using File Handling, we could directly do:
#open the file (using fopen)
#jump to line 4 (using fseek)
#read this line (using fread)
#read the next line (and the pointer is automatically there after reading line 4 - using fread)
#close the file (using flose)
If you want to read one or two lines only, there is no need to use this way, as $read is alot easier to handle, but if you have a file of e.g. 40mb and want to read 100 lines, there is a ''big'' difference between File Handling and $read (~ factor 10).
== Example ==

[[Category:mIRC Help]]

$read

2005-12-10T20:02:48Z

Zyberdog: htmltable -> wikitable

Returns a line of text from a text file.
$read(''filename'',[ntswrp],[''string''],[''N''])
The first parameter is the filename and the only required parameter.
If you omit all other parameters you will be returned with a random line from the file.

The second parameter is a set of options that determin the type of search you wish to use, for a full description see the table below.
if ''string'' is numerical and you do not use ''swr'' switch the line corresponding to the numerical value will be returned.

If the ''N'' parameter is given it starts to search the file from that line number.

'''Note:''' If the first line of your text file is a numerical value mIRC treats this number as the total number of lines in the text file, be careful not to accidently have your file cut short due to an unexpected numerical value.
If you specify N = 0, mIRC returns the value of the first line if it's a number.
Take good note of the ''t'' switch in the table below.

{| style="width:100%"
| style="width:5%" | '''''Switch''''' || style="width:95%" | '''''Meaning'''''
|-
| n || If the ''n'' switch is specified then the line read in will not be evaluated and will be treated as plain text.
|-
| t || If the ''t'' switch is specified then mIRC will treat the first line in the file as plain text, even if it is a numeric.
|-
| s || Scans the ''filename'' for a line beginning with the ''string'' and returns the text following the match value.
|-
| w || Scans the ''filename'' for a line matching ''string'', where ''string'' can contain [[If-Then-Else#iswm|wildcards]].
|-
| r || Scans the ''filename'' for a line matching ''string'', where ''string'' is taken as a [[Regular_Expressions|regular expression]].
|-
| p || If the ''p'' switch is specified, command <nowiki>|</nowiki> separators are treated as such instead of as plain text.
|}

== Examples ==
'''''Example.txt:'''''
5
Ave It
Hash Help Dot Script
6
Cows dont go moo, Fish go moo!
Fish go moo
Yes they do
The above is an example text file used in the following examples.

$read(''Example.txt'',''s'',''Ave'') ;Returns ''It'', all data that follows the first line starting with ''Ave''.
$read(''Example.txt'',''w'',''*moo'') ;Returns ''Fish go moo'', note the lack of pending asterisks means moo has to be the last word.
$read(''Example.txt'',''3'') ;Returns ''6'', This is the 3rd line in the file if you count line 1 as the linecount line because it is a number.
$read(''Example.txt'',''t'',''3'') ;Returns ''Hash Help Dot Script'', This is the 3rd line in the file if you count line 1 plain text.
$read(''Example.txt'',''w'',''*moo'') ;Returns ''

[[kick]] [[$chan]] [[$nick]] $read(Example.txt) ;Kicks a user with a random line from the text file.
== Also See ==
* [[$readn]] This returns the line number that $read just returned.
* [[play]] This is a much better alternative if you require to list the content of a whole file to a channel.
* [[filter]] This can help with more complex needs when reading in content from files or windows.
* [[loadbuf]] This is a much better alternative if you need to dump many lines of text to a dialog or to a custom window

[[Category:File and Directory Identifiers]]

If-Then-Else

2005-12-07T21:04:21Z

Zyberdog: typo

__NOTOC__
The If-then-else statement allows you to compare values and execute different parts of a script based on that comparison.

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 return
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 G is checked only if A or B were not triggered
H If none of previous wasn't matches, H is returned

== The Operators ==

[[#==|==]] equal to
[[#==|===]] equal to (case-sensitive)
[[#!=|!=]] not equal to
[[#<|<]] 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 internal ban list

[[#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).

=== != ===
if (cat != cAt) ;Returns false since != is case-insensitive and both values v1 and v2 are equal.
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.
The != and !== operators are the negates of the == and === operators.

=== < ===
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 less 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 multipul of 9.
Multipuls 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 multipul of 9.
\\ is the negate of //

=== & ===
if (13 & 4) ;Returns true because the 4th bit of 13 is [[$biton|turned on]].
& Is a bitwise comparison and checks thats bit v2 (4) is 'turned on' in v1.
Using & operator is the same as using [[$isbit]].

=== isin ===
if (cat isin [[$1-]])
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 dont love you" since "dont 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 if, 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 upper 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.

=== 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.

=== ishop ===
if (moo ishop #mIRC) ; returns true if ''moo'' is an half operator in #mIRC
'''Note''' that QuakeNet does not support halfops.

=== 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.

=== 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.

=== 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) ; returns true as ''idiot!*@*'' is in your [[:Category:IAL]].
'''Note''' that you cannot use this to check whether this address is banned in a specific channel. You'd have to use [[$ibl]] to do it.

=== 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.

====''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.

[[Category:Commands]]

$0

2005-12-07T14:45:24Z

Zyberdog: removed author template, not that much contributed

[[Category:Remote Identifiers]]

The identifier $0 is used in conjunction with [[$1-|$1]]. Technically it returns the number of tokens in the parameter passed. Unless the [[tokenize]] command has been used this defaults to being spaces, hence $0 will return the number of words in most cases.

== Examples ==

When used in an [[Aliases|alias]] it can look something like this.

alias count_words { [[Echo|echo -a]] That was $0 words }

Usage: /count_words Here is a sentence I want to count the words in..

When used in an [[Events|event]] it acts the same.

[[On_text|on *:text]]:!count *:#mirc:{ [[msg]] [[$chan]] That was $0 words }

Usage: !count Here's another sentence we want to have fun with!

'''Note''' that $0 returns total number of tokens, meaning that in the event example above it will also count the word !count as being part of the sentence. You can bypass this by using [[$calc]]($0 - 1). This is not the case for the alias.

[[Category:Remote Identifiers]]

Category:Hash Table

2005-12-07T14:43:43Z

Zyberdog:

 

[[Category:MIRC Help]]

$lower

2005-12-05T03:06:16Z

Zyberdog: tweak

Returns text in lowercase.

$lower(text)

$lower forces its parameter to lowercase characters.

$lower(''FOO'') returns ''foo'', and $lower(''bAr'') returns ''bar''.

== See Also ==
* [[$upper]]

[[Category:Text and Number Identifiers]]

$upper

2005-12-05T03:05:31Z

Zyberdog:

Returns given ''text'' in uppercase.

$upper(''text'')

$upper forces its parameter to uppercase characters.

== Example ==

$upper(''foo'') ;returns ''FOO''
[[$lower]](''bAr'') ;returns ''bar''

== See Also ==

* The opposite identifier is [[$lower]]

[[Category:Text and Number Identifiers]]

$isupper

2005-12-05T03:01:04Z

Zyberdog:

Returns [[$true]] if ''text'' specified is all upper case.

$isupper(''text'')

== Example ==

$isupper(HELLO) ;returns $true as ''HELLO'' is all upper case
$isupper(WiCKED) ;returns [[$false]] as ''WiCKED'' is not all upper case

== See also ==

* The counterpart of this identifier is [[$islower]]

[[Category:Text and Number Identifiers]]

$islower

2005-12-05T02:58:58Z

Zyberdog:

Returns [[$true]] if ''text'' specified is all lower case.

$islower(''text'')

== Example ==

$islower(helloworld) ;returns $true as ''helloworld'' is all lower case
$islower(HelloWorld) ;returns [[$false]] as ''HelloWorld'' is not all lower case

== See also ==

* The counterpart of this identifier is [[$isupper]]

[[Category:Text and Number Identifiers]]

$true

2005-12-05T02:54:46Z

Zyberdog: just added some if-then-else operator references

This identifier is the opposite of $false, which are both the result of an [[if|If-Then-Else]]-statement and returned by some other identifiers and are both explained in this article. These two identifiers are rarely actually written in a mirc script, but they are always 'working behind the scenes'.

$true or $false

To understand the essence of these identifiers, you should first read about if-statements.

== Examples ==

Every if-statement is either $true or $false, depending on whether the statement is true or not. So, for example:

if (a [[If-Then-Else#.3D.3D|==]] b) { blah } ;in this case, 'blah' doesn't get executed because the if-statement is $false
if (3 [[If-Then-Else#.3C|<]] 7) { bleh } ;in this case, 'bleh' gets executed because the if-statement is $true
if ($true) { bluh } ;in this case, 'bluh' gets executed as $true is always true.

Quite many identifiers are used just to check whether something is true or not, for example [[$islower]] and [[$away]]. And to check that, there's an if-sentence even if it doesn't always look much like it. So actually, the following three lines are exactly the same, but the first one is just a 'shortcut' (and should actually never be used, the middle one is the preferred syntax).
if $away do_this
if ($away) { do_this }
if ($away == $true) { do_this }

[[Category:Other Identifiers]]

$cid

2005-12-05T02:50:16Z

Zyberdog:

Returns the server connection id for the current script.

$cid

* This identifier has no properties or parameters

== See also ==

* Some window identifiers have their own connection id counterpart, such as [[$activecid]] and [[$lactivecid]].
* Most [[:Category:Window Identifiers|window related identifers]] also have a .cid property.

[[Category:Identifiers]] [[Category:Multi-server]]

Category:Binary Files

2005-12-02T22:49:59Z

Zyberdog: added parent category

 

[[Category:MIRC Help]]

$isbit

2005-12-02T22:44:38Z

Zyberdog: added category

Returns 1 if the Nth bit in number A is turned on, otherwise 0 will be returned.
$isbit(A,N)

In the table below is information about bits, values and their binary representation
{|class="gallery"
|-
| style="width:100px" | '''''Binary''''' || '''''Value''''' || '''''Bit'''''
|-
| 00001 || 1 || 1
|-
| 00010 || 2 || 2
|-
| 00100 || 4 || 3
|-
| 01000 || 8 || 4
|-
| style="border:1px dotted #2f6fab; color: Black;" | 01101 || style="border:1px dotted #2f6fab; color: Black;" | 13 || style="border:1px dotted #2f6fab; color: Black;" | 1,3 and 4
|-
| 10000 || 16 || 5
|}

As you can see by the table above in the highlighted cells, if you have the value 13 it requires the 1st, 3rd and 4th bit to be turned on.
How we figure this out, is we take the 1st, 3rd and 4th bit and add them together 1+4+8 and this gives a value of 13.
Using the bits values 1,2,4,8 and 16 in this example it is impossible to get to 13 other than using 1,4 and 8.
This can be seen in the [[#Examples|example below]].

== Examples ==
[[var]] %i = 1
[[while]] (%i [[If-Then-Else#The_Operators|<=]] 13) {
[[echo]] -ag %i bit is [[$iif]]($isbit(13,%i),On,Off)
[[inc]] %i
}

== See also ==
*[[$and]]
*[[$biton]]
*[[$bitoff]]
*[[$not]]
*[[$or]]
*[[$xor]]

[[Category:Text and Number Identifiers]]

Timer

2005-12-02T22:29:58Z

Zyberdog: changed to wiki-pipe-tables

Activates the specified timer to perform the specified command at a specified interval, and optionally at a specified time.
/timer[N/name] [-ceomhipr] [time] <repetitions> <interval> <command>

If you are not connected to a server and a timer is started, it will be an offline timer by default, meaning that it will continue to run whether you are connected to a server on not. If you aren't connected to a server while starting a timer, it will be an online timer, that will stop if you disconnect. You can make a timer being an offline timer by using the -o switch.

To make a new timer, you can either use /timer without name/number or you can specify a name, without space between the command and the name (/timerfoo ...). If you do not specify a name/number, mIRC will get the first free timernumber it finds and use this.

If you specify a delay of 0 seconds, the timer will trigger immediately after the calling script ends.

You can also specify a time when the timer is supposed to trigger (see example below).

'''Note''' that if you specify 0 repetitions it will continue until you either stop it yourself or you disconnect, in case it is an online timer.

'''Note''' that identifiers usually '''do not''' get re-evaluated during a timer (see example below). To force this, you have to use an exclamation mark after the ''$'' of an identifier (e.g. [[$time|$!time]] or [[$me|$!me]])

You can '''stop''' a timer by using ''/timer<name|N> off'', which will also be able to handle wildcards in the name (see example below).

You can use the following switches:

{|
| width="10%" | '''''Switch''''' || width="90%" | '''''Explanation'''''
|-
| valign="top" | c || will make mIRC "catch up" a timer by executing it more than once during one interval if the real-time interval isn't matching your requested interval.
|-
| m / h || indicates that the interval delay is in milliseconds.
|-
| h || make a high-resolution multimedia timer (uses system resources heavily)
|-
| e || will executes the command associated with the specified timer name (works with wildcard names too).
|-
| p || will pause a timer
|-
| r || will resume a timer
|-
| valign="top" | i || will make a timer dynamically associate with whatever happens to be the active connection. If a server window is closed, the timer is associated with the next available server window.
|}

== Example ==
In the following, we'll always create an [[alias]] to be able to execute commands directly after creating the timer.

alias timertest {
timer 2 2 { [[echo]] -a moo! }
}
This alias just creates an timer that will echo ''moo!'' to your active window two times with a delay of 2 seconds.

alias timertest {
timer1 2 10 { echo -a [[$asctime|$!asctime]] }
timer2 2 10 { echo -a $asctime }
}
Here we create two timers, one with forcing it to re-evaluate the identifier (the one on top), the other not. You will see the first always echoing the current time, the other always echoing the time when it was started.

alias timertest {
timermilli -m 10 50 { echo -a The difference are 50 milliseconds. }
}
This timer called milli will echo ''The difference are 50 milliseconds.'' every 0,05 seconds to your active window, all in all 10 times.

alias timertest {
timertime 14:00 1 1 { echo -a It is 14:00 o'clock. }
}
This one will echo ''It is 14:00 o'clock.'' to the active window when it is 14oclock, as we made the timer trigger then.

timer1* off
We just stop all timers beginning with a 1.

== See Also ==
To stop all timers, take a look at [[timers|/timers]].

You can also get information about a timer, using the [[$timer]] identifier.

[[Category:Commands]]
[[Category:Timer Commands and Identifiers]]

Echo

2005-12-02T12:39:00Z

Zyberdog: changed to wiki-pipe-tables

Prints text in the specified window using the specified color.
/echo [color] [-cdeghiNtsaqlbfnmr] [color name] [#channel|[=]nick] <text>

{| style="width:100%"
|-
| style="width:10%" | '''''Switch''''' || style="width:90%" | '''''Meaning'''''
|-
| s || If a channel/nickname isn't specified, it echoes to the status window.
|-
| d || If a channel/nickname isn't specified, it echoes to the single message window.
|-
| a || If a channel/nickname isn't specified, it echoes to the active window.
|-
| e || Encloses the line in the line spearators.
|-
| iN || Indents the wrapped line by N characters.
|-
| h || Forces lines to hard-wrap so resizing the window doesn't change the line.
|-
| t || Prefixes the line with a timestamp if global time stamping is on or timestamping is on for that window.
|-
| q || Makes it not display the text if called from an alias using the . prefix.
|-
| l || Makes it apply the highlight settings to the line that's displayed.
|-
| bf || Make it apply the beep/flash settings in the window it is echoing to.
|-
| n || Prevents the echo from hiliting the window switchbar icon.
|-
| m || Indicates that the line should be treated as a user message, not an event.
|-
| g || Prevents the line from being logged to the log file.
|-
| r || Applies the strip settings in the messages dialog.
|-
| c || Uses the specified color name from the colors dialog.
|}

* '''Note''' that this text is only displayed in your own window and isn't sent to the server.

== Example ==
/echo -a moo
This will print moo to the active window.
/echo -sb moo
This will print moo to the status window and applies the beep setting in the window.
/echo 0 -g #help.script moo
This will print moo to the #help.script channel window in white with preventing it from logging to the log file.

== See Also ==
* Take a look on [[How do I customize mIRC's own output|How do I customize mIRC's own output]] by using echo at category [[:Category:Tutorials|Tutorials]].
* Take a look on [[Custom Windows]] to see how to print text to it.
[[Category:Commands]]
* [[Control_Codes]] for more information about colors.

If-Then-Else

2005-12-01T12:10:28Z

Zyberdog: /* isletter */

The If-then-else statement allows you to compare values and execute different parts of a script based on that comparison.

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 return
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 G is checked only if A or B were not triggered
H If none of previous wasn't matches, H is returned

== The Operators ==

[[#==|==]] equal to
[[#==|===]] equal to (case-sensitive)
[[#!=|!=]] not equal to
[[#<|<]] 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 internal ban list

[[#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).

=== != ===
if (cat != cAt) ;Returns false since != is case-insensitive and both values v1 and v2 are equal.
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.
The != and !== operators are the negates of the == and === operators.

=== < ===
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 less 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 multipul of 9.
Multipuls 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 multipul of 9.
\\ is the negate of //

=== & ===
=== isin ===
if (cat isin [[$1-]])
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 dont love you" since "dont 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 if, 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 ===
=== isalpha ===
=== islower ===
=== isupper ===
=== ison ===
=== isop ===
=== ishop ===
=== isvoice ===
=== isreg ===
=== ischan ===
=== isban ===
=== isaop ===
=== isavoice ===
=== isignore ===
=== isprotect ===
=== isnotify ===

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

== 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

'''NOTE''' this article covers only if-then-else '''string''' operators, so 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.

[[Category:Commands]]

If-Then-Else

2005-11-30T21:54:10Z

Zyberdog: /* isnum */

The If-then-else statement allows you to compare values and execute different parts of a script based on that comparison.

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 return
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 G is checked only if A or B were not triggered
H If none of previous wasn't matches, H is returned

== The Operators ==

[[#==|==]] equal to
[[#==|===]] equal to (case-sensitive)
[[#!=|!=]] not equal to
[[#<|<]] 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 internal ban list

[[#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).

=== != ===
if (cat != cAt) ;Returns false since != is case-insensitive and both values v1 and v2 are equal.
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.
The != and !== operators are the negates of the == and === operators.

=== < ===
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 less 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 multipul of 9.
Multipuls 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 multipul of 9.
\\ is the negate of //

=== & ===
=== isin ===
if (cat isin [[$1-]])
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 dont love you" since "dont 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 if, is it a number?, is it a number above 10?, is it a number between 20 and 30?

=== isletter ===
=== isalnum ===
=== isalpha ===
=== islower ===
=== isupper ===
=== ison ===
=== isop ===
=== ishop ===
=== isvoice ===
=== isreg ===
=== ischan ===
=== isban ===
=== isaop ===
=== isavoice ===
=== isignore ===
=== isprotect ===
=== isnotify ===

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

== 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

'''NOTE''' this article covers only if-then-else '''string''' operators, so 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.

[[Category:Commands]]

If-Then-Else

2005-11-30T21:51:38Z

Zyberdog: /* isnum */

The If-then-else statement allows you to compare values and execute different parts of a script based on that comparison.

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 return
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 G is checked only if A or B were not triggered
H If none of previous wasn't matches, H is returned

== The Operators ==

[[#==|==]] equal to
[[#==|===]] equal to (case-sensitive)
[[#!=|!=]] not equal to
[[#<|<]] 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 internal ban list

[[#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).

=== != ===
if (cat != cAt) ;Returns false since != is case-insensitive and both values v1 and v2 are equal.
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.
The != and !== operators are the negates of the == and === operators.

=== < ===
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 less 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 multipul of 9.
Multipuls 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 multipul of 9.
\\ is the negate of //

=== & ===
=== isin ===
if (cat isin [[$1-]])
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 dont love you" since "dont love" contains a space.

=== isnum ===

if ($1 isnum)

Statement is true if $1 is of numeric value

if ($1 isnum 10-)

Statement is true if $1 is number higher than 10

if ($1 isnum 20-30)

Statement is true if $1 is a number between 20 and 30

=== isletter ===
=== isalnum ===
=== isalpha ===
=== islower ===
=== isupper ===
=== ison ===
=== isop ===
=== ishop ===
=== isvoice ===
=== isreg ===
=== ischan ===
=== isban ===
=== isaop ===
=== isavoice ===
=== isignore ===
=== isprotect ===
=== isnotify ===

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

== 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

'''NOTE''' this article covers only if-then-else '''string''' operators, so 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.

[[Category:Commands]]

If-Then-Else

2005-11-30T21:47:55Z

Zyberdog: made the casesens operators link down aswell

The If-then-else statement allows you to compare values and execute different parts of a script based on that comparison.

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 return
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 G is checked only if A or B were not triggered
H If none of previous wasn't matches, H is returned

== The Operators ==

[[#==|==]] equal to
[[#==|===]] equal to (case-sensitive)
[[#!=|!=]] not equal to
[[#<|<]] 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 internal ban list

[[#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).

=== != ===
if (cat != cAt) ;Returns false since != is case-insensitive and both values v1 and v2 are equal.
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.
The != and !== operators are the negates of the == and === operators.

=== < ===
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 less 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 multipul of 9.
Multipuls 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 multipul of 9.
\\ is the negate of //

=== & ===
=== isin ===
if (cat isin [[$1-]])
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 dont love you" since "dont love" contains a space.

=== isnum ===
=== isletter ===
=== isalnum ===
=== isalpha ===
=== islower ===
=== isupper ===
=== ison ===
=== isop ===
=== ishop ===
=== isvoice ===
=== isreg ===
=== ischan ===
=== isban ===
=== isaop ===
=== isavoice ===
=== isignore ===
=== isprotect ===
=== isnotify ===

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

== 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

'''NOTE''' this article covers only if-then-else '''string''' operators, so 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.

[[Category:Commands]]

Set

2005-11-30T13:43:13Z

Zyberdog: fu saturn

Sets the value of %variable to the specified value.
/set [-lsnzuN] <%variable> [value]
{| style="width:100%"
|-
| style="width:10%" | '''''Switch''''' || Style="width:90%" | '''''Meaning'''''
|-
| l || Sets %var as a local variable, same as using /[[var]] (Deprecated, use /var)
|-
| s || Gives an output: * Set %var to value.
|-
| n || Treats value as plain text.
|-
| z || Decreases %var until it reaches zero and then unsets it.
|-
| uN || Unsets %var after N seconds, as long as %var isn't set again. If N is 0, it is unset when script finishes.
|}

== Example ==
set %fuu bar
set %moo [ $+ [ %fuu ] ] 42
This will set ''%fuu'' to ''bar'' and then set ''%moobar'' to ''42'', as the variable ''%fuu'' will first be evaluated to ''bar''.

set -u3 %fuu bar
This will set ''%fuu'' to ''bar'' and unset it after ''3'' seconds.

set -s %fuu 3
This will set ''%fuu'' to ''3'' and give an output to the active window: ''* Set %fuu to 3''

== See Also ==
[[Unset|/unset]] unsets a variable. 
[[Var|/var]] sets a local variable. 
[[Unsetall|/unsetall]] unsets all variable from the variable list.

[[Category:Commands]][[Category:Variables]]

Set

2005-11-30T13:41:52Z

Zyberdog: typo

Sets the value of %variable to the specified value.
/set [-lsnzuN] <%variable> [value]
{| style="width:100%"
|-
| style="width:10%" | '''''Switch''''' || Style="width:90%" | '''''Meaning'''''
|-
| l || Sets %var as a local variable, same as using /[[var]] (Depreciated, use /var)
|-
| s || Gives an output: * Set %var to value.
|-
| n || Treats value as plain text.
|-
| z || Decreases %var until it reaches zero and then unsets it.
|-
| uN || Unsets %var after N seconds, as long as %var isn't set again. If N is 0, it is unset when script finishes.
|}

== Example ==
set %fuu bar
set %moo [ $+ [ %fuu ] ] 42
This will set ''%fuu'' to ''bar'' and then set ''%moobar'' to ''42'', as the variable ''%fuu'' will first be evaluated to ''bar''.

set -u3 %fuu bar
This will set ''%fuu'' to ''bar'' and unset it after ''3'' seconds.

set -s %fuu 3
This will set ''%fuu'' to ''3'' and give an output to the active window: ''* Set %fuu to 3''

== See Also ==
[[Unset|/unset]] unsets a variable. 
[[Var|/var]] sets a local variable. 
[[Unsetall|/unsetall]] unsets all variable from the variable list.

[[Category:Commands]][[Category:Variables]]

Set

2005-11-30T13:41:17Z

Zyberdog:

Sets the value of %variable to the specified value.
/set [-lsnzuN] <%variable> [value]
{| style="width:100%"
|-
| style="width:10%" | '''''Switch''''' || Style="width:90%" | '''''Meaning'''''
|-
| l || Sets %var as a local variable, same as using /[[var]] (Depreceated, use /var)
|-
| s || Gives an output: * Set %var to value.
|-
| n || Treats value as plain text.
|-
| z || Decreases %var until it reaches zero and then unsets it.
|-
| uN || Unsets %var after N seconds, as long as %var isn't set again. If N is 0, it is unset when script finishes.
|}

== Example ==
set %fuu bar
set %moo [ $+ [ %fuu ] ] 42
This will set ''%fuu'' to ''bar'' and then set ''%moobar'' to ''42'', as the variable ''%fuu'' will first be evaluated to ''bar''.

set -u3 %fuu bar
This will set ''%fuu'' to ''bar'' and unset it after ''3'' seconds.

set -s %fuu 3
This will set ''%fuu'' to ''3'' and give an output to the active window: ''* Set %fuu to 3''

== See Also ==
[[Unset|/unset]] unsets a variable. 
[[Var|/var]] sets a local variable. 
[[Unsetall|/unsetall]] unsets all variable from the variable list.

[[Category:Commands]][[Category:Variables]]

Set

2005-11-30T13:39:37Z

Zyberdog: added l parameter. changed to use wikipipe tables

Sets the value of %variable to the specified value.
/set [-lsnzuN] <%variable> [value]
{| style="width:100%"
|-
| style="width:10%" | '''''Switch''''' || Style="width:90%" | '''''Meaning'''''
|-
| l || Sets %var as a local variable, same as using /[[var]]
|-
| s || Gives an output: * Set %var to value.
|-
| n || Treats value as plain text.
|-
| z || Decreases %var until it reaches zero and then unsets it.
|-
| uN || Unsets %var after N seconds, as long as %var isn't set again. If N is 0, it is unset when script finishes.
|}

== Example ==
set %fuu bar
set %moo [ $+ [ %fuu ] ] 42
This will set ''%fuu'' to ''bar'' and then set ''%moobar'' to ''42'', as the variable ''%fuu'' will first be evaluated to ''bar''.

set -u3 %fuu bar
This will set ''%fuu'' to ''bar'' and unset it after ''3'' seconds.

set -s %fuu 3
This will set ''%fuu'' to ''3'' and give an output to the active window: ''* Set %fuu to 3''

== See Also ==
[[Unset|/unset]] unsets a variable. 
[[Var|/var]] sets a local variable. 
[[Unsetall|/unsetall]] unsets all variable from the variable list.

[[Category:Commands]][[Category:Variables]]

Local Variables

2005-11-30T13:31:12Z

Zyberdog: added see also (/set)

Local variables are variables that exist only for the duration of the piece of script (for example an alias or event) in which they are created, and can only be accessed from within ''that'' piece of script - not from other anywhere else, not even from the aliases that the piece of script calls. Local variables are removed automatically when the piece of script is finished, so it is not required to /[[unset]] them. Local variables are very useful for storing short-lived data, such as loop counters and temporary results.

Local variables can be created with the /var command:
var %myvar = somevalue

Note that a local variable and a global variable (created with /[[set]]) with the same name may exist; in that case, the local variable will be used in the piece of script, and the global variable will not be changed.

You can set multiple variables at once:
var %x = foo, %y = bar

Although the '=' can be left out from the /var command in some cases, it is bad practice to do so: it can lead to weird errors in other lines.

You can use /var -s to make a variable show the result when a value is set.

Do not use /var to create local variables with a dynamic name (e.g. ''%x [ $+ [ %y ] ]''), there is a bug in mIRC that prevents you from doing this.

== Examples ==

First, let's create an [[Aliases|alias]] that's used later on.
alias var_example { var -s %x = foo | set -s %y bar }

Now, let's play around.

; set values to variables with set so values exists until they're unset
set %x 10
set %y %x
; value from %x is copied to %y

; call of your own alias
var_example
; displays
; * Set %x to foo
; * Set %y to bar

; now, let's display %x and %y values
[[echo]] -a %x
; returns 10
echo -a %y
; returns bar

As we can see, %x still holds its original value because /var only creates a local variable, but %y was overwritten with /set.

== See Also ==

[[Set|/set]] is used when you want variables that exist between routines and aliases, call it global variables.

{{Author|Tovrleaf}}

[[Category:Variables]]

If-Then-Else

2005-11-30T13:21:11Z

Zyberdog: test - modify at will.

If-Then-Else

2005-11-30T13:13:23Z

Zyberdog: streamlined

$asc

2005-11-29T21:02:13Z

Zyberdog: typo

Returns the ascii number of the character C.
$asc(C)

== Example ==
echo -a $asc(A) ; returns ''65''.

To get the ascii value of a character, just type:
//echo -a $asc([[$?]])
Type the character you want the ascii value of in the prompt and press enter.
== See Also ==
[[$chr]] returns the character of an ascii number.

[[Category:Text_and_Number_Identifiers]]

Timers

2005-11-27T23:15:47Z

Zyberdog:

Shows or stops all active timers.
/timers [off]

Using /timers will show you all active timers, having the following format:
* Active timers:
* Timer <name> <seconds>s delay <commands to execute> (<network>)
* Timer <name> <seconds>s delay <commands to execute> (<network>)
-

If you use /timers off, it will stop all active timers and echo: ''* All timers halted''

[[Category:Commands]][[Category:Timer Commands and Identifiers]]

$timer

2005-11-27T23:14:35Z

Zyberdog:

Returns information about a timer.
$timer(N/name)

Returns the timer id of the Nth timer in the timers list or the one you have specified by its name.

$timer has the following properties:
<table>
<tr><td width="10%">property</td><td width="90%">explanation</td></tr>
<tr><td>com</td><td>returns the command</td></tr>
<tr><td>time</td><td>returns the time when the timer will be triggered (if you have specified one)</td></tr><tr><td>reps</td><td>returns the repetitions the timer will have</td></tr>
<tr><td>delay</td><td>returns the delay between two triggers</td></tr>
<tr><td>type</td><td>returns online/offline status</td></tr>
<tr><td>secs</td><td>returns number of seconds left before timer is triggered</td></tr>
<tr><td>mmt</td><td>returns $true if timer is a multimedia timer</td></tr>
<tr><td>anysc</td><td>returns $true if the /timer -i switch was specified</td></tr>
<tr><td valign="top">wid</td><td>returns window id of the window it was issued in, if this is done remotly, it's the window id of the status window of the connection the timer is related to</td></tr>
<tr><td>cid</td><td>returns connection id of the timer</td></tr>
<tr><td valign="top">hwnd</td><td>returns the handle window of the window it was issued in, if this is done remotly, it's the hwnd of the status window of the connection the timer is related to</td></tr>
</table>

== Example ==
[[alias]] timertest {
[[timer]]foo 1 10 { [[echo]] -a moo }
echo -a $timer(foo).com
echo -a $timer(foo).delay
[[if]] ($timer(foo).mmt) { echo -a timer foo is a multimedia timer }
else { echo -a timer foo is no multimedia timer }
}
This example will create an alias called timertest. The alias will at first make a new timer called ''foo'' and then echo some information about it. After ten seconds, you will get a "moo" in your active window, as the timer has been triggered then.

[[Category:Timer Commands and Identifiers]]