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

#include <assetQuery_ScriptBinding.h>

Inherits SimObject.

Public Member Functions

void clear ()
 
String getAsset (int resultIndex)
 
Integer getCount ()
 
Boolean set (assetQuery)
 
- Public Member Functions inherited from SimObject
void assignFieldsFrom (SimObject)
 
Integer clone ([copyDynamicFields=false]?)
 
void delete ()
 
Integer getId ()
 
void setName (newName)
 
String getName ()
 
String getClassNamespace ()
 
String getSuperClassNamespace ()
 
void setClassNamespace (nameSpace)
 
void setSuperClassNamespace ()
 
Boolean isMethod (string methodName)
 
String call (methodName, [args] *)
 
void dumpClassHierarchy ()
 
void dump ()
 
Boolean isMemberOfClass (string classname)
 
String getClassName ()
 
String getFieldValue (fieldName)
 
Boolean setFieldValue (fieldName, value)
 
Boolean setEditFieldValue (fieldName, value)
 
Integer getDynamicFieldCount ()
 
String getDynamicField (index)
 
Integer getFieldCount ()
 
String getField (int index)
 
void setProgenitorFile (file)
 
String getProgenitorFile ()
 
Integer getType ()
 
String getFieldType (fieldName)
 
void setInternalName (string InternalName)
 
String getInternalName ()
 
Boolean isChildOfGroup (groupID)
 
Integer getGroup ()
 
Boolean startTimer (callbackFunction, float timePeriod, [repeat]?)
 
void stopTimer ()
 
Boolean isTimerActive ()
 
Integer schedule (time, command, [arg] *)
 
void startListening (SimObject)
 
void stopListening (SimObject)
 
void addListener (SimObject)
 
void removeListener (SimObject)
 
void removeAllListeners ()
 
void postEvent (String eventName, String data)
 
Boolean save (fileName, [selectedOnly]?)
 
void addFieldFilter (fieldName)
 
void removeFieldFilter (fieldName)
 

Member Function Documentation

◆ clear()

void clear ( )

Clears all asset Id results.

Returns
() No return value.

◆ getAsset()

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.

◆ getCount()

Integer getCount ( )

Gets the count of asset Id results.

Returns
(int) The count of asset Id results.

◆ set()

Boolean 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.