Class TutorialContainer.Section
A section/card for starting a tutorial or opening a web page.
Namespace: Unity.InteractiveTutorials
Syntax
[Serializable]
public class SectionFields
AuthorizedUrl
Use for Unity Connect auto-login, shortened URLs do not work
Declaration
[Tooltip("Use for Unity Connect auto-login, shortened URLs do not work")]
[HideInInspector]
[Obsolete("todo: No longer used, remove in 2.0")]
public bool AuthorizedUrlField Value
| Type | Description |
|---|---|
| Boolean |
Heading
Title of the card.
Declaration
public LocalizableString HeadingField Value
| Type | Description |
|---|---|
| LocalizableString |
Image
Image for the card.
Declaration
public Texture2D ImageField Value
| Type | Description |
|---|---|
| Texture2D |
LinkText
Used as content type metadata for external references/URLs
Declaration
[Tooltip("Used as content type metadata for external references/URLs")]
public string LinkTextField Value
| Type | Description |
|---|---|
| String |
OrderInView
Order the the view. Use 0, 2, 4, and so on.
Declaration
public int OrderInViewField Value
| Type | Description |
|---|---|
| Int32 |
Text
Description of the card.
Declaration
public LocalizableString TextField Value
| Type | Description |
|---|---|
| LocalizableString |
Tutorial
The tutorial this container contains
Declaration
public Tutorial TutorialField Value
| Type | Description |
|---|---|
| Tutorial |
Url
The URL of this section. Setting the URL will take precedence and make the card act as a link card instead of a tutorial card
Declaration
[Tooltip("Setting the URL will take precedence and make the card act as a link card instead of a tutorial card")]
public string UrlField Value
| Type | Description |
|---|---|
| String |
Properties
IsTutorial
Does this represent a tutorial?
Declaration
public bool IsTutorial { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
SessionStateKey
TODO 2.0 make internal.
Declaration
public string SessionStateKey { get; }Property Value
| Type | Description |
|---|---|
| String |
TutorialCompleted
Has the tutorial been already completed?
Declaration
public bool TutorialCompleted { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
TutorialId
The ID of the represented tutorial, if any
Declaration
public string TutorialId { get; }Property Value
| Type | Description |
|---|---|
| String |
Methods
LoadState()
Loads the state of the section from SessionState.
Declaration
public bool LoadState()Returns
| Type | Description |
|---|---|
| Boolean | returns true if the state was found from EditorPrefs |
OpenUrl()
Opens the URL Of the section, if any
Declaration
public void OpenUrl()SaveState()
Saves the state of the section from SessionState.
Declaration
public void SaveState()StartTutorial()
Starts the tutorial of the section
Declaration
public void StartTutorial()