docs.unity3d.com
    Show / Hide Table of Contents

    Class MARSSceneModule

    Inheritance
    Object
    ScriptableSettingsBase
    ScriptableSettingsBase<MARSSceneModule>
    ScriptableSettings<MARSSceneModule>
    MARSSceneModule
    Inherited Members
    ScriptableSettings<MARSSceneModule>.instance
    ScriptableSettingsBase<MARSSceneModule>.k_HasCustomPath
    ScriptableSettingsBase<MARSSceneModule>.s_Instance
    ScriptableSettingsBase<MARSSceneModule>.Save(String)
    ScriptableSettingsBase<MARSSceneModule>.GetFilePath()
    ScriptableSettingsBase.k_PathExceptionMessage
    ScriptableSettingsBase.GetInstanceByType(Type)
    ScriptableSettingsBase.OnLoaded()
    Namespace: Unity.MARS.Settings
    Syntax
    [MovedFrom("Unity.MARS")]
    public class MARSSceneModule : ScriptableSettings<MARSSceneModule>, IModuleBehaviorCallbacks, IUsesCameraOffset, IFunctionalitySubscriber<IProvidesCameraOffset>, IFunctionalitySubscriber, IModuleDependency<FunctionalityInjectionModule>, IModule

    Properties

    BlockEnsureSession

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

    provider

    Declaration
    public IProvidesCameraOffset provider { get; set; }
    Property Value
    Type Description
    IProvidesCameraOffset
    Implements
    IFunctionalitySubscriber<TProvider>.provider

    simulatedDiscoveryInPlayMode

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

    simulateDiscovery

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

    simulateInPlaymode

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

    Methods

    AddRuntimeSceneObjects(IEnumerable<Object>)

    Add runtime objects to include when gathering functionality subscribers and providers from the MARS scene. This also updates the scene requirements in the MARS Session.

    Declaration
    public void AddRuntimeSceneObjects(IEnumerable<object> sceneObjects)
    Parameters
    Type Name Description
    IEnumerable<Object> sceneObjects

    Collection of objects to include in the MARS scene

    Events

    BeforeSetupDefaultProviders

    Called right before default providers are setup. The list should be filled out with providers that you want this module to add before it sets up default providers.

    Declaration
    public event Action<List<IFunctionalityProvider>> BeforeSetupDefaultProviders
    Event Type
    Type Description
    Action<List<IFunctionalityProvider>>

    Explicit Interface Implementations

    IModule.LoadModule()

    Declaration
    void IModule.LoadModule()
    Implements
    IModule.LoadModule()

    IModule.UnloadModule()

    Declaration
    void IModule.UnloadModule()
    Implements
    IModule.UnloadModule()

    IModuleBehaviorCallbacks.OnBehaviorAwake()

    Declaration
    void IModuleBehaviorCallbacks.OnBehaviorAwake()
    Implements
    IModuleBehaviorCallbacks.OnBehaviorAwake()

    IModuleBehaviorCallbacks.OnBehaviorDestroy()

    Declaration
    void IModuleBehaviorCallbacks.OnBehaviorDestroy()
    Implements
    IModuleBehaviorCallbacks.OnBehaviorDestroy()

    IModuleBehaviorCallbacks.OnBehaviorDisable()

    Declaration
    void IModuleBehaviorCallbacks.OnBehaviorDisable()
    Implements
    IModuleBehaviorCallbacks.OnBehaviorDisable()

    IModuleBehaviorCallbacks.OnBehaviorEnable()

    Declaration
    void IModuleBehaviorCallbacks.OnBehaviorEnable()
    Implements
    IModuleBehaviorCallbacks.OnBehaviorEnable()

    IModuleBehaviorCallbacks.OnBehaviorStart()

    Declaration
    void IModuleBehaviorCallbacks.OnBehaviorStart()
    Implements
    IModuleBehaviorCallbacks.OnBehaviorStart()

    IModuleBehaviorCallbacks.OnBehaviorUpdate()

    Declaration
    void IModuleBehaviorCallbacks.OnBehaviorUpdate()
    Implements
    IModuleBehaviorCallbacks.OnBehaviorUpdate()

    IModuleDependency<FunctionalityInjectionModule>.ConnectDependency(FunctionalityInjectionModule)

    Declaration
    void IModuleDependency<FunctionalityInjectionModule>.ConnectDependency(FunctionalityInjectionModule dependency)
    Parameters
    Type Name Description
    FunctionalityInjectionModule dependency
    Implements
    IModuleDependency<T>.ConnectDependency(T)
    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