Class FunctionalityInjectionModule
Module responsible for managing Functionality Islands
Inherited Members
Namespace: Unity.XRTools.ModuleLoader
Assembly: solution.dll
Syntax
[ScriptableSettingsPath("Assets/ModuleLoader/Settings")]
public class FunctionalityInjectionModule : ScriptableSettings<FunctionalityInjectionModule>, IModuleBehaviorCallbacks, IModuleProperties
| Name | Description |
|---|---|
| activeIsland | The active functionality island |
| defaultIsland | The default functionality island |
| islands | Currently loaded functionality islands |
Methods
| Name | Description |
|---|---|
| AddIsland(FunctionalityIsland) | Set up a Functionality Island and add it to the list of islands This must be done before the FunctionalityInjectionModule is loaded The recommended pattern is to implement IModuleDependency<FunctionalityInjectionModule> and add the island in ConnectDependency. If a hard dependency is not possible, ensure your module has a load order which is earlier than FunctionalityInjectionModule and add the island in LoadModule |
| LoadModule() | Called after all modules have been instantiated and dependencies are connected |
| OnBehaviorAwake() | Called by ModuleCallbacksBehaviour Awake as early as possible (using a very low Script Execution Order) |
| OnBehaviorDestroy() | Called by ModuleCallbacksBehaviour OnDestroy as early as possible (using a very low Script Execution Order) |
| OnBehaviorDisable() | Called by ModuleCallbacksBehaviour OnDisable as early as possible (using a very low Script Execution Order) |
| OnBehaviorEnable() | Called by ModuleCallbacksBehaviour OnEnable as early as possible (using a very low Script Execution Order) |
| OnBehaviorStart() | Called by ModuleCallbacksBehaviour Start as early as possible (using a very low Script Execution Order) |
| OnBehaviorUpdate() | Called by ModuleCallbacksBehaviour Update as early as possible (using a very low Script Execution Order) |
| PrintStatus() | Return a string describing the current state of this module, including which islands are loaded, which island is active, and what providers have been added to each island. |
| SetActiveIsland(FunctionalityIsland) | Set the active island |
| UnloadModule() | Called before system shuts down |
Events
| Name | Description |
|---|---|
| activeIslandChanged | Invoked when the active island changes |