MUSHclient documentation: dialog IDD_PREFS

Alias configuration (list)

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. Tree View Check to show a "tree" view of the items. Leave unchecked to show a "list" view. In tree view only one item can be selected at once, however you can select an entire group for the purpose of copying the group to the clipboard, or deleting it. In tree view items are sorted into groups. Inside the group the items are shown in sequence order. 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 two arguments which are the name (label) of the alias, and a table of values corresponding to the various settings for it. For example, to show only aliases that do "send to script": `function filter (name, alias) return alias.send_to == sendto.script end -- filter` You can use the various values for this alias to work out whether or not you want this particular one to be shown in the list (for example, if it sends to script). 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. The various fields in the alias table are documented here: `http://www.gammon.com.au/forum/?id=7123` In addition, some fields calculated at runtime are: `"execution_error" // GetAliasInfo (28) * "execution_time" // GetAliasInfo (30) * "included" // GetAliasInfo (15) "invocation_count" // GetAliasInfo (10) "last_match" // GetAliasInfo (25) * "match_attempts" // GetAliasInfo (31) * "match_count" // GetAliasInfo (24) * "script_valid" // GetAliasInfo (27) "temporary" // GetAliasInfo (14) "times_matched" // GetAliasInfo (11) "when_matched" // GetAliasInfo (13) ` Fields marked may not be present (ie. be nil) under some circumstances (eg. regular expression failure). 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 Command (ConfigureAliases) Define aliases Dialog Edit alias 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 (GetPluginAliasOption) Gets the value of a named alias option for a specified plugin (IsAlias) Tests to see if an alias exists (SetAliasOption) Sets the value of a named alias option (Help topic: dialog=IDD_PREFS_P7)

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.

Tree View

Check to show a "tree" view of the items. Leave unchecked to show a "list" view. In tree view only one item can be selected at once, however you can select an entire group for the purpose of copying the group to the clipboard, or deleting it.

In tree view items are sorted into groups. Inside the group the items are shown in sequence order.

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 two arguments which are the name (label) of the alias, and a table of values corresponding to the various settings for it. For example, to show only aliases that do "send to script":


function filter (name, alias)
  return alias.send_to == sendto.script 
end -- filter

You can use the various values for this alias to work out whether or not you want this particular one to be shown in the list (for example, if it sends to script). 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.

The various fields in the alias table are documented here:


http://www.gammon.com.au/forum/?id=7123

In addition, some fields calculated at runtime are:


"execution_error"   // GetAliasInfo  (28) *
"execution_time"    // GetAliasInfo  (30) *
"included"          // GetAliasInfo  (15)
"invocation_count"  // GetAliasInfo  (10)
"last_match"        // GetAliasInfo  (25) *
"match_attempts"    // GetAliasInfo  (31) *
"match_count"       // GetAliasInfo  (24) *
"script_valid"      // GetAliasInfo  (27)
"temporary"         // GetAliasInfo  (14)
"times_matched"     // GetAliasInfo  (11)
"when_matched"      // GetAliasInfo  (13) *

Fields marked * may not be present (ie. be nil) under some circumstances (eg. regular expression failure).

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