Class Tutorial

Inheritance

Object

Tutorial

Namespace: Unity.InteractiveTutorials

Syntax

public class Tutorial : ScriptableObject

Constructors

Tutorial()

Declaration

public Tutorial()

Properties

assetSelectedOnExit

Declaration

public UnityEngine.Object assetSelectedOnExit { get; }

Property Value

Type	Description
UnityEngine.Object

completed

Declaration

public bool completed { get; }

Property Value

Type	Description
Boolean

completedPage

Declaration

public TutorialWelcomePage completedPage { get; }

Property Value

Type	Description
TutorialWelcomePage

currentPage

Declaration

public TutorialPage currentPage { get; }

Property Value

Type	Description
TutorialPage

currentPageIndex

Declaration

public int currentPageIndex { get; }

Property Value

Type	Description
Int32

exitBehavior

Declaration

public Tutorial.ExitBehavior exitBehavior { get; }

Property Value

Type	Description
Tutorial.ExitBehavior

isAutoCompleting

Declaration

public bool isAutoCompleting { get; }

Property Value

Type	Description
Boolean

lessonId

Declaration

public string lessonId { get; }

Property Value

Type	Description
String

pageCount

Declaration

public int pageCount { get; }

Property Value

Type	Description
Int32

pages

Declaration

public IEnumerable<TutorialPage> pages { get; }

Property Value

Type	Description
IEnumerable<TutorialPage>

skipped

Declaration

public bool skipped { get; }

Property Value

Type	Description
Boolean

skipTutorialBehavior

Declaration

public Tutorial.SkipTutorialBehavior skipTutorialBehavior { get; }

Property Value

Type	Description
Tutorial.SkipTutorialBehavior

tutorialTitle

Declaration

public string tutorialTitle { get; }

Property Value

Type	Description
String

version

Declaration

public string version { get; }

Property Value

Type	Description
String

welcomePage

Declaration

public TutorialWelcomePage welcomePage { get; }

Property Value

Type	Description
TutorialWelcomePage

Methods

GoToPreviousPage()

Declaration

public void GoToPreviousPage()

OnGoingBack(TutorialPage)

Declaration

protected virtual void OnGoingBack(TutorialPage page)

Parameters

Type	Name	Description
TutorialPage	page

OnPageInitiated(TutorialPage, Int32)

Declaration

protected virtual void OnPageInitiated(TutorialPage page, int index)

Parameters

Type	Name	Description
TutorialPage	page
Int32	index

OnTutorialCompleted(Boolean)

Declaration

protected virtual void OnTutorialCompleted(bool exitTutorial)

Parameters

Type	Name	Description
Boolean	exitTutorial

OnTutorialInitiated()

Declaration

protected virtual void OnTutorialInitiated()

RaiseTutorialPagesModified()

Declaration

public void RaiseTutorialPagesModified()

SkipToLastPage()

Declaration

public void SkipToLastPage()

StartAutoCompletion()

Declaration

public void StartAutoCompletion()

StopAutoCompletion()

Declaration

public void StopAutoCompletion()

StopTutorial()

Declaration

public void StopTutorial()

TryGoToNextPage()

Declaration

public bool TryGoToNextPage()

Returns

Type	Description
Boolean

Events

goingBack

Declaration

public event Action<TutorialPage> goingBack

Event Type

Type	Description
Action<TutorialPage>

pageInitiated

Declaration

public event Action<TutorialPage, int> pageInitiated

Event Type

Type	Description
Action<TutorialPage, Int32>

tutorialCompleted

Declaration

public event Action<bool> tutorialCompleted

Event Type

Type	Description
Action<Boolean>

tutorialInitiated

Declaration

public event Action tutorialInitiated

Event Type

Type	Description
Action

tutorialPagesModified

Declaration

public static event Action<Tutorial> tutorialPagesModified

Event Type

Type	Description
Action<Tutorial>