TorqueScript Reference
Public Member Functions | List of all members
ModuleDefinition Class Reference

Inherits SimSet.

Public Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from SimObject
static S32 QSORT_CALLBACK compareFields (const void *a, const void *b)
 

Member Function Documentation

bool 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 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 getDependencyCount ( )

Gets the number of module dependencies this module definition has.

Returns
(int count) The number of module dependencies this module definition has.
int 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 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 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.