docs.unity3d.com
    Show / Hide Table of Contents

    Class TutorialContainer

    An index for the tutorials in the project.

    Inheritance
    Object
    Object
    ScriptableObject
    TutorialContainer
    Inherited Members
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(String)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: Unity.InteractiveTutorials
    Syntax
    public class TutorialContainer : ScriptableObject

    Fields

    Description

    TODO 2.0 deprecated currently but might be used when we implement tutorial categories.

    Declaration
    [Obsolete]
    public LocalizableString Description
    Field Value
    Type Description
    LocalizableString

    HeaderBackground

    Background texture for the header area that is used to display Title and Subtitle.

    Declaration
    public Texture2D HeaderBackground
    Field Value
    Type Description
    Texture2D

    ProjectLayout

    Can be used to override or disable the default layout specified by the Tutorial Framework.

    Declaration
    [Tooltip("Can be used to override or disable the default layout specified by the Tutorial Framework.")]
    public Object ProjectLayout
    Field Value
    Type Description
    Object

    ProjectName

    Title shown in the header area.

    Declaration
    [Tooltip("Title shown in the header area.")]
    public LocalizableString ProjectName
    Field Value
    Type Description
    LocalizableString

    Sections

    Sections/cards of this container.

    Declaration
    public TutorialContainer.Section[] Sections
    Field Value
    Type Description
    TutorialContainer.Section[]

    Title

    Subtitle shown in the header area.

    Declaration
    [Tooltip("Subtitle shown in the header area.")]
    public LocalizableString Title
    Field Value
    Type Description
    LocalizableString

    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()

    RaiseModifiedEvent()

    Raises the Modified events for this asset.

    Declaration
    public void RaiseModifiedEvent()

    Events

    Modified

    Raised when any field of this container is modified.

    Declaration
    public event Action Modified
    Event Type
    Type Description
    Action

    TutorialContainerModified

    Raised when any TutorialContainer is modified.

    Declaration
    public static event Action<TutorialContainer> TutorialContainerModified
    Event Type
    Type Description
    Action<TutorialContainer>
    Remarks

    Raised before Modified event.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023