Skip to content

API

CreateSequence

Creates a tutorial sequence.

local Tutorial = OnBoard.CreateSequence(config)

Step

{
    Title = "...",
    Text = "...",
    Target = GuiObject,

    ShowArrow = true,
    ShowOverlay = true
}
Property Type Required
Title string
Text string
Target Instance
ShowArrow boolean
ShowOverlay boolean

Sequence

Start

Tutorial:Start()

Starts the tutorial.


Next

Tutorial:Next()

Moves to the next step.


Previous

Tutorial:Previous()

Moves to the previous step.


GoToStep

Tutorial:GoToStep(2)

Jumps to a step.


Stop

Tutorial:Stop()

Stops the tutorial and cleans everything up.