Alias configuration (list)
Enable Aliases

If checked, all aliases are enabled (active).

Override with default aliases

If checked, next time the world is loaded your aliases are replaced with the default ones. See the help topic on "defaults" for more details.

Add...

Click to add an alias.

Edit...

Click to edit an existing alias.

Remove

Click to remove one or more selected aliases from the list.

Find...

Click to find an alias based on its contents.

Find Next

Click to repeat the next find (find another one that matches).

Load...

Click to load aliases from disk.

Save...

Click to save selected aliases to disk.

Move Up

Click to move the selected alias up the list (in other words, lower its sequence number).

Move Down

Click to move the selected alias down the list (in other words, raise its sequence number).


Copy

Click to copy the selected alias(es) to the clipboard in XML format.

Paste

Click to paste the clipboard into the alias list. The aliases must be in XML format (such as produced by the Copy button). Only aliases will be pasted, if there are other types on the clipboard.

Copy and paste is intended to allow you to get/put aliases onto the Forum, or exchange them between worlds or with other MUSHclient users.

Filter by:

Check to filter the visible items by the function "filter". Click on the button labelled "..." next to the "filter by" checkbox to enter the code for the scripted filter function. The filter function must be written in Lua and have a function named "filter" in the script, taking one argument which is the name (label) of the alias. For example, to show only aliases that do "send to script":


function filter (s)
  return GetAliasInfo (s, 18) == 12 
end -- filter


You can use GetAliasInfo or GetAliasOption to find out information about that alias and work out whether to show it or not. If the function returns the boolean value "false" then the item is not shown, otherwise it is shown in the list.

The filter script is saved in the world file, so you can use it again next time, however the filter flag is not remembered. You must explicitly enable it each time you want to filter the list.

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

Command

CMD_ID_GAME_CONFIGURE_ALIASES ConfigureAliases (Define aliases)

Dialog

DLG_IDD_EDIT_ALIAS Edit alias

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)
FNC_SetAliasOption SetAliasOption (Sets the value of a named alias option)

(Help topic: dialog=IDD_PREFS_P7)

DOC_contents Documentation contents page