Class TutorialWelcomePage

Welcome page/dialog for a project shown using TutorialModalWindow. In addition of window title, header image, title, and description, a welcome page/dialog contains a fully customizable button row.

Inheritance

Object

Object

ScriptableObject

TutorialWelcomePage

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 TutorialWelcomePage : ScriptableObject

Properties

Buttons

Buttons specified for the welcome page.

Declaration

public TutorialWelcomePage.ButtonData[] Buttons { get; }

Property Value

Type	Description
TutorialWelcomePage.ButtonData[]

Description

Description of the welcome dialog.

Declaration

public LocalizableString Description { get; }

Property Value

Type	Description
LocalizableString

Image

Header image of the welcome dialog.

Declaration

public Texture2D Image { get; }

Property Value

Type	Description
Texture2D

Title

Title of the welcome dialog.

Declaration

public LocalizableString Title { get; }

Property Value

Type	Description
LocalizableString

WindowTitle

Window title of the welcome dialog.

Declaration

public LocalizableString WindowTitle { get; }

Property Value

Type	Description
LocalizableString

Methods

CloseCurrentModalDialog()

Closes the an open instance of TutorialModalWindow.

Declaration

public void CloseCurrentModalDialog()

CreateCloseButton(TutorialWelcomePage)

Creates a default Close button.

Declaration

public static TutorialWelcomePage.ButtonData CreateCloseButton(TutorialWelcomePage page)

Parameters

Type	Name	Description
TutorialWelcomePage	page

Returns

Type	Description
TutorialWelcomePage.ButtonData

ExitEditor()

Exits the Editor.

Declaration

public void ExitEditor()

RaiseModifiedEvent()

Raises the Modified events for this asset.

Declaration

public void RaiseModifiedEvent()

StartTutorial()

Starts the tutorial specified as the start-up tutorial for the project.

Declaration

public void StartTutorial()

Events

Modified

Raised when any field of the welcome page is modified.

Declaration

public event Action Modified

Event Type

Type	Description
Action

TutorialWelcomePageModified

Raised when any welcome page is modified.

Declaration

public static event Action<TutorialWelcomePage> TutorialWelcomePageModified

Event Type

Type	Description
Action<TutorialWelcomePage>

Remarks

Raised before Modified event.