Wintermute User Guide

Wintermute has two sets of variables outside the standard zone.variable hierarchy:

The following variables cannot be written to, but can be read from anywhere in Wintermute:

• wmTime - returns the value of the flow timer
• wmNow - returns the system time (not the clock timer)

The following are also query-able but are designed for internal use with the remote system.

• wmTimers - returns a list of currently active timers and their times
• wmFlowString - returns a list of flow tags describing the groups in the show flow.
• wmFlowInterval - returns the flow interval
• wmTime - returns a list of the flow colours

All zones in the show flow have the following variables that refer to the group in the zone:

• <zone>.groupcolour - returns the group's colour
• <zone>.grouptime - returns the group's time
• <zone>.groupsize - returns the group's size
• <zone>.groupalias - returns the group's alias
• <zone>.groupid - returns the group's GroupID in the form <Colour>-<Time> - this is a way to programmatically refer to a group's chat channel
• <zone>.groupflowtag - returns the group's Flow tag ¹⁾ in the form <Colour>-<Time>#<Size>
• <zone>.group - this will also return the colour; it is included for reverse compatibility

Note that using the “contains” operator - ^ - with any of these variables will allow you to query the group's group tags

Also note that in Zones with a depth of more than one, these variables refer to the most advanced group in the show flow. If we want to refer to groups earlier in the stack, we used syntax similar to logged variables. For example. to refer to the group colour of penultimate group in a zone, we would use:

<zone>.groupcolour.1

Note that these numbers are zero-indexed - <zone>.groupid.0 and <zone>.groupid are the same thing.

All show zones also expose:

• <zone>.seconds - this returns an integer of the total seconds on that zone's timer ²⁾