SetAliasOption
Script function world.SetAliasOption Read about scripting Type Method Summary Sets the value of a named alias option Prototype `long SetAliasOption(BSTR AliasName, BSTR OptionName, BSTR Value);` 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
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) EnableAlias (Enables or disables an alias) 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) IsAlias (Tests to see if an alias exists) (Help topic: function=SetAliasOption) Documentation contents page