Class MARSSceneModule
Inheritance
Implements
Inherited Members
Namespace: Unity.MARS.Settings
Assembly: Unity.MARS.dll
Syntax
[ModuleBehaviorCallbackOrder(1073741823)]
[ScriptableSettingsPath("Assets/MARS/Settings")]
[MovedFrom("Unity.MARS")]
public class MARSSceneModule : ScriptableSettings<MARSSceneModule>, IModuleBehaviorCallbacks, IUsesCameraOffset, IFunctionalitySubscriber<IProvidesCameraOffset>, IFunctionalitySubscriber, IModuleDependency<FunctionalityInjectionModule>, IModuleProperties
BlockEnsureSession
Do not automatically create a session when proxies are detected in the scene
Declaration
public bool BlockEnsureSession { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
provider
The functionality provider
Declaration
public IProvidesCameraOffset provider { get; set; }Property Value
| Type | Description |
|---|---|
| IProvidesCameraOffset |
simulateDiscovery
When enabled and SimulateInPlayMode is enabled, the simulated discovery functionality island will be used.
Declaration
public bool simulateDiscovery { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
simulateInPlaymode
When enabled, the simulated environment will be added in play mode, and a simulation functionality island will be used.
Declaration
public bool simulateInPlaymode { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
simulatedDiscoveryInPlayMode
When enabled and SimulateInPlayMode is enabled, the simulated discovery functionality island will be used.
Declaration
public static bool simulatedDiscoveryInPlayMode { get; }Property Value
| Type | Description |
|---|---|
| bool |
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>> BeforeSetupDefaultProvidersEvent Type
| Type | Description |
|---|---|
| Action<List<IFunctionalityProvider>> |