From WikiChip
Editing mirc/variables
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
This page supports semantic in-text annotations (e.g. "[[Is specified as::World Heritage Site]]") to build structured and queryable content provided by Semantic MediaWiki. For a comprehensive description on how to use annotations or the #ask parser function, please have a look at the getting started, in-text annotation, or inline queries help pages.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
− | {{ | + | {{Template:mIRC Guide}} |
+ | |||
'''mIRC variables''' are items which can hold data temporarily, or permanently, for use at a later time.. You can create, edit, or delete them at any time. All mIRC variables must be prefixed with a % sigil (example %var or %cookies). Variables are untyped – therefore capable of storing letters, numbers, or strings at any given point. | '''mIRC variables''' are items which can hold data temporarily, or permanently, for use at a later time.. You can create, edit, or delete them at any time. All mIRC variables must be prefixed with a % sigil (example %var or %cookies). Variables are untyped – therefore capable of storing letters, numbers, or strings at any given point. | ||
Line 8: | Line 9: | ||
=== Local Variables === | === Local Variables === | ||
− | '''Local Variables''' are given local scope. They are created for the duration of the | + | '''Local Variables''' are given local scope. They are created for the duration of the script that made them and they can only be accessed from within the code line, or block in which they were created in. Once the script has finished, the variable is deleted. |
− | |||
− | |||
Syntax: | Syntax: | ||
Line 20: | Line 19: | ||
var %a = value, %b = second value, %c = and so on and so forth</syntaxhighlight> | var %a = value, %b = second value, %c = and so on and so forth</syntaxhighlight> | ||
− | '''Note''': Since mIRC 6.21, you can avoid using the = sign when using the /var | + | '''Note''': Since mIRC 6.21, you can avoid using the = sign when using the /var commmand. |
Local variables are good for temporary things like string manipulations and math expressions. Most of your code will use local variables. | Local variables are good for temporary things like string manipulations and math expressions. Most of your code will use local variables. | ||
Line 62: | Line 61: | ||
'''Practical use:''' a global variable is good for storing variables that you will need to use in the future from another script or at different time. (Login System, Away System, Sockets, Etc...) | '''Practical use:''' a global variable is good for storing variables that you will need to use in the future from another script or at different time. (Login System, Away System, Sockets, Etc...) | ||
− | == | + | ==== The equel sign '=' ==== |
− | |||
− | |||
− | + | Although it's not require since 6.21, the equel sign can be used to assign a value to a variable. | |
− | |||
− | Although it's not | ||
<syntaxhighlight lang="mirc">%var = value</syntaxhighlight> | <syntaxhighlight lang="mirc">%var = value</syntaxhighlight> | ||
If %var is local, this will change the local variable. | If %var is local, this will change the local variable. | ||
Line 86: | Line 81: | ||
unset %var1 %var2 %var3</syntaxhighlight> | unset %var1 %var2 %var3</syntaxhighlight> | ||
− | The /unset command supports | + | The /unset command supports wildcard characters to be able to unset multiple variables. For example: |
<syntaxhighlight lang="mirc">alias unsetWildExample { | <syntaxhighlight lang="mirc">alias unsetWildExample { | ||
set %exampleHello hello there | set %exampleHello hello there | ||
− | set % | + | set %exampleTest another var |
set %exampleVar yet another var | set %exampleVar yet another var | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
;unset all of them | ;unset all of them | ||
unset %example* | unset %example* | ||
}</syntaxhighlight> | }</syntaxhighlight> | ||
− | |||
You can also unset all of the variables using the '''/unsetall''' command. | You can also unset all of the variables using the '''/unsetall''' command. | ||
Line 115: | Line 103: | ||
; make sure our variable doesn't exist | ; make sure our variable doesn't exist | ||
unset %example1 | unset %example1 | ||
− | if (% | + | if (%example == $null) { |
echo -a % $+ example1 is null! | echo -a % $+ example1 is null! | ||
} | } | ||
Line 131: | Line 119: | ||
== Math Operations == | == Math Operations == | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | The standard assignment operator (=) can also be used to do basic two-operand math operations. | |
For Example: | For Example: | ||
Line 154: | Line 135: | ||
}</syntaxhighlight> | }</syntaxhighlight> | ||
− | |||
mIRC has two additional commands that can be used to easily increase and decrease the value of a numerical variable. | mIRC has two additional commands that can be used to easily increase and decrease the value of a numerical variable. | ||
Line 187: | Line 167: | ||
In many occasions you may need to save individualized data (data for a particular user or channel for example). Dynamic variables allow you to do just that. A dynamic variable's name usually consists of a static part (a part that doesn't change) and a dynamic part (the part that changes). | In many occasions you may need to save individualized data (data for a particular user or channel for example). Dynamic variables allow you to do just that. A dynamic variable's name usually consists of a static part (a part that doesn't change) and a dynamic part (the part that changes). | ||
− | === | + | === Saving Values === |
− | The basic syntax to | + | The basic syntax to save a dynamic variable is: |
<syntaxhighlight lang="mirc">set %<static_part> $+ <dynamic_part> | <syntaxhighlight lang="mirc">set %<static_part> $+ <dynamic_part> | ||
Line 196: | Line 176: | ||
Although you can omit the static part out, its strongly discouraged because variables should have a meaningful name that explains their purpose. | Although you can omit the static part out, its strongly discouraged because variables should have a meaningful name that explains their purpose. | ||
− | |||
− | |||
Let's take a look at an example: | Let's take a look at an example: | ||
Line 215: | Line 193: | ||
# mIRC evaluates the identifier $nick to "John" and $2 to blue<br /><syntaxhighlight lang="mirc">set %color. $+ John blue</syntaxhighlight> | # mIRC evaluates the identifier $nick to "John" and $2 to blue<br /><syntaxhighlight lang="mirc">set %color. $+ John blue</syntaxhighlight> | ||
# mIRC will then append "John" to "%color." Before executing the /set command, thus the final variable looks like this:<br /><syntaxhighlight lang="mirc">%color.John blue</syntaxhighlight> | # mIRC will then append "John" to "%color." Before executing the /set command, thus the final variable looks like this:<br /><syntaxhighlight lang="mirc">%color.John blue</syntaxhighlight> | ||
+ | |||
=== Retrieving Values === | === Retrieving Values === | ||
'''Static Variables''' | '''Static Variables''' | ||
− | |||
Retrieving values from static variables is pretty straightforward. Let's assume you have a variable called ''%myvar'' and it's value is '''abc''', you can get this value simply by referring to the variable outright: | Retrieving values from static variables is pretty straightforward. Let's assume you have a variable called ''%myvar'' and it's value is '''abc''', you can get this value simply by referring to the variable outright: | ||
Line 232: | Line 210: | ||
'''Dynamic Variables''' | '''Dynamic Variables''' | ||
− | + | Retrieving a value from a dynamic variable is a little bit more complicated. The basic syntax is as follows: | |
− | Retrieving a value from a dynamic variable is a little bit more complicated. | ||
− | |||
− | |||
<syntaxhighlight lang="mirc">%<static> [ $+ [ <dynamic> ] ]</syntaxhighlight> | <syntaxhighlight lang="mirc">%<static> [ $+ [ <dynamic> ] ]</syntaxhighlight> | ||
− | + | The '''evaluation brackets''', both '''[''' and ''']''', are an essential part of retrieving the value from a dynamic variable. They allow us to force mIRC to evaluate part of a statement before anything else. Take a look at the rest of the myColor script: | |
<syntaxhighlight lang="mirc">on *:text:!favColor *:#:{ | <syntaxhighlight lang="mirc">on *:text:!favColor *:#:{ | ||
Line 247: | Line 222: | ||
} | } | ||
else { | else { | ||
− | notice $nick $2 | + | notice $nick $2 does't have a favorite color set yet. |
} | } | ||
}</syntaxhighlight> | }</syntaxhighlight> | ||
Line 285: | Line 260: | ||
What this does is create a bunch of static variables, each with ascending-ordered numerical digits. You will notice we used the evaluation brackets around the variable counter, ''%x''. This allows mIRC to evaluate the variable, and attach it to the static portion of ''%array.''. Basically, during run-time, whatever the ''%x'' variable's value is will be automatically appended to ''%array.''. | What this does is create a bunch of static variables, each with ascending-ordered numerical digits. You will notice we used the evaluation brackets around the variable counter, ''%x''. This allows mIRC to evaluate the variable, and attach it to the static portion of ''%array.''. Basically, during run-time, whatever the ''%x'' variable's value is will be automatically appended to ''%array.''. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
Variables are a great resource to have at your fingertips within mIRC! As you've seen, they are very powerful, and yet don't require too much of a headache to understand :) | Variables are a great resource to have at your fingertips within mIRC! As you've seen, they are very powerful, and yet don't require too much of a headache to understand :) | ||
− | [[Category:mIRC | + | [[Category:mIRC]] |