Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.IsAlias

Name IsAlias
Type Method
Summary Tests to see if an alias exists
Prototype long IsAlias(BSTR AliasName);

View list of data type meanings
Description

Used to test if an alias exists.

Note that this function returns 0 if the alias *exists*.
VBscript example 
world.note world.IsAlias ("myalias")
Jscript example 
world.note(world.IsAlias("myalias"));
PerlScript example 
$world->note($world->IsAlias("myalias"));
Python example 
world.note(world.IsAlias("myalias"))
Lua example 
Note(IsAlias("myalias"))
Returns eInvalidObjectLabel: The alias name is not valid
eAliasNotFound: The named alias does not exist
eOK: completed OK - ie. The alias exists.

View list of return code meanings

See also ...

Function Description
AddAlias Adds an alias
DeleteAlias Deletes an alias
EnableAlias Enables or disables an alias
GetAlias Gets details about an alias
GetAliasInfo Gets details about an alias
GetAliasList Gets the list of aliases

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

[Back]

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

Home