EnableAlias
Script function

world.EnableAlias

DOC_scripting Read about scripting

Type

Method

Summary

Enables or disables an alias

Prototype

long EnableAlias(BSTR AliasName, BOOL Enabled);

DOC_data_types View list of data type meanings

Description

Enables or disables the named alias. An enabled alias is "active", otherwise it is ignored when processing commands you type.

VBscript example

world.EnableAlias "teleport", TRUE


Jscript example

world.EnableAlias("teleport", true);


PerlScript example

$world->EnableAlias("teleport", true);


Python example

world.EnableAlias("teleport", true)


Lua example

EnableAlias ("teleport", true)


Lua notes

The enabled flag is optional, and defaults to true.


Return value

eInvalidObjectLabel: The alias name is not valid
eAliasNotFound: The named alias does not exist
eOK: completed OK


DOC_errors View list of return code meanings

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

DOC_contents Documentation contents page