![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The loader interface.
The loader is a thread which provides functionality for loading and unloading resource packages parallel to the engine's logic and rendering processing.
The IEngineConfiguration::SetResourceFileCategory() setting specifies the working directory for the loader.
The ILoader object is provided by the IAppState and the Logic::IState object.
Definition of the load operation modes.
Murl.ILoader.LOAD_MODE_STARTUP | Load the package before engine startup. |
Murl.ILoader.LOAD_MODE_BACKGROUND | Load the package immediately in background. |
Murl.ILoader.LOAD_MODE_ON_DEMAND | Load the package on demand using the IPackage. |
Murl.ILoader.NUM_LOAD_MODES |
Add a logic processor without a package. Logic processors without a package can be added before startup only.
Boolean AddProcessor(Murl.SharedPointer.LogicIProcessor processor)
processor | The logic processor to add. |
Remove a logic processor added by AddProcessor().
Boolean RemoveProcessor(Murl.SharedPointer.LogicIProcessor processor)
processor | The logic processor to remove. |
Create and register a package by name.
Murl.IPackage AddPackage(String packageName, Murl.ILoader.LoadMode mode)
packageName | The name of the package. |
mode | The load mode. |
Create and register a package by name and category.
Murl.IPackage AddPackage(String packageName, Murl.IEnums.FileCategory category, Murl.ILoader.LoadMode mode)
packageName | The name of the package. |
category | The file category. |
mode | The load mode. |
Create and register a package by name, category and a corresponding logic processor.
Murl.IPackage AddPackage(String packageName, Murl.IEnums.FileCategory category, Murl.ILoader.LoadMode mode, Murl.SharedPointer.LogicIProcessor processor)
packageName | The name of the package. |
category | The file category. |
mode | The load mode. |
processor | The corresponding logic processor. |
Create and register a package by name and a corresponding logic processor.
Murl.IPackage AddPackage(String packageName, Murl.ILoader.LoadMode mode, Murl.SharedPointer.LogicIProcessor processor)
packageName | The name of the package. |
mode | The load mode. |
processor | The corresponding logic processor. |
Remove a registered package by name. A package can be removed only if package is unloaded.
Boolean RemovePackage(String packageName)
packageName | The name of the package to remove. |
Get a registered package of a specified package name.
Murl.IPackage GetPackage(String packageName)
packageName | The name of the package. |
Get a registered package connected to a given processor.
Murl.IPackage GetPackage(Murl.SharedPointer.LogicIProcessor processor)
processor | The processor to query. |
Load a registered package.
Boolean LoadPackage(String packageName)
packageName | The name of the package. |
Load a registered package.
Boolean UnloadPackage(String packageName)
packageName | The name of the package. |