Skip to main content
Version: 1.0

API

FunctionsDescription
tutorial.start(int tutorial_id, bool continue where left?)Starts the tutorial of specific ID. Optionally, you can tell whether you want to continue from the last played frame or not
tutorial.Stop()Stops the current tutorial. Command will be ignored if no active tutorial found
frame.Next()Goes to the next frame of the tutorial. Command will be ignored if no active tutorial found
frame.Prev()Goes to the previous frame of the tutorial. Command will be ignored if no active tutorial found
frame.GoTo(int frame_id)Goes to the frame of specified ID of the tutorial. Command will be ignored if no active tutorial found
data.Reset()Deletes PlayerPrefs related to the tutorial
VariablesDescription
data.tutorialsCompletedReturns an integer of number of tutorials that has been completed
data.tutorialsInProgressReturns an integer of number of tutorials that are in progress
tutorial.frameIdReturns the ID of currently played frame
tutorial.idReturns the ID of the currently active tutorial
tutorial.progressReturns a float, representing the progress of the current tutorial between 0 and 1. (1 means completed)