ModuleDefinition
Public Attributes
string
The name of tags asset manifest file if this module contains asset tags. Optional: If not specified then no asset tags will be found for this module. Currently, only a single asset tag manifest should exist.
string
The author of the module.
int
The build Id. Non-breaking changes to a module should use a higher build Id. Optional: If not specified then the build Id will be zero.
string
The name of the function used to create the module. Optional: If not specified then no create function is called.
bool
Whether the merging of a module prior to a restart is critical or not. Optional: If not specified then the module is not merge critical.
string
A comma-separated list of module Ids/VersionIds (
bool
Whether the module is deprecated or not. Optional: If not specified then the module is not deprecated.
string
The description typically used for debugging purposes but can be used for anything.
string
The name of the function used to destroy the module. Optional: If not specified then no destroy function is called.
bool
Whether the module is enabled or not. When disabled, it is effectively ignored. Optional: If not specified then the module is enabled.
string
The module group used typically when loading modules as a group.
string
The file of the module. This is read-only and is available only after the module has been registered by a module manager.
string
The file-path of the module definition. This is read-only and is available only after the module has been registered by a module manager.
string
A unique string Id for the module. It can contain any characters except a comma or semi-colon (the asset scope character).
string
The path of the module. This is read-only and is available only after the module has been registered by a module manager.
string
The file-path of the script-file referenced in the module definition. This is read-only and is available only after the module has been registered by a module manager.
bool
Controls if when this module is loaded and the create function is executed, it will replace existing objects that share names or not.
int
The scope set used to control the lifetime scope of objects that the module uses. Objects added to this set are destroyed automatically when the module is unloaded.
string
The name of the script file to compile when loading the module. Optional.
string
A unique signature of the module definition based upon its Id, version and build. This is read-only and is available only after the module has been registered by a module manager.
bool
Whether the module should be synchronized or not. Optional: If not specified then the module is not synchronized.
string
The module type typically used to distinguish modules during module enumeration. Optional: If not specified then the type is empty although this can still be used as a pseudo 'global' type for instance.
int
The version Id. Breaking changes to a module should use a higher version Id.
Public Functions
bool
addDependency(string pModuleId, uint versionId)
Adds the specified moduleId and vesionId as a dependency.
String
getDependency(uint dependencyIndex)
Gets the module dependency at the specified index.
int
Gets the number of module dependencies this module definition has.
int
Gets the module manager which this module definition is registered with (if any).
bool
removeDependency(string pModuleId)
Removes the specified moduleId as a dependency.
bool
save()
Saves the module definition to the file it was loaded from (if any).
Detailed Description
UNDOCUMENTED!
Public Attributes
string AssetTagsManifest
The name of tags asset manifest file if this module contains asset tags. Optional: If not specified then no asset tags will be found for this module. Currently, only a single asset tag manifest should exist.
string Author
The author of the module.
int BuildId
The build Id. Non-breaking changes to a module should use a higher build Id. Optional: If not specified then the build Id will be zero.
string CreateFunction
The name of the function used to create the module. Optional: If not specified then no create function is called.
bool CriticalMerge
Whether the merging of a module prior to a restart is critical or not. Optional: If not specified then the module is not merge critical.
string Dependencies
A comma-separated list of module Ids/VersionIds (
bool Deprecated
Whether the module is deprecated or not. Optional: If not specified then the module is not deprecated.
string description
The description typically used for debugging purposes but can be used for anything.
string DestroyFunction
The name of the function used to destroy the module. Optional: If not specified then no destroy function is called.
bool Enabled
Whether the module is enabled or not. When disabled, it is effectively ignored. Optional: If not specified then the module is enabled.
string Group
The module group used typically when loading modules as a group.
string ModuleFile
The file of the module. This is read-only and is available only after the module has been registered by a module manager.
string ModuleFilePath
The file-path of the module definition. This is read-only and is available only after the module has been registered by a module manager.
string ModuleId
A unique string Id for the module. It can contain any characters except a comma or semi-colon (the asset scope character).
string ModulePath
The path of the module. This is read-only and is available only after the module has been registered by a module manager.
string ModuleScriptFilePath
The file-path of the script-file referenced in the module definition. This is read-only and is available only after the module has been registered by a module manager.
bool OverrideExistingObjects
Controls if when this module is loaded and the create function is executed, it will replace existing objects that share names or not.
int ScopeSet
The scope set used to control the lifetime scope of objects that the module uses. Objects added to this set are destroyed automatically when the module is unloaded.
string scriptFile
The name of the script file to compile when loading the module. Optional.
string Signature
A unique signature of the module definition based upon its Id, version and build. This is read-only and is available only after the module has been registered by a module manager.
bool Synchronized
Whether the module should be synchronized or not. Optional: If not specified then the module is not synchronized.
string type
The module type typically used to distinguish modules during module enumeration. Optional: If not specified then the type is empty although this can still be used as a pseudo 'global' type for instance.
int VersionId
The version Id. Breaking changes to a module should use a higher version Id.
Public Functions
addDependency(string pModuleId, uint versionId)
Adds the specified moduleId and vesionId as a dependency.
Parameters:
| moduleId | The module Id to add as a dependency. |
| versionId | The version Id to add as a dependency. Using zero indicates any version. |
(bool success) Whether the module dependency was added or not.
getDependency(uint dependencyIndex)
Gets the module dependency at the specified index.
Parameters:
| dependencyIndex | The module dependency index. |
(module - dependency) The module dependency at the specified index.
getDependencyCount()
Gets the number of module dependencies this module definition has.
(int count) The number of module dependencies this module definition has.
getModuleManager()
Gets the module manager which this module definition is registered with (if any).
(moduleManager) The module manager which this module definition is registered with (zero if not registered).
removeDependency(string pModuleId)
Removes the specified moduleId as a dependency.
Parameters:
| moduleId | The module Id to remove as a dependency. |
(bool success) Whether the module dependency was removed or not.
save()
Saves the module definition to the file it was loaded from (if any).
(bool success) Whether the module definition was saved or not.