[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.EnableAlias

Name EnableAlias
Type Method
Summary Enables or disables an alias
Prototype long EnableAlias(BSTR AliasName, BOOL Enabled);

View list of data type meanings


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

Function Description
AddAlias Adds an alias
DeleteAlias Deletes an alias
GetAlias Gets details about an alias
GetAliasInfo Gets details about an alias
GetAliasList Gets the list of aliases
IsAlias Tests to see if an alias exists

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions


Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]