Class TutorialContainer
A tutorial container is a collection of tutorial content, and is used to access the actual tutorials in the project.
Inherited Members
Namespace: Unity.Tutorials.Core.Editor
Syntax
public class TutorialContainer : ScriptableObject
Remarks
A tutorial container can be two things:
- Tutorial project (null Parent): a root container which is the entry point for tutorial content in the project.
- Tutorial category (non-null Parent): a set of tutorials that are a part of some other container
Fields
BackgroundImage
Background texture for the card/header.
Declaration
[FormerlySerializedAs("HeaderBackground")]
public Texture2D BackgroundImage
Field Value
Type | Description |
---|---|
Texture2D |
Description
Used as the tooltip for the container card.
Declaration
public LocalizableString Description
Field Value
Type | Description |
---|---|
LocalizableString |
Modified
Raised when any field of this container is modified.
Declaration
public TutorialContainerEvent Modified
Field Value
Type | Description |
---|---|
TutorialContainerEvent |
Remarks
If 'this' container is parented, we consider modifications to 'this' container also to be modifications of the parent.
OrderInView
This value determines the position of a container / container card within a container, if this container is shown as a card.
Declaration
public int OrderInView
Field Value
Type | Description |
---|---|
Int32 |
ParentContainer
By setting another container as a parent, this container becomes a tutorial category in the parent container.
Declaration
public TutorialContainer ParentContainer
Field Value
Type | Description |
---|---|
TutorialContainer |
ProjectLayout
Can be used to override or disable (the default behavior) the default project layout specified by the Tutorial Framework.
Declaration
public Object ProjectLayout
Field Value
Type | Description |
---|---|
Object |
Sections
Sections (tutorial or link card) of this container.
Declaration
public TutorialContainer.Section[] Sections
Field Value
Type | Description |
---|---|
TutorialContainer.Section[] |
Subtitle
Subtitle shown in the container card and header area.
Declaration
public LocalizableString Subtitle
Field Value
Type | Description |
---|---|
LocalizableString |
Title
Title shown in the card/header.
Declaration
public LocalizableString Title
Field Value
Type | Description |
---|---|
LocalizableString |
TutorialContainerModified
Raised when any TutorialContainer is modified.
Declaration
public static TutorialContainerEvent TutorialContainerModified
Field Value
Type | Description |
---|---|
TutorialContainerEvent |
Remarks
Raised before Modified event.
Properties
ProjectLayoutPath
Returns the path for the ProjectLayout, relative to the project folder, or a default tutorial layout path if ProjectLayout not specified.
Declaration
public string ProjectLayoutPath { get; }
Property Value
Type | Description |
---|---|
String |
Methods
LoadTutorialProjectLayout()
Loads the tutorial project layout
Declaration
public void LoadTutorialProjectLayout()
RaiseModified()
Raises the Modified events for this asset.
Declaration
public void RaiseModified()