EnableTimerGroup
Script function world.EnableTimerGroup Read about scripting Type Method Summary Enables/disables a group of timers Prototype `long EnableTimerGroup(BSTR GroupName, BOOL Enabled);` View list of data type meanings Description `Triggers, aliases and timers can be placed in "groups" where a group is a bunch of related items. Groups have names, there is no restriction on the name of a group. Ungrouped items have blank (empty) names. To enable an entire group of timers do this: world.EnableTimerGroup "groupname", 1 To disable the entire group: world.EnableTimerGroup "groupname", 0 For debugging purposes the function returns a count of the number of members in the group (not the number enabled, as some may already be enabled). eg. dim mycount mycount = world.EnableTimerGroup ("groupname", 1) If you are using plugins only the members of the current plugin (if any) are affected. If the call is made outside a plugin only the members of the group that are not in a plugin are affected.` VBscript example
    world.EnableTimerGroup "groupname", 1  ' enable the group
    world.EnableTimerGroup "groupname", 0  ' disable the group
Jscript example
    world.EnableTimerGroup ("groupname", 1);  // enable the group
    world.EnableTimerGroup ("groupname", 0);  // disable the group
PerlScript example
    $world->EnableTimerGroup ("groupname", 1);  # enable the group
    $world->EnableTimerGroup ("groupname", 0);  # disable the group
Python example
    world.EnableTimerGroup ("groupname", 1)  # enable the group
    world.EnableTimerGroup ("groupname", 0)  # disable the group
Lua example
    EnableTimerGroup ("groupname", true)  -- enable the group
    EnableTimerGroup ("groupname", false)  -- disable the group
Lua notes
    The enabled flag is optional, and defaults to true.
Return value
    A count of the number of items in that group.
See Also ... Topics Aliases Default triggers/aliases/timers/macros/colours Getting started Groups Plugins Timers Triggers Functions AddTimer (Adds a timer) DeleteGroup (Deletes a group of triggers, aliases and timers) 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) EnableAliasGroup (Enables/disables a group of aliases) EnableGroup (Enables/disables a group of triggers, aliases and timers) EnableTimer (Enables or disables an timer) EnableTriggerGroup (Enables/disables a group of triggers) 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: function=EnableTimerGroup) Documentation contents page