Class TutorialPage

A TutorialPage consists of TutorialParagraphs which define the content of the page.

Inheritance

Object

TutorialPage

Namespace: Unity.Tutorials.Core.Editor

Syntax

public class TutorialPage : ScriptableObject, ISerializationCallbackReceiver

Fields

CriteriaCompletionStateTested

Raised when any page's criteria are tested for completion.

Declaration

public static TutorialPageEvent CriteriaCompletionStateTested

Field Value

Type	Description
TutorialPageEvent

CriteriaValidated

Raised when this page's criteria are tested for completion.

Declaration

public TutorialPageEvent CriteriaValidated

Field Value

Type	Description
TutorialPageEvent

DoneButton

The text shown on the next button on the last page.

Declaration

public LocalizableString DoneButton

Field Value

Type	Description
LocalizableString

MaskingSettingsChanged

Raised when this page's masking settings are changed.

Declaration

public TutorialPageEvent MaskingSettingsChanged

Field Value

Type	Description
TutorialPageEvent

NextButton

The text shown on the Next button on all pages except the last page.

Declaration

public LocalizableString NextButton

Field Value

Type	Description
LocalizableString

NonMaskingSettingsChanged

Raised when this page's non-masking settings are changed.

Declaration

public TutorialPageEvent NonMaskingSettingsChanged

Field Value

Type	Description
TutorialPageEvent

Showing

Raised before this page is displayed (even when going back).

Declaration

public TutorialPageEvent Showing

Field Value

Type	Description
TutorialPageEvent

Shown

Raised after this page is displayed (even when going back).

Declaration

public TutorialPageEvent Shown

Field Value

Type	Description
TutorialPageEvent

Staying

Raised while the user is staying on this tutorial page, every Editor frame.

Declaration

public TutorialPageEvent Staying

Field Value

Type	Description
TutorialPageEvent

TutorialPageMaskingSettingsChanged

Raised when any page's masking settings are changed.

Declaration

public static TutorialPageEvent TutorialPageMaskingSettingsChanged

Field Value

Type	Description
TutorialPageEvent

TutorialPageNonMaskingSettingsChanged

Raised when any page's non-masking settings are changed.

Declaration

public static TutorialPageEvent TutorialPageNonMaskingSettingsChanged

Field Value

Type	Description
TutorialPageEvent

Properties

AreAllCriteriaSatisfied

Are all criteria satisfied?

Declaration

public bool AreAllCriteriaSatisfied { get; }

Property Value

Type	Description
Boolean

AutoAdvanceOnComplete

Should we auto-advance upon completion.

Declaration

public bool AutoAdvanceOnComplete { get; set; }

Property Value

Type	Description
Boolean

HasMovedToNextPage

Are we moving to the next page?

Declaration

public bool HasMovedToNextPage { get; }

Property Value

Type	Description
Boolean

Paragraphs

Paragraphs of this page.

Declaration

public TutorialParagraphCollection Paragraphs { get; }

Property Value

Type	Description
TutorialParagraphCollection

Methods

HasCriteria()

Has the current page any completion criteria?

Declaration

public bool HasCriteria()

Returns

Type	Description
Boolean

OnAfterDeserialize()

UnityEngine.ISerializationCallbackReceiver override, do not call.

Declaration

public void OnAfterDeserialize()

OnBeforeSerialize()

UnityEngine.ISerializationCallbackReceiver override, do not call.

Declaration

public void OnBeforeSerialize()

RaiseMaskingSettingsChanged()

Raises TutorialPageMaskingSettingsChanged event.

Declaration

public void RaiseMaskingSettingsChanged()

RaiseNonMaskingSettingsChanged()

Raises TutorialPageNonMaskingSettingsChanged event.

Declaration

public void RaiseNonMaskingSettingsChanged()