Class TutorialPage

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

Inheritance

Object

Object

ScriptableObject

TutorialPage

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(String)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(Object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, Boolean)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, Single)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.name

Object.hideFlags

Namespace: Unity.InteractiveTutorials

Syntax

public class TutorialPage : ScriptableObject, ISerializationCallbackReceiver

Fields

DoneButton

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

Declaration

[Tooltip("The text shown on the Next button on the last page.")]
public LocalizableString DoneButton

Field Value

Type	Description
LocalizableString

NextButton

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

Declaration

[Header("Button Labels")]
[Tooltip("The text shown on the next button on all pages except the last page.")]
public LocalizableString NextButton

Field Value

Type	Description
LocalizableString

Properties

allCriteriaAreSatisfied

Declaration

public bool allCriteriaAreSatisfied { get; }

Property Value

Type	Description
Boolean

autoAdvanceOnComplete

Declaration

public bool autoAdvanceOnComplete { get; set; }

Property Value

Type	Description
Boolean

currentMaskingSettings

Declaration

public MaskingSettings currentMaskingSettings { get; }

Property Value

Type	Description
MaskingSettings

doneButton

TODO 2.0 deprecated, remove.

Declaration

public string doneButton { get; set; }

Property Value

Type	Description
String

guid

Returns the asset database GUID of this asset.

Declaration

public string guid { get; }

Property Value

Type	Description
String

hasMovedToNextPage

Declaration

public bool hasMovedToNextPage { get; }

Property Value

Type	Description
Boolean

nextButton

TODO 2.0 deprecated, remove.

Declaration

public string nextButton { get; set; }

Property Value

Type	Description
String

paragraphs

Declaration

public TutorialParagraphCollection paragraphs { get; }

Property Value

Type	Description
TutorialParagraphCollection

Methods

HasCriteria()

Declaration

public bool HasCriteria()

Returns

Type	Description
Boolean

OnAfterDeserialize()

UnityEngine.ISerializationCallbackReceiver override, do not call.

Declaration

public void OnAfterDeserialize()

Implements

ISerializationCallbackReceiver.OnAfterDeserialize()

OnBeforeSerialize()

UnityEngine.ISerializationCallbackReceiver override, do not call.

Declaration

public void OnBeforeSerialize()

Implements

ISerializationCallbackReceiver.OnBeforeSerialize()

OnPageCompleted()

TODO 2.0 Make internal.

Declaration

public void OnPageCompleted()

RaiseOnAfterPageShownEvent()

Called right after the frontend of the page is displayed to the user TODO 2.0 Make internal.

Declaration

public void RaiseOnAfterPageShownEvent()

RaiseOnBeforePageShownEvent()

Called when the frontend of the page has not been displayed yet to the user TODO 2.0 Make internal.

Declaration

public void RaiseOnBeforePageShownEvent()

RaiseTutorialPageMaskingSettingsChangedEvent()

TODO 2.0 Make internal.

Declaration

public void RaiseTutorialPageMaskingSettingsChangedEvent()

RaiseTutorialPageNonMaskingSettingsChangedEvent()

TODO 2.0 Make internal.

Declaration

public void RaiseTutorialPageNonMaskingSettingsChangedEvent()

ResetUserProgress()

TODO 2.0 Make internal.

Declaration

public void ResetUserProgress()

UpdateFutureObjectReferenceName(FutureObjectReference)

TODO 2.0 Make internal.

Declaration

public void UpdateFutureObjectReferenceName(FutureObjectReference futureReference)

Parameters

Type	Name	Description
FutureObjectReference	futureReference

Events

criteriaCompletionStateTested

Declaration

public static event Action<TutorialPage> criteriaCompletionStateTested

Event Type

Type	Description
Action<TutorialPage>

tutorialPageMaskingSettingsChanged

Declaration

public static event Action<TutorialPage> tutorialPageMaskingSettingsChanged

Event Type

Type	Description
Action<TutorialPage>

tutorialPageNonMaskingSettingsChanged

Declaration

public static event Action<TutorialPage> tutorialPageNonMaskingSettingsChanged

Event Type

Type	Description
Action<TutorialPage>