Advance the tour to a completed state.
Exit the tour at the current step.
Reset the Tour to an un-started state.
Progress the Tour to the next step.
Rewind the Tour to the previous step.
Progresses to a given Step
The step to progress to
Reloads the Tour's current step from the saved progress
Query the DOM for the target element using the provided selector
A CSS selector
The target element, or null if not found
Clean-up operations performed after a step is completed.
Renders the current Step of the Tour
Activate a canvas layer and control for each step
Handle a movement action to either progress or regress the Tour.
Creates and returns a Tour by loading a JSON file
The path to the JSON file
The unique identifier of the tour.
The unique identifier of the tour.
The human-readable title for the tour.
The human-readable description of the tour.
The package namespace for the tour.
The package namespace for the tour.
The key the Tour is stored under in game.tours, of the form ${namespace}.${id}
The configuration of tour steps
Return the current Step, or null if the tour has not yet started.
The index of the current step; -1 if the tour has not yet started, or null if the tour is finished.
Returns True if there is a next TourStep
Returns True if there is a previous TourStep
The current status of the Tour
Indicates if a Tour is currently in progress.
Returns the active Tour, if any
The HTMLElement which is the focus of the current tour step.
The HTMLElement that fades out the rest of the screen
The HTMLElement that blocks input while a Tour is active
Padding around a Highlighted Element
A tour for demonstrating an aspect of Canvas functionality. Automatically activates a certain canvas layer or tool depending on the needs of the step.