Class Walkthrough
Defines a walkthrough - a series of steps gated by triggers
Namespace: Unity.MARS.Templates
Syntax
public class Walkthrough : MonoBehaviourFields
WalkthroughChangedCallback
Event that is raised whenever the state of the walkthrough has changed.
Declaration
public Action WalkthroughChangedCallbackField Value
| Type | Description |
|---|---|
| Action |
Properties
CurrentStep
The currently active step of the walkthrough
Declaration
public int CurrentStep { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
steps
All of the steps this walkthrough requires, in order
Declaration
public WalkthroughStep[] steps { get; }Property Value
| Type | Description |
|---|---|
| WalkthroughStep[] |
WalkthroughName
The name of the walkthrough experience
Declaration
public string WalkthroughName { get; }Property Value
| Type | Description |
|---|---|
| String |
Methods
SkipToStep(Int32, Boolean)
Shifts to another step of the walkthrough
Declaration
public void SkipToStep(int stepIndex, bool autoProgressIfComplete = false)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | stepIndex | The step to make active |
| Boolean | autoProgressIfComplete | If true, allows for skipping to the subsequent step if the current one is already complete. |