GetPluginAliasInfo
Script function

world.GetPluginAliasInfo

DOC_scripting Read about scripting

Type

Method

Summary

Gets details about a named alias for a specified plugin

Prototype

VARIANT GetPluginAliasInfo(BSTR PluginID, BSTR AliasName, short InfoType);

DOC_data_types View list of data type meanings

Description

Gets details about the specified alias for the specified plugin.

You can obtain various "types" of information about the alias by specifying an "InfoType". The possible InfoTypes are described under GetAliasInfo.

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. If the plugin does not exist, NULL is returned. (Use "IsEmpty" and "IsNull" to test for these possibilities).

If you want to find the value of a alias in the current plugin, use "GetAliasInfo".

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

world.Note world.GetPluginAliasInfo ("", "my_alias", 1)

VBscript example

world.note world.GetPluginAliasInfo ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2)


Jscript example

world.note(world.GetPluginAliasInfo  ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2));


PerlScript example

/$world->note ($world->GetPluginAliasInfo  ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2));


Python example

world.note(world.GetPluginAliasInfo  ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2))


Lua example

Note (GetPluginAliasInfo  ("c8efc9f9e1edd118c6f2dbf5", "my_alias", 2))


Lua notes

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


Return value

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.
A NULL variant if the plugin is not installed.



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_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=GetPluginAliasInfo)

DOC_contents Documentation contents page