Class Tutorial
Syntax
public class Tutorial : ScriptableObject
Constructors
Tutorial()
Declaration
Properties
assetSelectedOnExit
Declaration
public Object assetSelectedOnExit { get; }
Property Value
completed
Declaration
public bool completed { get; }
Property Value
completedPage
Declaration
[SerializeField]
public TutorialWelcomePage completedPage { get; }
Property Value
currentPage
Declaration
public TutorialPage currentPage { get; }
Property Value
currentPageIndex
Declaration
public int currentPageIndex { get; }
Property Value
exitBehavior
Declaration
public Tutorial.ExitBehavior exitBehavior { get; }
Property Value
isAutoCompleting
Declaration
public bool isAutoCompleting { get; }
Property Value
lessonId
Declaration
public string lessonId { get; }
Property Value
pageCount
Declaration
public int pageCount { get; }
Property Value
pages
Declaration
public IEnumerable<TutorialPage> pages { get; }
Property Value
skipped
Declaration
public bool skipped { get; }
Property Value
skipTutorialBehavior
Declaration
public Tutorial.SkipTutorialBehavior skipTutorialBehavior { get; }
Property Value
tutorialTitle
Declaration
public string tutorialTitle { get; }
Property Value
version
Declaration
public string version { get; }
Property Value
welcomePage
Declaration
public TutorialWelcomePage welcomePage { get; }
Property Value
Methods
GoToPreviousPage()
Declaration
public void GoToPreviousPage()
OnGoingBack(TutorialPage)
Declaration
protected virtual void OnGoingBack(TutorialPage page)
Parameters
OnPageInitiated(TutorialPage, Int32)
Declaration
protected virtual void OnPageInitiated(TutorialPage page, int index)
Parameters
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
Events
goingBack
Declaration
public event Action<TutorialPage> goingBack
Event Type
pageInitiated
Declaration
public event Action<TutorialPage, int> pageInitiated
Event Type
tutorialCompleted
Declaration
public event Action<bool> tutorialCompleted
Event Type
tutorialInitiated
Declaration
public event Action tutorialInitiated
Event Type
tutorialPagesModified
Declaration
public static event Action<Tutorial> tutorialPagesModified
Event Type
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.