Members
(static) data :object
Any data that might need stored for the Tutorial.
For example, the number of key presses when typing a node name.
Type:
- object
- Source:
(static) frames :object
Data for each frame of the tutorial.
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
message |
string | the text to display on screen for this frame |
gateway |
number | object | either milliseconds to stay on screen for, or an object containing event data that describes an event on which to continue to the next frame |
- Source:
(static) index :number
Index of the current frame.
Type:
- number
- Source:
(static) running :boolean
Is the tutorial currently running?
Type:
- boolean
- Source:
(static) standard_message_interval
Standard time interval between messages, in milliseconds.
type {number}
- Source:
Methods
(static) continue()
Continue to the next frame.
- Source:
(static) frame(frame)
Run a single frame of the tutorial.
Parameters:
| Name | Type | Description |
|---|---|---|
frame |
object | one of Syntree.Tutorial.frames |
- Source:
(static) instruction(text)
Display a new message to the screen.
Parameters:
| Name | Type | Description |
|---|---|---|
text |
string | the text to display. |
- Source:
(static) quit()
Quit the tutorial.
- Source:
(static) start()
Start the tutorial.
- Source: