mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Struct SceneInfo

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Microsoft.MixedReality.Toolkit.SceneSystem
    Assembly: cs.temp.dll.dll
    Syntax
    public struct SceneInfo

    Fields

    Asset

    SceneAsset reference. Since SceneAsset is an editor-only asset, we store an object reference instead.

    Declaration
    public UnityEngine.Object Asset
    Field Value
    Type Description
    UnityEngine.Object

    Asset

    SceneAsset reference. Since SceneAsset is an editor-only asset, we store an object reference instead.

    Declaration
    public UnityEngine.Object Asset
    Field Value
    Type Description
    UnityEngine.Object

    BuildIndex

    Build index of the scene. If included in build settings and enabled, this will be a value greater than zero. If not included or disabled, this will be -1

    Declaration
    public int BuildIndex
    Field Value
    Type Description
    Int32

    BuildIndex

    Build index of the scene. If included in build settings and enabled, this will be a value greater than zero. If not included or disabled, this will be -1

    Declaration
    public int BuildIndex
    Field Value
    Type Description
    Int32

    Included

    True if scene is included in build (NOT necessarily enabled)

    Declaration
    public bool Included
    Field Value
    Type Description
    Boolean

    Included

    True if scene is included in build (NOT necessarily enabled)

    Declaration
    public bool Included
    Field Value
    Type Description
    Boolean

    Name

    Name of the scene. Set by the property drawer.

    Declaration
    public string Name
    Field Value
    Type Description
    String

    Name

    Name of the scene. Set by the property drawer.

    Declaration
    public string Name
    Field Value
    Type Description
    String

    Path

    Path of the scene. Set by the property drawer.

    Declaration
    public string Path
    Field Value
    Type Description
    String

    Path

    Path of the scene. Set by the property drawer.

    Declaration
    public string Path
    Field Value
    Type Description
    String

    Tag

    Optional tag used to load and unload scenes in groups.

    Declaration
    public string Tag
    Field Value
    Type Description
    String

    Tag

    Optional tag used to load and unload scenes in groups.

    Declaration
    public string Tag
    Field Value
    Type Description
    String

    Properties

    Empty

    Declaration
    public static SceneInfo Empty { get; }
    Property Value
    Type Description
    SceneInfo

    Empty

    Declaration
    public static SceneInfo Empty { get; }
    Property Value
    Type Description
    SceneInfo

    IsEmpty

    Scene asset is not set.

    Declaration
    public bool IsEmpty { get; }
    Property Value
    Type Description
    Boolean

    IsEmpty

    Scene asset is not set.

    Declaration
    public bool IsEmpty { get; }
    Property Value
    Type Description
    Boolean

    IsEnabled

    Declaration
    public bool IsEnabled { get; }
    Property Value
    Type Description
    Boolean

    IsEnabled

    Declaration
    public bool IsEnabled { get; }
    Property Value
    Type Description
    Boolean

    IsInBuildSettings

    Returns true if the asset is not null and if the scene has a valid build index. Doesn't respect whether scene is enabled in build settings.

    Declaration
    public bool IsInBuildSettings { get; }
    Property Value
    Type Description
    Boolean

    IsInBuildSettings

    Returns true if the asset is not null and if the scene has a valid build index. Doesn't respect whether scene is enabled in build settings.

    Declaration
    public bool IsInBuildSettings { get; }
    Property Value
    Type Description
    Boolean
    In This Article
    • Fields
      • Asset
      • Asset
      • BuildIndex
      • BuildIndex
      • Included
      • Included
      • Name
      • Name
      • Path
      • Path
      • Tag
      • Tag
    • Properties
      • Empty
      • Empty
      • IsEmpty
      • IsEmpty
      • IsEnabled
      • IsEnabled
      • IsInBuildSettings
      • IsInBuildSettings
    Back to top Generated by DocFX