Class TutorialContainer.Section

A section/card for starting a tutorial or opening a web page.

Inheritance

object

TutorialContainer.Section

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Tutorials.Core.Editor

Assembly: Unity.Tutorials.Core.Editor.dll

Syntax

[Serializable]
public class TutorialContainer.Section

Fields

Heading

Title of the card.

Declaration

public LocalizableString Heading

Field Value

Type	Description
LocalizableString

Image

Image for the card.

Declaration

public Texture2D Image

Field Value

Type	Description
Texture2D

Metadata

Used as content type metadata for external references/URLs

Declaration

[Tooltip("Used as content type metadata for external references/URLs")]
[FormerlySerializedAs("LinkText")]
public string Metadata

Field Value

Type	Description
string

OrderInView

This value determines the position of a section / section card within a container.

Declaration

[Tooltip("This value determines the position of a section / section card within a container.")]
public int OrderInView

Field Value

Type	Description
int

Text

Description of the card.

Declaration

public LocalizableString Text

Field Value

Type	Description
LocalizableString

Tutorial

The tutorial this container contains

Declaration

public Tutorial Tutorial

Field 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 Url

Field Value

Type	Description
string

Properties

IsConfiguredCorrectly

Is this section set up properly? Does it have all the data needed to fulfill its purpose?

Declaration

public bool IsConfiguredCorrectly { get; }

Property Value

Type	Description
bool

IsTutorial

Does this represent a tutorial?

Declaration

public bool IsTutorial { get; }

Property Value

Type	Description
bool

TutorialId

The ID of the represented tutorial, if any

Declaration

public string TutorialId { get; }

Property Value

Type	Description
string

Methods

OpenUrl()

Opens the URL Of the section, if any

Declaration

public void OpenUrl()

StartTutorial()

Starts the tutorial of the section

Declaration

[Obsolete("Will be removed in v4. Use TutorialWindow.StartTutorial() instead")]
public void StartTutorial()