Advanced Features

Refreshing Prompts

You can use SendPrompt also to refresh your prompts if they're already visible.
See here for ButtonMutables, i.e., things you can refresh.
If the sink is already queued, SendPrompt returns false, even when it restores missing prompts.
In order to update/refresh one of the mutables, simply call SendPrompt again with your updated parameters/prompts.

SendPrompt also restores any removed or dismissed prompts still returned by GetPrompts(). Rows follow the event order in GetPrompts(), with stacked actions sharing one row. Existing prompts are refreshed in place, without switching the selected stacked action, List selection, or client page. To keep a prompt removed when sending again, leave it out of GetPrompts().

Progress Circle

Controlling the Progress Circle

⚠️ Currently only available for Single-Press prompts.

You can take control of the progress circle that will appear around your button by giving a value to the progress field that is not 0.0.

Values in (0,1)

Values larger than 0 and smaller than 1 will set the progress circle to that fraction of the complete circle.

Values in ℝ ∖ ℤ

You can give numbers that are not whole numbers (non-integers) to trigger special instructions to SkyPrompt. SkyPrompt will map these numbers to an integer and a fractional part: $x \mapsto (z, r) \in ℤ \oplus (0, 1)$, where the integer part will be a multiplier and the fractional part the fraction of the full circle as before. The progress circle will then move starting from the fraction at the speed of the multiplier.

The Multiplier

Currently, a multiplier of magnitude 1 will lead to a full circle progress in 10 seconds.

Direction of the progress

The direction of the movement of the progress circle can be controlled by the sign of the value. A positive value will lead to a decreasing progress, vice versa.

⚠️ Important! Once the progress circle reaches 0 or 1, you will get a kDeclined event in both cases.

Examples

1. A prompt that gives the user a 1-second window to perform a certain action: 10.99
2. A prompt that gives the user to execute an action earlier that will auto-perform itself in 5 seconds: -2.01
3. Tutorial4 (Quick-Time) and Tutorial5 (Button-Mash) in Tutorial.h and Tutorial.cpp.