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 61: | Line 60: | ||
'''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 equal sign '=' == | == The equal sign '=' == | ||
− | Although it's not required | + | Although it's not required since 6.21, the equal sign can be used to assign a value to a variable without actually using a command: |
<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 133: | Line 121: | ||
You can do one math operation with variable when setting a value. | You can do one math operation with variable when setting a value. | ||
− | The operators supported are: '+' '-' '/' '*' '%' '^' where % | + | The operators supported are: '+' '-' '/' '*' '%' '^' where % id the modulus and ^ is power. |
− | You must use a space around all | + | You must use a space around all parameters and you must provide correct values, numbers can be float. |
− | If you don't respect the format, it will set the value as plain text, use -n | + | If you don't respect the format, it will set the value as plain text, use -n to override this behavior when dynamic content. |
− | |||
− | |||
For Example: | For Example: | ||
Line 187: | Line 173: | ||
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 182: | ||
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 199: | ||
# 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 216: | ||
'''Dynamic Variables''' | '''Dynamic Variables''' | ||
− | + | Retrieving a value from a dynamic variable is a little bit more complicated. There is two ways: | |
− | Retrieving a value from a dynamic variable is a little bit more complicated. There | ||
− | |||
− | |||
<syntaxhighlight lang="mirc">%<static> [ $+ [ <dynamic> ] ]</syntaxhighlight> | <syntaxhighlight lang="mirc">%<static> [ $+ [ <dynamic> ] ]</syntaxhighlight> | ||
Line 285: | Line 266: | ||
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.''. | ||
− | + | You can also get the value of a dynamic variable by using [[$eval - Identifier|$eval]], $eval allows you to force an expression to evaluate more than once, a bit like the brackets [ ], but brackets are meant to alter the order of evaluation of a line, which itself can have its own drawbacks. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | You can also get the value of a dynamic variable by using | ||
− | |||
− | $eval allows you to force an expression to evaluate more than once, a bit like the brackets [ ], but brackets are meant to alter the order of evaluation of a line, which itself can have its own drawbacks. | ||
− | |||
<syntaxhighlight lang="mirc">$eval($+(%,<static>,<dynamic>),2)</syntaxhighlight>From our earlier example: | <syntaxhighlight lang="mirc">$eval($+(%,<static>,<dynamic>),2)</syntaxhighlight>From our earlier example: | ||
<syntaxhighlight lang="mirc">var %color = %color. [ $+ [ $2 ] ]</syntaxhighlight> | <syntaxhighlight lang="mirc">var %color = %color. [ $+ [ $2 ] ]</syntaxhighlight> | ||
is the same as | is the same as | ||
<syntaxhighlight lang="mirc">var %color = $eval($+(%,color.,$2),2)</syntaxhighlight>$+(%,color.,$2) will produce the plain text "%color.John", and that is then evaluated a second time (the 2 in $eval(,2)) to produce the value of the variable just like usual. Note that with the brackets method, you also get a double evaluation, but they happen at a different levels. | <syntaxhighlight lang="mirc">var %color = $eval($+(%,color.,$2),2)</syntaxhighlight>$+(%,color.,$2) will produce the plain text "%color.John", and that is then evaluated a second time (the 2 in $eval(,2)) to produce the value of the variable just like usual. Note that with the brackets method, you also get a double evaluation, but they happen at a different levels. | ||
− | |||
− | |||
− | |||
− | |||
== Special behaviors & quirks == | == Special behaviors & quirks == | ||
Line 315: | Line 276: | ||
Variables routines are a bit special because usually, the first argument given to a variables related command is a variable name, yet mIRC doesn't evaluate it. | Variables routines are a bit special because usually, the first argument given to a variables related command is a variable name, yet mIRC doesn't evaluate it. | ||
− | Indeed if //echo %var would display its content, it's because %var is evaluated and then passed as the parameter to the /echo command. % | + | Indeed if //echo %var would display its content, it's because %var is evaluated and then passed as the parameter to the /echo command. //var %var is obviously not doing that otherwise the content of the variable or $null would be passed to it. So mIRC, on purpose doesn't evaluate the variable name, but it will fail to do so in some case, when the arguments are dynamically passed for example: |
− | + | <syntaxhighlight lang="mirc">//set -u $+ %var %setting</syntaxhighlight>which should set %setting but won't, because it gets evaluated, you need to use % $+ setting here, /inc & /dec are most likely affected the same way, note that the syntax "%var = value" without a command is the same as /set but doesn't have this issue. | |
− | |||
− | |||
− | |||
− | <syntaxhighlight lang="mirc">// | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | is | ||
− | |||
− | |||
− | |||
− | |||
− | + | /unset also suffers from an evaluation problem, due to its ability to unset more than one variable on the same line, there is an issue when trying to unset a variable dynamically from a variable: | |
− | + | <syntaxhighlight lang="mirc">//var -s %a a,%b b,%ab,%a%b | unset -s %a $+ %b</syntaxhighlight>You might expect this to evaluate %b and stick its content to plain text "%a", just like in //var -s %a $+ %b, but it won't, mIRC won't evaluate %b at all thinking it's a variable you want to evaluate, unsetting the wrong %a%b instead of %ab. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | <syntaxhighlight lang="mirc">//var -s %a a,%b b,%ab,%a%b | unset -s %a $+ %b</syntaxhighlight>You might expect this to evaluate %b and stick its content to plain text "%a", just like in / | ||
To workaround this problem, you must use evaluation brackets to force the evaluation: | To workaround this problem, you must use evaluation brackets to force the evaluation: | ||
<syntaxhighlight lang="mirc">//var -s %a a,%b b,%ab,%a%b | unset -s %a $+ [ %b ]</syntaxhighlight> | <syntaxhighlight lang="mirc">//var -s %a a,%b b,%ab,%a%b | unset -s %a $+ [ %b ]</syntaxhighlight> | ||
− | + | If most commands cannot preserve spaces, /var can preserve spaces in all situations except if you provide a single trailing space: | |
+ | <syntaxhighlight lang="mirc">//var -s %a $+($chr(32),a,$chr(32),$chr(32),b,$chr(32),$chr(32)),%b $+($chr(32),a,$chr(32),$chr(32),b,$chr(32)) | echo -a $len(%a) $len(%b)</syntaxhighlight>which is displaying 7 5 instead of 7 6 (there is one less space at the end, which is lost because it's a single trailing space) | ||
− | |||
− | |||
− | |||
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]] |