Category:Aliases - Revision history

Daveoh: explained $prop

2009-11-29T16:27:26Z

explained $prop

← Older revision		Revision as of 16:27, 29 November 2009
Line 122:		Line 122:

	=== Forced identifiers ===		=== Forced identifiers ===
	To force an alias to be an identifier ~~-- it can't be used as a command --~~ or vice versa you can use the identifier [[$isid]].		To force an alias to be used only as an identifier or vice versa, you can use the identifier [[$isid]]. This will return [[$true]] if the alias was called as an $identifier or [[$false]] if it was called as a /command.
	; this alias can only be called as an identifier		; this alias can only be called as an identifier
	[[alias]] qnet {		[[alias]] qnet {
Line 132:		Line 132:
	}		}
	Calling the alias will result in a return value of either 0 or 1, while calling it as a command will do completely nothing.		Calling the alias will result in a return value of either 0 or 1, while calling it as a command will do completely nothing.

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

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

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

	[[Category:mIRC_Help]]		[[Category:mIRC_Help]]

Aca20031: Someone mixed up the link and the alias

2008-10-04T20:04:39Z

Someone mixed up the link and the alias

← Older revision		Revision as of 20:04, 4 October 2008
Line 15:		Line 15:

	* When you give an alias used as a command the same name as an existing mIRC command, your alias gets preference.		* When you give an alias used as a command the same name as an existing mIRC command, your alias gets preference.
	* Some inbuilt commands act differently than the rest, if you have an alias called [[timertest~~\|Timer~~]], you will not be able to start a timer called test, like this: /timertest 0 1 MyTestFunction in this situation you can prefix the command with an exclamation mark (!) as shown below in the example.		* Some inbuilt commands act differently than the rest, if you have an alias called [[timer\|timertest]], you will not be able to start a timer called test, like this: /timertest 0 1 MyTestFunction in this situation you can prefix the command with an exclamation mark (!) as shown below in the example.
	* When you give an alias used as an identifier the same name as an existing mIRC identifier, mIRC's identifier gets preference, unless you prefix your alias with a period.		* When you give an alias used as an identifier the same name as an existing mIRC identifier, mIRC's identifier gets preference, unless you prefix your alias with a period.

Cail at 08:23, 2 July 2007

2007-07-02T08:23:06Z

← Older revision		Revision as of 08:23, 2 July 2007
Line 133:		Line 133:
	Calling the alias will result in a return value of either 0 or 1, while calling it as a command will do completely nothing.		Calling the alias will result in a return value of either 0 or 1, while calling it as a command will do completely nothing.

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

	[[Category:mIRC_Help]]		[[Category:mIRC_Help]]

Doomie: /* Naming aliases */

2006-04-25T13:04:15Z

Naming aliases

← Older revision		Revision as of 13:04, 25 April 2006
Line 35:		Line 35:
	timertest		timertest

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

Doomie: perhaps like this?

2006-04-25T13:01:08Z

perhaps like this?

← Older revision		Revision as of 13:01, 25 April 2006
Line 19:		Line 19:

	Example:		Example:

			; at first we add a new alias called "me". If it is used as "$me", it's supposed to return "AveIT!", else it's the usual
			; /me alias sending an action to the active channel
	/alias me { [[If-Then-Else\|if]] ([[$isid]]) { [[return]] AveIT! } \| else { [[describe]] [[$active]] [[$1-]] } }		/alias me { [[If-Then-Else\|if]] ([[$isid]]) { [[return]] AveIT! } \| else { [[describe]] [[$active]] [[$1-]] } }
	/alias timertest { if (!%timerstart) [[set]] %timerstart [[$ticks]] \| else { echo -ag [[$calc]]($ticks - %timerstart) ms \| unset %timerstart } }
			; this alias will return the amount of milliseconds (ticks) pasted between two callings.
			; When called the first time, it will set a variable %timerstart to the current value of $ticks.
			; When called the second time, it echo's the difference between the set variable and the current value of ticks.
			; This difference is obviously the elapsed time.
			/alias timertest { if (!%timerstart) [[set]] %timerstart [[$ticks]] \| else { echo -ag [[$calc]]($ticks - %timerstart) ms \| unset %timerstart } }

	~~Here~~, the ~~$isid identifer is checked to make sure we~~'~~re calling $~~me and ~~not /me, if we are calling /me make sure we do /describe to~~ the ~~active channel with the parameters supplied.~~		In the following example, both the custom 'me' and the 'timertest' alias will be used:

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

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

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

	~~This should~~ return:		Finally, the example above would return:

	I am Dana but my custom identifer returns AveIT!		I am Dana but my custom identifer returns AveIT!
	16 ms		16 ms
	~~This is because $me returns the internal mIRC identifer, which is your current nickname, whereas $.me returns your custom alias.~~

	'''''Note:''''' If you want to start a timer called test with the alias called timertest, you have to prefix the timer with the ! to use the inbuilt mIRC timer command:		'''''Note:''''' If you want to start a timer called test with the alias called timertest, you have to prefix the timer with the ! to use the inbuilt mIRC timer command:

Albie: /* Naming aliases */

2006-04-25T12:45:08Z

Naming aliases

← Older revision		Revision as of 12:45, 25 April 2006
Line 31:		Line 31:
	I am Dana but my custom identifer returns AveIT!		I am Dana but my custom identifer returns AveIT!
	16 ms		16 ms
			This is because $me returns the internal mIRC identifer, which is your current nickname, whereas $.me returns your custom alias.

	'''''Note:''''' If you want to start a timer called test with the alias called timertest, you have to prefix the timer with the ! to use the inbuilt mIRC timer command:		'''''Note:''''' If you want to start a timer called test with the alias called timertest, you have to prefix the timer with the ! to use the inbuilt mIRC timer command:

Albie: /* Naming aliases */

2006-04-25T12:40:11Z

Naming aliases

← Older revision		Revision as of 12:40, 25 April 2006
Line 32:		Line 32:
	16 ms		16 ms

	'''''Note:''''' If you want to start a timer called test with the alias called timertest, you have to prefix the timer with the ! to use the inbuilt mIRC timer command:		'''''Note:''''' If you want to start a timer called test with the alias called timertest, you have to prefix the timer with the ! to use the inbuilt mIRC timer command:
	!timertest 1 1 echo -ag This is my test.		!timertest 1 1 echo -ag This is my test.
	It is not encouraged to call an alias starting with timer, or identifers with mircdir, getdir, mididir, or any other alias which can be used with a suffix.		It is not encouraged to call an alias starting with timer, or identifers with mircdir, getdir, mididir, or any other alias which can be used with a suffix.

	== Aliases: parameters and events ==		== Aliases: parameters and events ==

Albie: /* Naming aliases */

2006-04-25T12:38:56Z

Naming aliases

← Older revision		Revision as of 12:38, 25 April 2006
Line 23:		Line 23:

	Here, the $isid identifer is checked to make sure we're calling $me and not /me, if we are calling /me make sure we do /describe to the active channel with the parameters supplied.		Here, the $isid identifer is checked to make sure we're calling $me and not /me, if we are calling /me make sure we do /describe to the active channel with the parameters supplied.

	timertest		timertest
	echo -ag I am $me but my custom identifer returns $.me		echo -ag I am $me but my custom identifer returns $.me
	timertest		timertest

	This should return:		This should return:
	I am Dana but my custom identifer returns AveIT!		I am Dana but my custom identifer returns AveIT!

Microbe: one space missing

2006-04-25T12:20:56Z

one space missing

← Older revision		Revision as of 12:20, 25 April 2006
Line 4:		Line 4:
	=== Example ===		=== Example ===
	; These two work exactly the same way although they are stored in different places		; These two work exactly the same way although they are stored in different places

	; this is placed in the "Aliases" section		; this is placed in the "Aliases" section
	moo { [[echo]] -ag moo }		moo { [[echo]] -ag moo }

Microbe: removed plenty of extra links, fixed typos etc small

2006-04-25T12:19:51Z

removed plenty of extra links, fixed typos etc small

← Older revision		Revision as of 12:19, 25 April 2006
Line 3:		Line 3:

	=== Example ===		=== Example ===
			; These two work exactly the same way although they are stored in different places

	; this is placed in the "Aliases" section		; this is placed in the "Aliases" section
	moo { [[echo]] -ag moo }		moo { [[echo]] -ag moo }
Line 10:		Line 12:

	== Naming aliases ==		== Naming aliases ==
	You can give an alias ~~virtualy~~ any name you want, but keep a few things in mind:		You can give an alias virtually any name you want, but keep a few things in mind:

	* When you give an alias used as a command the same name as an existing mIRC command, your alias gets preference.		* When you give an alias used as a command the same name as an existing mIRC command, your alias gets preference.
	* Some inbuilt commands act differently than the rest, if you have an alias called [[timertest\|Timer]], you will not ~~beable~~ to start a timer called test, like this: /timertest 0 1 MyTestFunction in this situation you can prefix the command with an exclamation mark (!) as shown below in the example.		* Some inbuilt commands act differently than the rest, if you have an alias called [[timertest\|Timer]], you will not be able to start a timer called test, like this: /timertest 0 1 MyTestFunction in this situation you can prefix the command with an exclamation mark (!) as shown below in the example.
	* When you give an alias used as an identifier the same name as an existing mIRC identifier, mIRC's identifier gets preference, unless you prefix your alias with a period.		* When you give an alias used as an identifier the same name as an existing mIRC identifier, mIRC's identifier gets preference, unless you prefix your alias with a period.

	Example:		Example:
	/alias me { [[If-Then-Else\|if]] ([[$isid]]) { [[return]] AveIT! } \| [[describe]] [[$active]] [[$1-]] }		/alias me { [[If-Then-Else\|if]] ([[$isid]]) { [[return]] AveIT! } \| else { [[describe]] [[$active]] [[$1-]] } }
	/alias timertest { if (!%timerstart) [[set]] %timerstart [[$ticks]] \| else { echo -ag [[$calc]]($ticks - %timerstart) ms \| unset %timerstart } }		/alias timertest { if (!%timerstart) [[set]] %timerstart [[$ticks]] \| else { echo -ag [[$calc]]($ticks - %timerstart) ms \| unset %timerstart } }

	Here, the $isid identifer ~~checks~~ to make sure we're calling $me and not /me, if we are calling /me make sure we do /describe to the active channel with the parameters ~~suppled~~.		Here, the $isid identifer is checked to make sure we're calling $me and not /me, if we are calling /me make sure we do /describe to the active channel with the parameters supplied.
	timertest		timertest
	echo -ag I am $me but my custom identifer returns $.me		echo -ag I am $me but my custom identifer returns $.me
Line 28:		Line 30:
	16 ms		16 ms

	'''''Note:''''' If you want to start a timer called test with the alias called timertest, you have to ~~prefox~~ the timer with the ! to use the inbuilt mIRC timer command:		'''''Note:''''' If you want to start a timer called test with the alias called timertest, you have to prefix the timer with the ! to use the inbuilt mIRC timer command:
	!timertest 1 1 echo -ag This is my test.		!timertest 1 1 echo -ag This is my test.
	It is not encouraged to call an alias starting with timer, or identifers with mircdir, getdir, mididir, or any other alias which can be used with a suffix.		It is not encouraged to call an alias starting with timer, or identifers with mircdir, getdir, mididir, or any other alias which can be used with a suffix.
Line 45:		Line 47:
	=== Events ===		=== Events ===
	When calling an alias from an event, the identifiers related to that event will still be available in that alias.		When calling an alias from an event, the identifiers related to that event will still be available in that alias.
	on *:[[~~On_Text~~\|TEXT]]:hi:#: { myAlias }		on *:[[On_text\|TEXT]]:hi:#: { myAlias }

	[[alias]] myAlias { [[msg]] [[$chan]] [[$nick]] said hi! }		[[alias]] myAlias { [[msg]] [[$chan]] [[$nick]] said hi! }

	This would be exactly the same as:		This would be exactly the same as:
	on *:TEXT:hi:#: { [[msg~~]] [[~~$chan~~]] [[~~$nick]] said hi! }		on *:TEXT:hi:#: { msg $chan $nick said hi! }
	This in turn means that you don't have to pass a identifier supplied by an event into your alias as parameter.		This in turn means that you don't have to pass a identifier supplied by an event into your alias as parameter.

	== Commands vs identifiers ==		== Commands vs identifiers ==
	Being that you can use your aliases as both commands as identifiers, the question may rise which you should pick. The general answer is quite simple: if you want your alias to have a return value use identifiers and in any other case use commands.		Being that you can use your aliases as both commands and identifiers, the question may rise which you should pick. The general answer is quite simple: if you want your alias to have a return value use identifiers and in any other case use commands.

	=== Error handling ===		=== Error handling ===
Line 61:		Line 63:
	; the (useless) idea of the following identifier is to message "moo" to the currently active channel		; the (useless) idea of the following identifier is to message "moo" to the currently active channel
	; if it is on QuakeNet		; if it is on QuakeNet
	[[alias]] moo {		alias moo {
	[[if]] ([[$network]] != QuakeNet) \|\| (![[$chan]]) { [[return]] 0 }		if ([[$network]] != QuakeNet) \|\| (!$chan) { return 0 }
	[[else]] {		else {
	[[msg~~]] [[~~$chan]] moo		msg $chan moo
	[[return]] 1		return 1
	}		}
	}		}
Line 71:		Line 73:
	To use this as error handling you could do the following:		To use this as error handling you could do the following:
	%error = $moo		%error = $moo
	[[if]] (!%error) {		if (!%error) {
	; do what you want to do if the command failed		; do what you want to do if the command failed
	; in this case when there was no channel active		; in this case when there was no channel active
Line 81:		Line 83:
	; the server was QuakeNet		; the server was QuakeNet
	}		}
	[[else]] {		else {
	; the script should never reach this place!		; the script should never reach this place!
	}		}