GetPluginAliasOption
Script function

world.GetPluginAliasOption

DOC_scripting Read about scripting

Type

Method

Summary

Gets the value of a named alias option for a specified plugin

Prototype

VARIANT GetPluginAliasOption(BSTR PluginID, BSTR AliasName, BSTR OptionName);

DOC_data_types View list of data type meanings

Description

Gets the current value of an alias option for the specified plugin.

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

If you want to find the value of an alias option in the current plugin, use "GetAliasOption".

If you are writing a plugin and want to find "global" MUSHclient alias values, use an empty plugin ID, eg.

world.Note world.GetPluginAliasOption ("", "my_alias", "enabled")


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).

See GetAliasOption for a list of option names and values.

VBscript example

Note GetPluginAliasOption("c8efc9f9e1edd118c6f2dbf5", "my_alias", "match")


Jscript example

Note (GetPluginAliasOption ("c8efc9f9e1edd118c6f2dbf5", "my_alias", "match"));


PerlScript example

/$world->Note ($world->GetPluginAliasOption ("c8efc9f9e1edd118c6f2dbf5", "my_alias", "match"));


Python example

world.Note(world.GetPluginAliasOption ("c8efc9f9e1edd118c6f2dbf5", "my_alias", "match"))


Lua example

Note (GetPluginAliasOption ("c8efc9f9e1edd118c6f2dbf5", "my_alias", "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_GetAliasOption GetAliasOption (Gets the value of a named alias option)
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=GetPluginAliasOption)

DOC_contents Documentation contents page