Class WalkthroughStep
Contains information needed to process one step of a walkthrough
Namespace: Unity.MARS.Templates
Syntax
public class WalkthroughStep : MonoBehaviourProperties
CanProgress
Returns true if this step does not currently have any triggers remaining to fire
Declaration
public bool CanProgress { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
CanSkip
Returns true if this step does not block, or has been completed at least once.
Declaration
public bool CanSkip { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Completed
True if this step's triggers have been activated at least once
Declaration
public bool Completed { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Description
The purpose of this step. Appends a (Complete) if complete and normally has triggers.
Declaration
public string Description { get; }Property Value
| Type | Description |
|---|---|
| String |
Methods
CancelStep()
Ends this step being the focus of the current walkthrough
Declaration
public void CancelStep()Initialize()
Ensures the step visuals are hidden until active and that all triggers are accounted for
Declaration
public void Initialize()StartStep(Action<Boolean>, Boolean)
Makes this step and its triggers the active focus of a walkthrough
Declaration
public void StartStep(Action<bool> onComplete, bool allowAutoProgress = true)Parameters
| Type | Name | Description |
|---|---|---|
| Action<Boolean> | onComplete | Callback to fire when this step's triggers are complete |
| Boolean | allowAutoProgress | If this step is allow to auto-progress during this activation |