Class TutorialWelcomePage
Welcome page/dialog for a project shown using TutorialModalWindow.
Inherited Members
Namespace: Unity.Tutorials.Editor
Assembly: Unity.Tutorials.Editor.dll
Syntax
public class TutorialWelcomePage : ScriptableObject
Remarks
In addition of window title, header image, title, and description, a welcome page/dialog contains a fully customizable button row.
Fields
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 |
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()
RaiseModified()
Raises the Modified events for this asset.
Declaration
public void RaiseModified()