SetTimerOption
Script function world.SetTimerOption Read about scripting Type Method Summary Sets the value of a named timer option Prototype `long SetTimerOption(BSTR TimerName, BSTR OptionName, BSTR Value);` View list of data type meanings Description `Sets the current value of a timer option. You must specify the name of an existing timer, and a timer option from the list given for GetTimerOption. These are the same names as used in the XML world files for timer options. For a detailed description about the meanings of the fields, see AddTimer. If SetTimerOption is called from within a plugin, the timers for the current plugin are used, not the "global" MUSHclient timers. For numeric options (such as sequence) 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.SetTimerOption "mytimer", "minute", "5"
Jscript example
    world.SetTimerOption ("mytimer", "minute", "5");
PerlScript example
    $world->SetTimerOption ("mytimer", "minute", "5");
Python example
    world.SetTimerOption ("mytimer", "minute", "5")
Lua example
    SetTimerOption ("mytimer", "minute", "5")
Return value
    eInvalidObjectLabel: The timer name is not valid
    eTimeInvalid: Time is out of range (hours not 0 to 23, minutes/seconds not 0-59)
    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 Default triggers/aliases/timers/macros/colours Getting started Groups Plugins Timers Triggers 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) 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) (Help topic: function=SetTimerOption) Documentation contents page