MUSHclient scripting

Description of MUSHclient world function: world.GetAliasInfo

Name	GetAliasInfo
Type	Method
Summary	Gets details about an alias
Prototype	`VARIANT GetAliasInfo(BSTR AliasName, short InfoType);` View list of data type meanings
Description	Gets details about the specified alias name. You can obtain one of 31 "types" of information about the alias by specifying an "InfoType". The possible InfoTypes are: 1: What to match on (string) 2: What to send (string) 3: Script procedure name (string) 4: Omit from log (boolean) 5: Omit from output (boolean) 6: Enabled (boolean) 7: Regular expression (boolean) 8: Ignore case (boolean) 9: Expand variables (boolean) 10: Invocation count (long) 11: Times matched (long) 12: Menu (boolean) 13: Date/time alias last matched (date) 14: 'temporary' flag (boolean) 15: Alias was included from an include file (boolean) 16: Group name (string) 17: Variable name to set (string) 18: Send-to location (long) 19: 'keep-evaluating' flag (boolean) 20: Sequence number (long) 21: 'echo alias' flag (boolean) 22: 'omit from command history' flag (boolean) 23: User option value (long) 24: Number of matches to regular expression (most recent match) (long) 25: The string we matched against (last alias text matched against) (string) 26: Executing-script flag (boolean) 27: Script is valid flag (boolean) 28: Error number from PCRE when evaluating last match (long), zero if none 29: 'one shot' flag (boolean) 30: Time taken (in seconds) to test aliases (including un-matched ones) (double) 31: Number of attempts to match this alias (long) 101: Wildcard %1 from last time it matched 102: Wildcard %2 from last time it matched 103: Wildcard %3 from last time it matched 104: Wildcard %4 from last time it matched 105: Wildcard %5 from last time it matched 106: Wildcard %6 from last time it matched 107: Wildcard %7 from last time it matched 108: Wildcard %8 from last time it matched 109: Wildcard %9 from last time it matched 110: Wildcard %0 from last time it matched Other wildcards can be extracted by using GetAliasWildcard. The word in brackets indicates the "type" of data returned. String: a character string (eg. "north") Boolean: TRUE or FALSE Long: a 32-bit number The field "invocation count" is a count of how many times the script routine was called. The field "times matched" is a count of how many times the alias matched. These two would normally be the same, unless scripting was disabled, or there was an error in the script file. The meanings of the "send-to" field are: 0: World 1: Command window 2: Output window 3: Status line 4: Notepad (new) 5: Notepad (append) 6: Log File 7: Notepad (replace) 8: Command queue 9: Send To Variable 10: Execute (re-parse as command) 11: Speedwalk (send text is speedwalk, queue it) 12: Script (send to script engine) 13: Immediate (send to world in front of speedwalk queue) 14: Script - after omit If the named alias does not exist, EMPTY is returned. If the name given is invalid, NULL is returned. If the InfoType given is out of range, NULL is returned. (Use "IsEmpty" and "IsNull" to test for these possibilities). See AddAlias for a description of the meanings of the fields.
VBscript example	`world.note world.GetAliasInfo ("my_alias", 2)`
Jscript example	`/world.note(world.GetAliasInfo ("my_alias", 2));`
PerlScript example	`/$world->note ($world->GetAliasInfo ("my_alias", 2));`
Python example	`world.note(world.GetAliasInfo ("my_alias", 2))`
Lua example	`Note (GetAliasInfo("my_alias", 2))`
Lua notes	Lua returns nil where applicable instead of an "empty variant" or "null variant". The "SendTo" field can be looked up using the "sendto" table in the Lua global address space, as follows: sendto.world = 0 sendto.command = 1 sendto.output = 2 sendto.status = 3 sendto.notepad = 4 sendto.notepadappend = 5 sendto.logfile = 6 sendto.notepadreplace = 7 sendto.commandqueue = 8 sendto.variable = 9 sendto.execute = 10 sendto.speedwalk = 11 sendto.script = 12 sendto.immediate = 13 sendto.scriptafteromit = 14
Returns	`The specified information about the alias, as described above. An EMPTY variant, if the alias does not exist. A NULL variant if the alias name is invalid. A NULL variant if the InfoType is not a valid type.`

See also ...

Function	Description
AddAlias	Adds an alias
DeleteAlias	Deletes an alias
EnableAlias	Enables or disables an alias
GetAlias	Gets details about an alias
GetAliasList	Gets the list of aliases
GetAliasOption	Gets the value of a named alias option
GetAliasWildcard	Returns the contents of the specified wildcard for the named alias
GetInfo	Gets information about the current world
IsAlias	Tests to see if an alias exists
SetAliasOption	Sets the value of a named alias option

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions

Comments to: Gammon Software support
Forum RSS feed ( http://www.gammon.com.au/rss/forum.xml )