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

Inherits SimObject.

Public Member Functions

void clear ()
 
string getAsset (int resultIndex)
 
int getCount ()
 
bool set (assetQuery)
 
- 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

void clear ( )

Clears all asset Id results.

Returns
() No return value.
string getAsset ( int  resultIndex)

Gets the asset Id at the specified query result index.

Parameters
resultIndexThe query result index to use.
Returns
(assetId) The asset Id at the specified index or NULL if not valid.
int getCount ( )

Gets the count of asset Id results.

Returns
(int) The count of asset Id results.
bool set ( assetQuery  )

Sets the asset query to a copy of the specified asset query.

Parameters
assetQueryThe asset query to copy.
Returns
Whether the operation succeeded or not.