GetAliasOption
Script function

world.GetAliasOption

DOC_scripting Read about scripting

Type

Method

Summary

Gets the value of a named alias option

Prototype

VARIANT GetAliasOption(BSTR AliasName, BSTR OptionName);

DOC_data_types View list of data type meanings

Description

Gets the current value of a alias option.

You must specify the name of an existing alias, and a alias option from the list below. These are the same names as used in the XML world files for alias options.

The return type is Variant, so the returned value will be the appropriate type for the data (ie. string or number (long)).

If the option name is not known, or is not allowed to be retrieved, a NULL variant is returned.

If the named alias does not exist, EMPTY is returned. If the name given is invalid, NULL is returned. If the option name is not known, EMPTY is returned. (Use "IsEmpty" and "IsNull" to test for these possibilities).

For a detailed description about the meanings of the fields, see AddAlias.

If GetAliasOption is called from within a plugin, the aliases for the current plugin are used, not the "global" MUSHclient aliases.

OPTION NAMES

"echo_alias" - echo alias itself to the output window
"enabled" - enabled flag
"expand_variables" - expand variables flag
"group" - group name
"ignore_case" - ignore case flag
"keep_evaluating" - keep testing this command for other aliases
"match" - what to match on
"menu" - menu flag
"omit_from_command_history" - omit command from command history
"omit_from_log" - omit from log file flag
"omit_from_output" - omit from output flag
"one_shot" - one shot flag
"queue" - queue flag
"regexp" - regular expression flag
"script" - script routine to call
"send" - what to send
"send_to" - where to send it (see GetAliasInfo for valid values)
"sequence" - sequence number
"speed_walk" - speedwalk flag
"user" - user value

VBscript example

world.note world.GetAliasOption ("myalias", "match")


Jscript example

world.note (world.GetAliasOption ("myalias", "match"));


PerlScript example

$world->note ($world->GetAliasOption ("myalias", "match"));


Python example

world.note (world.GetAliasOption ("myalias", "match"))


Lua example

Note (GetAliasOption ("myalias", "match"))


Lua notes

Lua returns nil where applicable instead of an "empty variant" or "null variant".


Return value

As described above.



See Also ...

Topics

DOC_aliases Aliases
DOC_mapper Auto-mapper
DOC_defaults Default triggers/aliases/timers/macros/colours
DOC_starting Getting started
DOC_group Groups
DOC_keypad Keypad navigation
DOC_macros Macro keys
DOC_plugins Plugins
DOC_regexp Regular Expressions
DOC_speed_walking Speed walking
DOC_timers Timers
DOC_triggers Triggers

Functions

FNC_AddAlias AddAlias (Adds an alias)
FNC_DeleteAlias DeleteAlias (Deletes an alias)
FNC_DeleteAliasGroup DeleteAliasGroup (Deletes a group of aliases)
FNC_DeleteTemporaryAliases DeleteTemporaryAliases (Deletes all temporary aliases)
FNC_EnableAlias EnableAlias (Enables or disables an alias)
FNC_EnableAliasGroup EnableAliasGroup (Enables/disables a group of aliases)
FNC_GetAlias GetAlias (Gets details about an alias)
FNC_GetAliasInfo GetAliasInfo (Gets details about an alias)
FNC_GetAliasList GetAliasList (Gets the list of aliases)
FNC_GetAliasWildcard GetAliasWildcard (Returns the contents of the specified wildcard for the named alias)
FNC_GetPluginAliasInfo GetPluginAliasInfo (Gets details about a named alias for a specified plugin)
FNC_GetPluginAliasList GetPluginAliasList (Gets the list of aliases in a specified plugin)
FNC_IsAlias IsAlias (Tests to see if an alias exists)
FNC_SetAliasOption SetAliasOption (Sets the value of a named alias option)

(Help topic: function=GetAliasOption)

DOC_contents Documentation contents page