Local Variables - Revision history

Vliedel at 18:21, 30 January 2011

2011-01-30T18:21:33Z

← Older revision		Revision as of 18:21, 30 January 2011
Line 47:		Line 47:

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

Cail at 08:25, 2 July 2007

2007-07-02T08:25:36Z

← Older revision		Revision as of 08:25, 2 July 2007
Line 42:		Line 42:

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

	{{Author\|Tovrleaf}}		{{Author\|Tovrleaf}}

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

Zyberdog: added see also (/set)

2005-11-30T13:31:12Z

added see also (/set)

← Older revision		Revision as of 13:31, 30 November 2005
Line 40:		Line 40:

	As we can see, %x still holds its original value because /var only creates a local variable, but %y was overwritten with /set.		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}}		{{Author\|Tovrleaf}}

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

Saturn: rewrite

2005-11-10T14:50:06Z

rewrite

← Older revision		Revision as of 14:50, 10 November 2005
Line 1:		Line 1:
	Local variables are variables that exist only for the duration of the script in which they are created and can only be accessed from within that script. ~~They can be created with~~ the /~~var command~~.		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.

	~~Var creates the local variable in the current routine and~~ can ~~only~~ be ~~referenced from inside this routine.~~		Local variables can be created with the /var command:
			var %myvar = somevalue

	~~The difference between~~ /~~var and~~ [[set]] is that ~~var creates~~ local variable ~~what only exists while~~ script ~~is executed. Set sets value to~~ variable ~~and stores it there until it's [[unset]]. Local variables don't overwrite variables set with "set" command values~~.		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 ~~multible~~ variables ~~with one set~~		You can set multiple variables at once:
	var %x = foo, %y = bar		var %x = foo, %y = bar

	~~Usage of~~ = in ~~syntax~~ is ~~usually optional, but highly recommended~~		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.
	~~var %x foo~~

	You can use /var -s to make a variable show the result when a value is set.		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 ==		== Examples ==

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

	Now, let's play around.		Now, let's play around.

Microbe: minor tweaking

2005-11-10T14:17:40Z

minor tweaking

← Older revision		Revision as of 14:17, 10 November 2005
Line 3:		Line 3:
	Var creates the local variable in the current routine and can only be referenced from inside this routine.		Var creates the local variable in the current routine and can only be referenced from inside this routine.

	The difference between /var and [[/set]] is that var creates local variable what only exists while script is executed. Set sets value to variable and stores it there until it's [[unset]]. Local variables ~~doesn~~'t overwrite variables set with "set" command values.		The difference between /var and [[set]] is that var creates local variable what only exists while script is executed. Set sets value to variable and stores it there until it's [[unset]]. Local variables don't overwrite variables set with "set" command values.

	You can set multible variables with one set		You can set multible variables with one set
	var %x = foo, %y = bar		var %x = foo, %y = bar

	Usage of = in syntax is optional		Usage of = in syntax is usually optional, but highly recommended
	var %x foo		var %x foo

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

	== ~~Example~~ ==		== Examples ==

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

Line 23:		Line 23:
	set %x 10		set %x 10
	set %y %x		set %y %x
	; value ~~fro~~ %x is ~~copyed~~ to %y ~~(for users from with previous knowledge from scripting)~~		; value from %x is copied to %y

	; call of your own alias		; call of your own alias
Line 34:		Line 34:
	[[echo]] -a %x		[[echo]] -a %x
	; returns 10		; returns 10
	[[echo]] -a %y		echo -a %y
	; returns bar		; returns bar

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

	{{Author\|Tovrleaf}}		{{Author\|Tovrleaf}}

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

Tovrleaf at 18:37, 31 August 2005

2005-08-31T18:37:52Z

← Older revision		Revision as of 18:37, 31 August 2005
Line 38:		Line 38:

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

			{{Author\|Tovrleaf}}

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

Tovrleaf at 16:00, 25 August 2005

2005-08-25T16:00:06Z

← Older revision		Revision as of 16:00, 25 August 2005
Line 1:		Line 1:
	== Local ~~Variables ==~~		Local variables are variables that exist only for the duration of the script in which they are created and can only be accessed from within that script. They can be created with the /var command.

	Var creates the local variable in the current routine and can only be referenced from inside this routine.		Var creates the local variable in the current routine and can only be referenced from inside this routine.

Tovrleaf at 15:59, 25 August 2005

2005-08-25T15:59:31Z

New page

== Local Variables ==

Var creates the local variable in the current routine and can only be referenced from inside this routine.

The difference between /var and [[/set]] is that var creates local variable what only exists while script is executed. Set sets value to variable and stores it there until it's [[unset]]. Local variables doesn't overwrite variables set with "set" command values.

You can set multible variables with one set
var %x = foo, %y = bar

Usage of = in syntax is optional
var %x foo

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

== Example ==

First, let's create [[Aliases|alias]] needed 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 fro %x is copyed to %y (for users from with previous knowledge from scripting)

; 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 it origial value because /var creates only local variable, but %y was overwritten with /set.

[[Category:Variables]]