Class ModuleLoaderCore
Core class for Module Loader package This is the entry point for loading modules and a hub for all callbacks and methods to access/control modules
Inherited Members
Namespace: Unity.XRTools.ModuleLoader
Assembly: solution.dll
Syntax
[ScriptableSettingsPath("Assets/ModuleLoader/Settings")]
public class ModuleLoaderCore : ScriptableSettings<ModuleLoaderCore>Fields
| Name | Description |
|---|---|
| ModuleLoaderAssetsFolder | Root folder for all assets automatically generated by ModuleLoader |
| SettingsPath | Default folder for project settings assets |
| UserSettingsFolder | Default folder for user settings assets |
Properties
| Name | Description |
|---|---|
| ModulesAreLoaded | True if modules have been loaded |
| isUnloadingModules | True if Module Loader is in the process of unloading modules |
| modules | List of all currently active/loaded modules |
Methods
| Name | Description |
|---|---|
| GetCurrentPlatform() | Get the current platform for the purposes of provider selection Ths will return the value of Application.platform, except in the editor in playmode if the Override Platform in Playmode setting is enabled. Then it will use the selected override platform. |
| GetModuleParent() | Get or create the GameObject to which all MonoBehaviour modules are added as children |
| GetModuleTypes(List<Type>) | Add all types which implement IModule to a list |
| GetModule<T>() | Get the module of the given type, if it has been loaded |
| InjectFunctionalityInModules(FunctionalityIsland) | Inject functionality on all modules using the provided FunctionalityIsland |
| LoadModules() | Load all modules, except those whose types are excluded by Module Loader settings |
| OnBehaviorAwake() | Invoke OnBehaviorAwake callback on all behavior callback modules |
| OnBehaviorDestroy() | Invoke OnBehaviorDestroy callback on all behavior callback modules |
| OnBehaviorDisable() | Invoke OnBehaviorDisable callback on all behavior callback modules |
| OnBehaviorEnable() | Invoke OnBehaviorEnable callback on all behavior callback modules |
| OnBehaviorStart() | Invoke OnBehaviorStart callback on all behavior callback modules |
| OnBehaviorUpdate() | Invoke OnBehaviorUpdate callback on all behavior callback modules |
| OnLoaded() | Function called when all scriptable settings are loaded and ready for use |
| ReloadModules() | Unload and then load modules |
| UnloadModules() | Unload all modules |
Events
| Name | Description |
|---|---|
| ModulesLoaded | Invoked when modules are loaded, after all calls to LoadModule |