Class ReasoningModule

Inheritance
Object
ScriptableSettingsBase
ScriptableSettingsBase<ReasoningModule>
ScriptableSettings<ReasoningModule>
ReasoningModule
Inherited Members
Unity.XRTools.Utils.Internal.ScriptableSettingsBase.GetInstanceByType(System.Type)
Namespace: Unity.MARS.Data.Reasoning
Syntax
[ModuleBehaviorCallbackOrder(1073741824)]
[ModuleUnloadOrder(1073741821)]
[ScriptableSettingsPath("Assets/MARS/Settings")]
[MovedFrom("Unity.MARS")]
public class ReasoningModule : ScriptableSettings<ReasoningModule>, IModuleBehaviorCallbacks, IModuleMarsUpdate, IModuleDependency<FunctionalityInjectionModule>, IModule, IUsesSlowTasks, IFunctionalitySubscriber<IProvidesSlowTasks>, IFunctionalitySubscriber

Properties

ExtraTraitRequirements

Set of traits requirements that should also be used when setting up reasoning APIs that might not already be included in the MARS Session.

Declaration
public HashSet<TraitRequirement> ExtraTraitRequirements { get; }
Property Value
Type Description
HashSet<TraitRequirement>

Methods

AddReasoningAPI(IReasoningAPI)

Allows a reasoning API to be dynamically added to the scene

Declaration
public void AddReasoningAPI(IReasoningAPI reasoningAPI)
Parameters
Type Name Description
IReasoningAPI reasoningAPI

ChangeReasoningAPIInterval(IReasoningAPI)

Allows a reasoning API to change its interval at runtime

Declaration
public void ChangeReasoningAPIInterval(IReasoningAPI reasoningAPI)
Parameters
Type Name Description
IReasoningAPI reasoningAPI

The reasoning API to update the interval for

FindReasoningAPI<T>()

Declaration
public T FindReasoningAPI<T>()
    where T : IReasoningAPI
Returns
Type Description
T
Type Parameters
Name Description
T

RemoveReasoningAPI(IReasoningAPI)

Removes a reasoning API from being processed in the scene

Declaration
public void RemoveReasoningAPI(IReasoningAPI reasoningAPI)
Parameters
Type Name Description
IReasoningAPI reasoningAPI

ResetReasoningAPIs()

Unload existing reasoning APIs and load new ones based on current scene requirements

Declaration
public void ResetReasoningAPIs()

Explicit Interface Implementations

IModuleMarsUpdate.OnMarsUpdate()

Called at fixed intervals while the MARS lifecycle is running

Declaration
void IModuleMarsUpdate.OnMarsUpdate()
Implements

IFunctionalitySubscriber<IProvidesSlowTasks>.provider

Declaration
IProvidesSlowTasks IFunctionalitySubscriber<IProvidesSlowTasks>.provider { get; set; }
Returns
Type Description
IProvidesSlowTasks
Implements

IModule.LoadModule()

Declaration
void IModule.LoadModule()
Implements

IModule.UnloadModule()

Declaration
void IModule.UnloadModule()
Implements

IModuleBehaviorCallbacks.OnBehaviorAwake()

Declaration
void IModuleBehaviorCallbacks.OnBehaviorAwake()
Implements

IModuleBehaviorCallbacks.OnBehaviorDestroy()

Declaration
void IModuleBehaviorCallbacks.OnBehaviorDestroy()
Implements

IModuleBehaviorCallbacks.OnBehaviorDisable()

Declaration
void IModuleBehaviorCallbacks.OnBehaviorDisable()
Implements

IModuleBehaviorCallbacks.OnBehaviorEnable()

Declaration
void IModuleBehaviorCallbacks.OnBehaviorEnable()
Implements

IModuleBehaviorCallbacks.OnBehaviorStart()

Declaration
void IModuleBehaviorCallbacks.OnBehaviorStart()
Implements

IModuleBehaviorCallbacks.OnBehaviorUpdate()

Declaration
void IModuleBehaviorCallbacks.OnBehaviorUpdate()
Implements

IModuleDependency<FunctionalityInjectionModule>.ConnectDependency(FunctionalityInjectionModule)

Declaration
void IModuleDependency<FunctionalityInjectionModule>.ConnectDependency(FunctionalityInjectionModule dependency)
Parameters
Type Name Description
FunctionalityInjectionModule dependency
Implements