MUSHclient documentation: dialog IDD_PREFS

Timers

Timers
Enable Timers If checked, all timers are enabled (active). Override with default timers If checked, next time the world is loaded your timers are replaced with the default ones. See the help topic on "defaults" for more details. Add... Click to add a timer. Edit... Click to edit an existing timer. Remove Click to remove one or more selected timers from the list. Find... Click to find a timer based on its contents. Find Next Click to repeat the next find (find another one that matches). Load... Click to load timers from disk. Save... Click to save selected timers to disk. Reset All Timers Click to reset all timers. This means that timers that fire after a certain interval will start counting again from zero. Copy Click to copy the selected timer(s) to the clipboard in XML format. Paste Click to paste the clipboard into the timer list. The timers must be in XML format (such as produced by the Copy button). Only timers will be pasted, if there are other types on the clipboard. Copy and paste is intended to allow you to get/put timers 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. 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 timer, and a table of values corresponding to the various settings for it. For example, to show only timers that do "send to script": `function filter (name, timer) return timer.send_to == sendto.script end -- filter` You can use the various values for this timer 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 timer table are documented here: `http://www.gammon.com.au/forum/?id=7123` In addition, some fields calculated at runtime are: `"invocation_count" // GetTimerInfo (9) "times_fired" // GetTimerInfo (10) "when_fired" // GetTimerInfo (11) * "temporary" // GetTimerInfo (14) "included" // GetTimerInfo (18) "script_valid" // GetTimerInfo (26)` See Also ... Topics Aliases Default triggers/aliases/timers/macros/colours Getting started Groups Plugins Timers Triggers Command (ConfigureTimers) Define timers Dialog Edit timer Functions (AddTimer) Adds a timer (DeleteTemporaryTimers) Deletes all temporary timers (DeleteTimer) Deletes a timer (DeleteTimerGroup) Deletes a group of timers (DoAfter) Adds a one-shot, temporary timer - simplified interface (DoAfterSpecial) Adds a one-shot, temporary, timer to carry out some special action (DoAfterSpeedWalk) Adds a one-shot, temporary speedwalk timer - simplified interface (EnableTimer) Enables or disables an timer (EnableTimerGroup) Enables/disables a group of timers (GetPluginTimerOption) Gets the value of a named timer option for a specified plugin (GetPluginTriggerOption) Gets the value of a named trigger option for a specified plugin (GetTimer) Gets details about a timer (GetTimerInfo) Gets details about a timer (GetTimerList) Gets the list of timers (GetTimerOption) Gets the value of a named timer option (IsTimer) Tests to see if a timer exists (ResetTimer) Resets a named timer (ResetTimers) Resets all timers (SetTimerOption) Sets the value of a named timer option (Help topic: dialog=IDD_PREFS_P16)

Enable Timers

If checked, all timers are enabled (active).

Override with default timers

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

Add...

Click to add a timer.

Edit...

Click to edit an existing timer.

Remove

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

Find...

Click to find a timer based on its contents.

Find Next

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

Load...

Click to load timers from disk.

Save...

Click to save selected timers to disk.

Reset All Timers

Click to reset all timers. This means that timers that fire after a certain interval will start counting again from zero.

Copy

Click to copy the selected timer(s) to the clipboard in XML format.

Paste

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

Copy and paste is intended to allow you to get/put timers 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.

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 timer, and a table of values corresponding to the various settings for it. For example, to show only timers that do "send to script":


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

You can use the various values for this timer 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 timer table are documented here:


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

In addition, some fields calculated at runtime are:


"invocation_count"  // GetTimerInfo  (9)
"times_fired"       // GetTimerInfo  (10)
"when_fired"        // GetTimerInfo  (11) *
"temporary"         // GetTimerInfo  (14)
"included"          // GetTimerInfo  (18)
"script_valid"      // GetTimerInfo  (26)

See Also ...

Topics

Aliases
Default triggers/aliases/timers/macros/colours
Getting started
Groups
Plugins
Timers
Triggers