Difference between revisions of "$isalias"

From Scriptwiki
Jump to: navigation, search
 
m (added to aliases category)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Returns [[$true]] if the specified name is an alias command that exists in your aliases or scripts.
+
Returns [[$true]] if the specified name is an alias that exists in your aliases or scripts.
 
  $isalias(name)
 
  $isalias(name)
 +
===Properties===
 +
* '''fname''' - returns the filename in which the alias exists
 +
* '''alias''' - returns the alias definition
 
==Example==
 
==Example==
  $isalias(op)
+
[[alias]] -l cow { [[say]] Cows go moo! }
Returns $true if you have an alias called op.
+
alias fish {
 +
  [[if]] (fishbot [[If-then-else#ison|ison]] [[$active]]) say I love the smell of fish in the morning.
 +
  else say I wish I could smell fish.
 +
}
 +
 +
  $isalias(cow)           returns $true since we have a cow alias.
 +
$isalias(fish).fname    returns the filename in which the alias is saved or ''[[$null|null]]'' if the alias doesn't exist.
 +
$isalias(fish).alias    returns fish {
 +
$isalias(cow).alias     returns cow -l { say Cows go moo! }
 +
 
 +
If the above $isalias() calls are being called from outside the same remote file as the cow alias mirc would return $false since cow is a local alias and the .alias property would return null.
 
==See Also==
 
==See Also==
 
* [[alias|/alias]]
 
* [[alias|/alias]]
 
[[Category:Identifiers]]
 
[[Category:Identifiers]]
 +
[[Category:Aliases]]

Latest revision as of 18:12, 29 November 2009

Returns $true if the specified name is an alias that exists in your aliases or scripts.

$isalias(name)

Properties

  • fname - returns the filename in which the alias exists
  • alias - returns the alias definition

Example

alias -l cow { say Cows go moo! }
alias fish {
  if (fishbot ison $active) say I love the smell of fish in the morning.
  else say I wish I could smell fish.
}

$isalias(cow)           returns $true since we have a cow alias.
$isalias(fish).fname    returns the filename in which the alias is saved or null if the alias doesn't exist.
$isalias(fish).alias    returns fish {
$isalias(cow).alias     returns cow -l { say Cows go moo! }

If the above $isalias() calls are being called from outside the same remote file as the cow alias mirc would return $false since cow is a local alias and the .alias property would return null.

See Also