General

Commands

Visual layout

horiz() - Arrange multiple elements horizontally
mult() - Create multiple elements in one spot
page() - A simple page layout generator
vert() - Arrange multiple elements vertically

Content elements

pic() - Show an image
sound() - Play a sound
text() - Show some text

Interface elements

buttons() - Display a custom list of buttons
go() - Display a single button
yn() - Display two buttons for a yes/no question

Control flow

delay() - Create a timer and display it
goto() - Forward the user to another page

Control flow - PCM2 style

must() - A page must be set
mustnot() - A page must not be set
numactions() - A number of pages must be set
numactionsfrom() - A number of pages since page x must be set
range() - Randomly pick a page from a range
repeat() - Repeat a page multiple times
repeatset() - Set an action to be repeated
repeatadd() - Add to the previous repeat count
repeatdel() - Substract from the previous count
set() - Mark a page as set
unset() - Mark a page as unset

Instructions

stroke() - Demonstrates stroking speed

Utility functions

random() - Generate a random number

The Yes/No Question

Now let's say you wanted to ask a yes/no question.

goodbye#page(
	'You really want to leave already?',
	pic([...]),
	yn(end#,backOnTrack#)
);

The yn() command displays two buttons, the first of which reads "YES" and leads to the first specified action, in this case one called end#. The second button "NO" would lead to the action backOnTrack#. Of course we still have to write those two actions for the script to function properly.

Using the stopwatch

Let's give the user less control for a change. The delay() command allows us to display a timer.

backOnTrack#page(
	'So, you haven\'t got enough yet, then? Ok, stroke for two minutes.',
	pic([...]),
	delay(2min,circular#),
	stroke(40)
);

As you can see, the delay() command is pretty self explanatory. It requires two arguments: The delay which is specified as ??hrs, ??min or ??sec with '??' being the number that you wish to use. The second argument is the action to be called when the delay runs out.

But we also see a new, fourth parameter that calls a command called stroke(). What this does is display a "stroke meter" for the user to keep step to. The number in parentheses - in this case 40 - is the number of strokes per minute. Just like a metronome.

Continue

Continue with Scripting Tutorial 3: Parameters.