Countdown with visual indicator
Download: https://github.com/Hammerspoon/Spoons/raw/master/Spoons/CountDown.spoon.zip
Signature | CountDown.alertAttributes |
---|---|
Type | Variable |
Description | how to display timer is up notification |
Source | Source/CountDown.spoon/init.lua line 98 |
Signature | CountDown.alertLen |
---|---|
Type | Variable |
Description | time to show the end-of-time alert. 0 implies do not show |
Source | Source/CountDown.spoon/init.lua line 88 |
Signature | CountDown.alertSound |
---|---|
Type | Variable |
Description | Sounds to play when time is up. No sound if nil |
Source | Source/CountDown.spoon/init.lua line 93 |
Signature | CountDown.barCanvasHeight |
---|---|
Type | Variable |
Description | indicator bar at the bottom of the screen |
Source | Source/CountDown.spoon/init.lua line 66 |
Signature | CountDown.barFillColorPassed |
---|---|
Type | Variable |
Description | Color for time passed in progress bar |
Source | Source/CountDown.spoon/init.lua line 76 |
Signature | CountDown.barFillColorToPass |
---|---|
Type | Variable |
Description | Color for time to pass in progress bar |
Source | Source/CountDown.spoon/init.lua line 81 |
Signature | CountDown.barTransparency |
---|---|
Type | Variable |
Description | Transparency for progress bar |
Source | Source/CountDown.spoon/init.lua line 71 |
Signature | CountDown.defaultKeyBindings |
---|---|
Type | Variable |
Description | default key bindings |
Source | Source/CountDown.spoon/init.lua line 44 |
Signature | CountDown.defaultLenMinutes |
---|---|
Type | Variable |
Description | Default timer in minutes. |
Source | Source/CountDown.spoon/init.lua line 29 |
Signature | CountDown.messageAttributes |
---|---|
Type | Variable |
Description | Properties of progress message |
Source | Source/CountDown.spoon/init.lua line 59 |
Signature | CountDown.messageDuration |
---|---|
Type | Variable |
Description | Duration of notification messages |
Source | Source/CountDown.spoon/init.lua line 54 |
Signature | CountDown.nofity |
---|---|
Type | Variable |
Description | set to nil to turn off notification when time's up or provide a hs.notify notification |
Source | Source/CountDown.spoon/init.lua line 39 |
Signature | CountDown.useLastTimerAsDefault |
---|---|
Type | Variable |
Description | if true, make defaultLenMinutes the last time length used |
Source | Source/CountDown.spoon/init.lua line 34 |
Signature | CountDown.warningFormat |
---|---|
Type | Variable |
Description | Format to display the warning. |
Source | Source/CountDown.spoon/init.lua line 112 |
Signature | CountDown.warningShow |
---|---|
Type | Variable |
Description | Do we show progress warnings. A progress warning happens |
Source | Source/CountDown.spoon/init.lua line 105 |
Signature | CountDown.warningshowDuration |
---|---|
Type | Variable |
Description | for how many seconds to show the warning |
Source | Source/CountDown.spoon/init.lua line 118 |
Signature | CountDown:bindHotkeys(mapping) |
---|---|
Type | Method |
Description | Bind hotkeys for this spoon |
Parameters |
|
Returns |
|
Source | Source/CountDown.spoon/init.lua line 734 |
Signature | CountDown:cancel() |
---|---|
Type | Method |
Description | Reset the timer |
Parameters |
|
Returns |
|
Source | Source/CountDown.spoon/init.lua line 685 |
Signature | CountDown:pauseOrResume() |
---|---|
Type | Method |
Description | Pause or resume the existing countdown. |
Parameters |
|
Returns |
|
Source | Source/CountDown.spoon/init.lua line 642 |
Signature | CountDown:setProgress(progress) |
---|---|
Type | Method |
Description | Set the progress of visual indicator to progress. |
Parameters |
|
Returns |
|
Source | Source/CountDown.spoon/init.lua line 707 |
Signature | CountDown:startFor(minutes, callback) |
---|---|
Type | Method |
Description | Start a countdown for |
Parameters |
|
Returns |
|
Source | Source/CountDown.spoon/init.lua line 512 |
Signature | CountDown:startUntil(time) |
---|---|
Type | Method |
Description | Start a countdown until time indicated in parameter. |
Parameters |
|
Returns | |
Source | Source/CountDown.spoon/init.lua line 604 |