Main   GitHub

Methods | Fields | List of all members
ModuleDefinition Class Reference

Inherits SimSet, and SimSet.

Methods

bool addDependency (moduleId, versionId)
 
bool addDependency (moduleId, versionId)
 
string getDependency (int dependencyIndex)
 
string getDependency (int dependencyIndex)
 
int getDependencyCount ()
 
int getDependencyCount ()
 
int getModuleManager ()
 
int getModuleManager ()
 
bool removeDependency (moduleId)
 
bool removeDependency (moduleId)
 
bool save ()
 
bool save ()
 
- Methods inherited from SimSet
void add (obj1,...)
 
void add (obj1,...)
 
void bringToFront (object)
 
void bringToFront (object)
 
void callOnChildren (string method, string args...)
 
void callOnChildren (string method, string args...)
 
void clear ()
 
void clear ()
 
void deleteObjects ()
 
void deleteObjects ()
 
int findObjectByInternalName (string name,[bool searchChildren])
 
int findObjectByInternalName (string name,[bool searchChildren])
 
int getCount ()
 
int getCount ()
 
int getObject (objIndex)
 
int getObject (objIndex)
 
bool isMember (object)
 
bool isMember (object)
 
void listObjects ()
 
void listObjects ()
 
void pushToBack (object)
 
void pushToBack (object)
 
void remove (obj1,...)
 
void remove (obj1,...)
 
void reorderChild (child1, child2)
 
void reorderChild (child1, child2)
 
- Methods inherited from SimObject
void addFieldFilter (fieldName)
 
void addFieldFilter (fieldName)
 
string call (%args)
 
string call (%args)
 
int clone ([bool copyDynamicFields?=false])
 
int clone ([bool copyDynamicFields?=false])
 
void delete ()
 
void delete ()
 
void dump ()
 
void dump ()
 
void dumpClassHierarchy ()
 
void dumpClassHierarchy ()
 
string getClassName ()
 
string getClassName ()
 
string getClassNamespace ()
 
string getClassNamespace ()
 
string getDynamicField (index)
 
string getDynamicField (index)
 
int getDynamicFieldCount ()
 
int getDynamicFieldCount ()
 
string getField (int index)
 
string getField (int index)
 
int getFieldCount ()
 
int getFieldCount ()
 
string getFieldType (fieldName)
 
string getFieldType (fieldName)
 
string getFieldValue (fieldName)
 
string getFieldValue (fieldName)
 
int getGroup ()
 
int getGroup ()
 
int getId ()
 
int getId ()
 
string getInternalName ()
 
string getInternalName ()
 
string getName ()
 
string getName ()
 
string getProgenitorFile ()
 
string getProgenitorFile ()
 
string getSuperClassNamespace ()
 
string getSuperClassNamespace ()
 
int getType ()
 
int getType ()
 
bool isChildOfGroup ()
 
bool isChildOfGroup ()
 
bool isMemberOfClass (string classname)
 
bool isMemberOfClass (string classname)
 
bool isMethod (string method name)
 
bool isMethod (string method name)
 
bool isTimerActive ()
 
bool isTimerActive ()
 
void removeFieldFilter (fieldName)
 
void removeFieldFilter (fieldName)
 
bool save (fileName,[selectedOnly])
 
bool save (fileName,[selectedOnly])
 
int schedule (time, command,< arg1...argN >)
 
int schedule (time, command,< arg1...argN >)
 
void setClassNamespace ()
 
void setClassNamespace ()
 
bool setFieldValue (fieldName, value)
 
bool setFieldValue (fieldName, value)
 
void setInternalName ()
 
void setInternalName ()
 
void setName (newName)
 
void setName (newName)
 
void setProgenitorFile (file)
 
void setProgenitorFile (file)
 
void setSuperClassNamespace ()
 
void setSuperClassNamespace ()
 
bool startTimer (callbackFunction, float timePeriod,[repeat])
 
bool startTimer (callbackFunction, float timePeriod,[repeat])
 
void stopTimer ()
 
void stopTimer ()
 

Fields

string AssetTagsManifest
 
string Author
 
int BuildId
 
string CreateFunction
 
bool CriticalMerge
 
string Dependencies
 
bool Deprecated
 
string description
 
string DestroyFunction
 
bool Enabled
 
string Group
 
string ModuleFile
 
string ModuleFilePath
 
string ModuleId
 
string ModulePath
 
string ModuleScriptFilePath
 
int ScopeSet
 
string ScriptFile
 
string Signature
 
bool Synchronized
 
string Type
 
int VersionId
 
SimBase
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
Namespace Linking
string superclass
 
string class
 
- Fields inherited from SimSet
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
string superclass
 
string class
 
- Fields inherited from SimObject
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
string superclass
 
string class
 

Methods

bool ModuleDefinition::addDependency ( moduleId  ,
versionId   
)
  • Adds the specified moduleId and vesionId as a dependency.
    Parameters
    moduleIdThe module Id to add as a dependency.
    versionIdThe version Id to add as a dependency. Using zero indicates any version.
    Returns
    (bool success) Whether the module dependency was added or not.
bool ModuleDefinition::addDependency ( moduleId  ,
versionId   
)
  • Adds the specified moduleId and vesionId as a dependency.
    Parameters
    moduleIdThe module Id to add as a dependency.
    versionIdThe version Id to add as a dependency. Using zero indicates any version.
    Returns
    (bool success) Whether the module dependency was added or not.
string ModuleDefinition::getDependency ( int  dependencyIndex)
  • Gets the module dependency at the specified index.
    Parameters
    dependencyIndexThe module dependency index.
    Returns
    (module-dependency) The module dependency at the specified index.
string ModuleDefinition::getDependency ( int  dependencyIndex)
  • Gets the module dependency at the specified index.
    Parameters
    dependencyIndexThe module dependency index.
    Returns
    (module-dependency) The module dependency at the specified index.
int ModuleDefinition::getDependencyCount ( )
  • Gets the number of module dependencies this module definition has.
    Returns
    (int count) The number of module dependencies this module definition has.
int ModuleDefinition::getDependencyCount ( )
  • Gets the number of module dependencies this module definition has.
    Returns
    (int count) The number of module dependencies this module definition has.
int ModuleDefinition::getModuleManager ( )
  • Gets the module manager which this module definition is registered with (if any).
    Returns
    (moduleManager) The module manager which this module definition is registered with (zero if not registered).
int ModuleDefinition::getModuleManager ( )
  • Gets the module manager which this module definition is registered with (if any).
    Returns
    (moduleManager) The module manager which this module definition is registered with (zero if not registered).
bool ModuleDefinition::removeDependency ( moduleId  )
  • Removes the specified moduleId as a dependency.
    Parameters
    moduleIdThe module Id to remove as a dependency.
    Returns
    (bool success) Whether the module dependency was removed or not.
bool ModuleDefinition::removeDependency ( moduleId  )
  • Removes the specified moduleId as a dependency.
    Parameters
    moduleIdThe module Id to remove as a dependency.
    Returns
    (bool success) Whether the module dependency was removed or not.
bool ModuleDefinition::save ( )
  • Saves the module definition to the file it was loaded from (if any).
    Returns
    (bool success) Whether the module definition was saved or not.
bool ModuleDefinition::save ( )
  • Saves the module definition to the file it was loaded from (if any).
    Returns
    (bool success) Whether the module definition was saved or not.

Member Data Documentation

string ModuleDefinition::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 ModuleDefinition::Author

The author of the module.

int ModuleDefinition::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.

bool ModuleDefinition::canSaveDynamicFields
string ModuleDefinition::class

Script SuperClass of object.

string ModuleDefinition::CreateFunction

The name of the function used to create the module. Optional: If not specified then no create function is called.

bool ModuleDefinition::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 ModuleDefinition::Dependencies

A comma-separated list of module Ids/VersionIds (<ModuleId>=<VersionId>,<ModuleId>=<VersionId>,etc) which this module depends upon. Optional: If not specified then no dependencies are assumed.

bool ModuleDefinition::Deprecated

Whether the module is deprecated or not. Optional: If not specified then the module is not deprecated.

string ModuleDefinition::description

The description typically used for debugging purposes but can be used for anything.

string ModuleDefinition::DestroyFunction

The name of the function used to destroy the module. Optional: If not specified then no destroy function is called.

bool ModuleDefinition::Enabled

Whether the module is enabled or not. When disabled, it is effectively ignored. Optional: If not specified then the module is enabled.

string ModuleDefinition::Group

The module group used typically when loading modules as a group.

string ModuleDefinition::internalName
string ModuleDefinition::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 ModuleDefinition::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 ModuleDefinition::ModuleId

A unique string Id for the module. It can contain any characters except a comma or semi-colon (the asset scope character).

string ModuleDefinition::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 ModuleDefinition::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.

SimObjectPtr ModuleDefinition::parentGroup

Group hierarchy parent of the object.

int ModuleDefinition::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 ModuleDefinition::ScriptFile

The name of the script file to compile when loading the module. Optional.

string ModuleDefinition::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.

string ModuleDefinition::superclass

Script Class of object.

bool ModuleDefinition::Synchronized

Whether the module should be synchronized or not. Optional: If not specified then the module is not synchronized.

string ModuleDefinition::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 ModuleDefinition::VersionId

The version Id. Breaking changes to a module should use a higher version Id.



Copyright © 2013 GarageGames, LLC. All Rights Reserved.