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.

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 timer. For example, to show only timers that do "send to script":


function filter (s)
  return GetTimerInfo (s, 20) == 12 
end -- filter


You can use GetTimerInfo or GetTimerOption to find out information about that timer 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_defaults Default triggers/aliases/timers/macros/colours
DOC_starting Getting started
DOC_group Groups
DOC_plugins Plugins
DOC_timers Timers
DOC_triggers Triggers

Command

CMD_ID_GAME_CONFIGURE_TIMERS ConfigureTimers (Define timers)

Dialog

DLG_IDD_EDIT_TIMER Edit timer

Functions

FNC_AddTimer AddTimer (Adds a timer)
FNC_DeleteTemporaryTimers DeleteTemporaryTimers (Deletes all temporary timers)
FNC_DeleteTimer DeleteTimer (Deletes a timer)
FNC_DeleteTimerGroup DeleteTimerGroup (Deletes a group of timers)
FNC_DoAfter DoAfter (Adds a one-shot, temporary timer - simplified interface)
FNC_DoAfterSpecial DoAfterSpecial (Adds a one-shot, temporary, timer to carry out some special action)
FNC_DoAfterSpeedWalk DoAfterSpeedWalk (Adds a one-shot, temporary speedwalk timer - simplified interface)
FNC_EnableTimer EnableTimer (Enables or disables an timer)
FNC_EnableTimerGroup EnableTimerGroup (Enables/disables a group of timers)
FNC_GetTimer GetTimer (Gets details about a timer)
FNC_GetTimerInfo GetTimerInfo (Gets details about a timer)
FNC_GetTimerList GetTimerList (Gets the list of timers)
FNC_GetTimerOption GetTimerOption (Gets the value of a named timer option)
FNC_IsTimer IsTimer (Tests to see if a timer exists)
FNC_ResetTimer ResetTimer (Resets a named timer)
FNC_ResetTimers ResetTimers (Resets all timers)
FNC_SetTimerOption SetTimerOption (Sets the value of a named timer option)

(Help topic: dialog=IDD_PREFS_P16)

DOC_contents Documentation contents page