Class TutorialWelcomePage

Welcome page/dialog for a project shown using TutorialModalWindow.

Inheritance

object

Object

ScriptableObject

TutorialWelcomePage

Implements

ISerializationCallbackReceiver

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, bool)

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, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Unity.Tutorials.Core.Editor

Assembly: Unity.Tutorials.Core.Editor.dll

Syntax

public class TutorialWelcomePage : ScriptableObject, ISerializationCallbackReceiver

Remarks

In addition of window title, header image, title, and description, a welcome page/dialog contains a fully customizable button row.

Fields

Modified

Raised when any field of the welcome page is modified.

Declaration

public TutorialWelcomePageEvent Modified

Field Value

Type	Description
TutorialWelcomePageEvent

TutorialWelcomePageModified

Raised when any welcome page is modified.

Declaration

public static TutorialWelcomePageEvent TutorialWelcomePageModified

Field Value

Type	Description
TutorialWelcomePageEvent

Remarks

Raised before Modified event.

Properties

Buttons

Buttons specified for the welcome page.

Declaration

public TutorialWelcomePage.ButtonData[] Buttons { get; set; }

Property Value

Type	Description
ButtonData[]

Description

Description of the welcome dialog.

Declaration

public LocalizableString Description { get; set; }

Property Value

Type	Description
LocalizableString

HeaderContent

The Video Media settings used by the header if the media type is set to Video

Declaration

public MediaContent HeaderContent { get; set; }

Property Value

Type	Description
MediaContent

Image

Header image of the welcome dialog if the HeaderType is set to Image

Declaration

[Obsolete("This is deprecated and will be removed in a future version. Use HeaderContent with Type set to Image")]
public Texture2D Image { get; set; }

Property Value

Type	Description
Texture2D

MaskEditor

Does this Welcome Dialog mask the rest of the editor when displayed

Declaration

public bool MaskEditor { get; set; }

Property Value

Type	Description
bool

Title

Title of the welcome dialog.

Declaration

public LocalizableString Title { get; set; }

Property Value

Type	Description
LocalizableString

WindowTitle

Window title of the welcome dialog.

Declaration

public LocalizableString WindowTitle { get; set; }

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	Page for which the buttons is created.

Returns

Type	Description
TutorialWelcomePage.ButtonData	Data structure for the button.

ExitEditor()

Exits the Editor.

Declaration

public void ExitEditor()

OnAfterDeserialize()

Called just after the asset was deserialized to disk

Declaration

public void OnAfterDeserialize()

OnBeforeSerialize()

Called before the asset is serialized to disk

Declaration

public void OnBeforeSerialize()

RaiseModified()

Raises the Modified events for this asset.

Declaration

public void RaiseModified()

Implements

ISerializationCallbackReceiver