Script function
world.EnableAlias
Read about scripting
Type
Method
Summary
Enables or disables an alias
Prototype
long EnableAlias(BSTR AliasName, BOOL Enabled);
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
View list of return code meanings
See Also ...
Topics
Aliases
Auto-mapper
Default triggers/aliases/timers/macros/colours
Getting started
Groups
Keypad navigation
Macro keys
Plugins
Regular Expressions
Speed walking
Timers
Triggers
Functions
(AddAlias) Adds an alias
(DeleteAlias) Deletes an alias
(DeleteAliasGroup) Deletes a group of aliases
(DeleteTemporaryAliases) Deletes all temporary aliases
(EnableAliasGroup) Enables/disables a group of aliases
(GetAlias) Gets details about an alias
(GetAliasInfo) 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
(GetPluginAliasInfo) Gets details about a named alias for a specified plugin
(GetPluginAliasList) Gets the list of aliases in a specified plugin
(GetPluginAliasOption) Gets the value of a named alias option for a specified plugin
(IsAlias) Tests to see if an alias exists
(SetAliasOption) Sets the value of a named alias option
(Help topic: function=EnableAlias)