Hourglass
Configurable animated graphical timers & round trackers for foundry VTT that can be shown by the GM to all players.
Hourglass Options
To create a new hourglass, a Game Master may select the hourglass icon under the Token Controls.
This will open the options window for you to configure your hourglass.
- Timer Type - The type of animated graphic to show to players. Options currently include "Hourglass" & "Flipdown Clock".
- Title - The display name of the timer that will appear at the top left.
- Style - The visual style of the timer graphic to be displayed.
- Size - The display size of the timer window: Tiny, Small, Medium & Large.
- Duration Type - Whether the timer should be an automatic (timed) or manual "on click" countdown.
- Duration (Seconds/Minutes) - The time taken for the hourglass to complete.
- Sand Colour - The hex value for the colour of the sand in the hourglass. Can be typed manually or selected using the colour picker.
- Display time as text? - Indicates whether you wish to display the remaining time as a text overlay on the hourglass.
- End message - Text to be displayed as an overlay on the hourglass after the duration has passed.
- End sound - Sound to be played to all players after the duration has passed (more details below).
- Close after duration? - Whether you wish the timer window to automatically close (for all users) after the duration has passed.
- Sync with Foundry pause? - Whether the timer should pause/resume when you pause/resume your Foundry game session (e.g. with space bar)
Usage
The start hourglass button, once pressed, will cause a new hourglass window to appear on the screen of all players currently in the game session using the chosen options:
Once the duration has elapsed, the remaining time will dissapear and be replaced by the end message (if one has been entered):
Players can move the hourglass around the screen while it is counting down. They do also have the option of closing it, though they should only do this once the duration has elapsed.
Once an hourglass has been created, the module will retain the "last used" settings for the duration of the session. This means that you can create subsequent hourglasses using the same settings without having to re-enter them.
Multiple hourglasses can be opened by a GM at one time, should you wish to track multiple events simultaneously.
Manual "on click" control
Timers can be set to "manual" control by setting the Duration type to "Manual (user click) in the hourglass options.
The manual timers feature a forward and backward button that, when clicked, will decrease and increase the remaining increments respectively. This could potentially be used by GMs to include manually controlled/incremented event or round tracking within their games. Both forward and back buttons are only visible to users with the GM role.
Styles
As well as changing the sand colour, each timer has a range of different visual styles to choose from.
 |
 |
Each style has all of the same functionality and customisation options as the default.
A heartfelt thankyou to artist Zael for creating some fantastic alternative timer styles with a range of themes.
Presets
Game Masters have the ability to save Hourglass Options as Presets. This will allow frequently used configurations to be quickly recalled and displayed.
- Select Preset - Presents a dropdown list of all previously saved Hourglasses. A GM can select a preset from this list to populate all options fields with data saved for that preset.
- Save New - Will persist all currently entered options as a new Preset with a name matching the Title field.
- Update Selected - Will update an existing selected Preset with currently entered options. If the title field has been changed, the name of the preset will also be updated. If no Preset is selected from the dropdown, this button will be disabled.
- Delete Selected - Will delete an existing selected preset. If no Preset is selected from the dropdown, this button will be disabled
End Sound
Timer Controls
Pausing
Restarting
Synching with Foundry Pause
Macro Support
showTimer(duration: number)- Displays and starts a default hourglass with the entered duration.showTimerPreset(presetTitle: string, duration: number = null)- Displays and starts a previously saved preset timer with the matching title property. The duration for the preset timer can be overridden by entering a duration (in seconds) into the second optional parameter. For countdown timers, this property is set as the "duration seconds". For manual timers, this property is set as the "increments".closeAllTimers()- Closes all open timers for all players.
Example Usage:
Popout!
The Popout! module is disabled for Hourglass Timer windows due to compatibility issues.