Class TutorialProjectSettings
Controls start-up and initial settings and behavior of the tutorial project.
Inherited Members
Namespace: Unity.Tutorials.Core.Editor
Assembly: Unity.Tutorials.Core.Editor.dll
Syntax
public class TutorialProjectSettings : ScriptableObject
Properties
AppendDataToReport
If this is set to true data about the current tutorial will be appended as an URL variable to the report url The target website can then process that URL to handle it.
Declaration
public bool AppendDataToReport { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
InitialCameraSettings
Initial camera settings when the project is loaded for the first time.
Declaration
public SceneViewCameraSettings InitialCameraSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| SceneViewCameraSettings |
InitialScene
Initial scene that is loaded when the project is started for the first time.
Declaration
public SceneAsset InitialScene { get; set; }
Property Value
| Type | Description |
|---|---|
| SceneAsset |
Instance
The singleton instance.
Declaration
public static TutorialProjectSettings Instance { get; set; }
Property Value
| Type | Description |
|---|---|
| TutorialProjectSettings |
ReportUrl
The address the link at the bottom of the Tutorial Window used to report problem with the Tutorials
Declaration
public string ReportUrl { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
RestoreAssetsBackupOnTutorialReload
If enabled, the original assets of the project are restored when a tutorial starts.
Declaration
public bool RestoreAssetsBackupOnTutorialReload { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
RestoreDefaultAssetsOnTutorialReload
If enabled, the original assets of the project are restored when a tutorial starts.
Declaration
[Obsolete("Will be removed in v4. Use RestoreAssetsBackupOnTutorialReload instead")]
public bool RestoreDefaultAssetsOnTutorialReload { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
TutorialStyle
Style settings asset for the project. If no asset exists, a default asset will be used.
Declaration
public TutorialStyles TutorialStyle { get; set; }
Property Value
| Type | Description |
|---|---|
| TutorialStyles |
WelcomePage
The page shown in the welcome dialog when the project is started for the first time.
Declaration
public TutorialWelcomePage WelcomePage { get; set; }
Property Value
| Type | Description |
|---|---|
| TutorialWelcomePage |