Inherits AssetBase.
Public Member Functions | |
| bool | getAnimationCycle () |
| int | getAnimationFrameCount ([bool validatedFrames]) |
| string | getAnimationFrames ([bool validatedFrames]) |
| float | getAnimationTime () |
| string | getImage () |
| void | setAnimationCycle (bool animationCycle) |
| void | setAnimationFrames (animationFrames) |
| void | setAnimationTime (float animationTime) |
| void | setImage (assetId) |
 Public Member Functions inherited from AssetBase | |
| string | getAssetId () |
| void | refreshAsset () |
| 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 getAnimationCycle | ( | ) |
Gets whether the animation cycles or not.
- Returns
- Whether the animation cycles or not.
| int getAnimationFrameCount | ( | ) |
Gets the count of frame that compose the animation or optionally only the ones validated against the image asset.
- Parameters
-
validatedFrames - Whether to return only the validated frames or not. Optional: Default is false.
- Returns
- The image frames that compose the animation or optionally only the ones validated against the image asset.
| string getAnimationFrames | ( | ) |
Gets the frames that compose the animation or optionally only the ones validated against the image asset.
- Parameters
-
validatedFrames - Whether to return only the validated frames or not. Optional: Default is false.
- Returns
- The image frames that compose the animation or optionally only the ones validated against the image asset.
| float getAnimationTime | ( | ) |
Gets the total time to cycle through all animation frames.
- Returns
- The total time to cycle through all animation frames.
| string getImage | ( | ) |
Gets the image asset Id.
- Returns
- The image asset Id.
| void setAnimationCycle | ( | bool | animationCycle | ) |
Sets whether the animation cycles or not.
- Parameters
-
animationCycle Whether the animation cycles or not.
- Returns
- No return value.
| void setAnimationFrames | ( | animationFrames | ) |
Sets the image frames that compose the animation.
- Parameters
-
animationFrames A set of image frames that compose the animation.
- Returns
- No return value.
| void setAnimationTime | ( | float | animationTime | ) |
Sets the total time to cycle through all animation frames.
- Parameters
-
animationTime The total time to cycle through all animation frames.
- Returns
- No return value.
| void setImage | ( | assetId | ) |
Sets the image asset Id.
- Returns
- No return value.
