SetAliasOption
Script function

world.SetAliasOption

DOC_scripting Read about scripting

Type

Method

Summary

Sets the value of a named alias option

Prototype

long SetAliasOption(BSTR AliasName, BSTR OptionName, BSTR Value);

DOC_data_types View list of data type meanings

Description

Sets the current value of an alias option.

You must specify the name of an existing alias, and an alias option from the list given for GetAliasOption. These are the same names as used in the XML world files for alias options.

For a detailed description about the meanings of the fields, see AddAlias.

If SetAliasOption is called from within a plugin, the aliases for the current plugin are used, not the "global" MUSHclient aliases.

For boolean options (flags) the supplied string will be converted to a number. It is an error if the string does not consist of digits (0 to 9).

VBscript example

world.SetAliasOption "myalias", "match", "north"


Jscript example

world.SetAliasOption ("myalias", "match", "north");


PerlScript example

$world->SetAliasOption ("myalias", "match", "north");


Python example

world.SetAliasOption ("myalias", "match", "north")


Lua example

SetAliasOption ("myalias", "match", "north")


Return value

eInvalidObjectLabel: The alias name is not valid
eAliasCannotBeEmpty: The "match_text" cannot be empty
eScriptNameNotLocated: The script name cannot be located in the script file
eBadRegularExpression: The regular expression could not be evaluated
eOK: set 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_EnableAlias EnableAlias (Enables or disables an alias)
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)

(Help topic: function=SetAliasOption)

DOC_contents Documentation contents page