world.EnableAlias

MUSHclient script function (Method)

Enables or disables an alias

Prototype

long EnableAlias(BSTR AliasName, BOOL Enabled);

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

Return code meanings

Related topic

Aliases

See also