Main   GitHub

Methods | Fields | List of all members
SpriteBase Class Reference

Inherits SceneObject, and SceneObject.

Inherited by Scroller, Scroller, Sprite, and Sprite.

Methods

string getAnimation ()
 
string getAnimation ()
 
int getAnimationFrame ()
 
int getAnimationFrame ()
 
float getAnimationTime ()
 
float getAnimationTime ()
 
float getAnimationTimeScale ()
 
float getAnimationTimeScale ()
 
string getImage ()
 
string getImage ()
 
int getImageFrame ()
 
int getImageFrame ()
 
bool getIsAnimationFinished ()
 
bool getIsAnimationFinished ()
 
bool isStaticFrameProvider ()
 
bool isStaticFrameProvider ()
 
void pauseAnimation (bool enable)
 
void pauseAnimation (bool enable)
 
bool playAnimation (string animationAssetId)
 
bool playAnimation (string animationAssetId)
 
void setAnimationFrame (int frame)
 
void setAnimationFrame (int frame)
 
void setAnimationTimeScale (float timeScale)
 
void setAnimationTimeScale (float timeScale)
 
bool setImage (string imageAssetId,[int frame])
 
bool setImage (string imageAssetId,[int frame])
 
bool setImageFrame (frame)
 
bool setImageFrame (frame)
 
void stopAnimation ()
 
void stopAnimation ()
 
- Methods inherited from SceneObject
void addToScene (Scene scene)
 
void addToScene (Scene scene)
 
void applyAngularImpulse (impulse)
 
void applyAngularImpulse (impulse)
 
void applyForce (worldForce X/Y,[worldPoint X/Y])
 
void applyForce (worldForce X/Y,[worldPoint X/Y])
 
void applyLinearImpulse (worldImpulse X/Y,[worldPoint X/Y])
 
void applyLinearImpulse (worldImpulse X/Y,[worldPoint X/Y])
 
void applyTorque (torque)
 
void applyTorque (torque)
 
void attachGui (guiControl guiObject, SceneWindow window,[sizeControl?=false])
 
void attachGui (guiControl guiObject, SceneWindow window,[sizeControl?=false])
 
void cancelMoveTo ([autoStop=true])
 
void cancelMoveTo ([autoStop=true])
 
void cancelRotateTo ([autoStop=true])
 
void cancelRotateTo ([autoStop=true])
 
void clearCollisionShapes ()
 
void clearCollisionShapes ()
 
void copyAllCollisionShapes (targetObject[, clearTargetShapes?])
 
void copyAllCollisionShapes (targetObject[, clearTargetShapes?])
 
int copyCollisionShape (int shapeIndex, targetObject)
 
int copyCollisionShape (int shapeIndex, targetObject)
 
bool copyFrom (SceneObject object,[copyDynamicFields?=false])
 
bool copyFrom (SceneObject object,[copyDynamicFields?=false])
 
int createChainCollisionShape (localPointsX/Y,[adjacentLocalPositionStartX, adjacentLocalPositionStartY],[adjacentLocalPositionEndX, adjacentLocalPositionEndY])
 
int createChainCollisionShape (localPointsX/Y,[adjacentLocalPositionStartX, adjacentLocalPositionStartY],[adjacentLocalPositionEndX, adjacentLocalPositionEndY])
 
int createCircleCollisionShape (radius,[localPositionX, localPositionY])
 
int createCircleCollisionShape (radius,[localPositionX, localPositionY])
 
int createEdgeCollisionShape (localPositionStartX, localPositionStartY, localPositionEndX, localPositionEndY,[adjacentLocalPositionStartX, adjacentLocalPositionStartY],[adjacentLocalPositionEndX, adjacentLocalPositionEndY])
 
int createEdgeCollisionShape (localPositionStartX, localPositionStartY, localPositionEndX, localPositionEndY,[adjacentLocalPositionStartX, adjacentLocalPositionStartY],[adjacentLocalPositionEndX, adjacentLocalPositionEndY])
 
int createPolygonBoxCollisionShape (width, height,[localCentroidX, localCentroidY],[angle])
 
int createPolygonBoxCollisionShape (width, height,[localCentroidX, localCentroidY],[angle])
 
int createPolygonCollisionShape (localPointsX/Y)
 
int createPolygonCollisionShape (localPointsX/Y)
 
bool deleteCollisionShape (int shapeIndex)
 
bool deleteCollisionShape (int shapeIndex)
 
void detachGui ()
 
void detachGui ()
 
string getAABB ()
 
string getAABB ()
 
bool getActive ()
 
bool getActive ()
 
float getAlphaTest ()
 
float getAlphaTest ()
 
float getAngle ()
 
float getAngle ()
 
float getAngularDamping ()
 
float getAngularDamping ()
 
float getAngularVelocity ()
 
float getAngularVelocity ()
 
string getArea ()
 
string getArea ()
 
string getAreaMax (float x2/float y2)
 
string getAreaMax (float x2/float y2)
 
string getAreaMin ()
 
string getAreaMin ()
 
bool getAutoSizing ()
 
bool getAutoSizing ()
 
bool getAwake ()
 
bool getAwake ()
 
float getBlendAlpha ()
 
float getBlendAlpha ()
 
string getBlendColor (allowColorNames)
 
string getBlendColor (allowColorNames)
 
bool getBlendMode ()
 
bool getBlendMode ()
 
string getBodyType ()
 
string getBodyType ()
 
bool getBullet ()
 
bool getBullet ()
 
string getChainCollisionShapeAdjacentEnd (int shapeIndex)
 
string getChainCollisionShapeAdjacentEnd (int shapeIndex)
 
string getChainCollisionShapeAdjacentStart (int shapeIndex)
 
string getChainCollisionShapeAdjacentStart (int shapeIndex)
 
bool getChainCollisionShapeHasAdjacentEnd (int shapeIndex)
 
bool getChainCollisionShapeHasAdjacentEnd (int shapeIndex)
 
bool getChainCollisionShapeHasAdjacentStart (int shapeIndex)
 
bool getChainCollisionShapeHasAdjacentStart (int shapeIndex)
 
string getChainCollisionShapeLocalPoint (int shapeIndex, int pointIndex)
 
string getChainCollisionShapeLocalPoint (int shapeIndex, int pointIndex)
 
int getChainCollisionShapePointCount (int shapeIndex)
 
int getChainCollisionShapePointCount (int shapeIndex)
 
string getCircleCollisionShapeLocalPosition (int shapeIndex)
 
string getCircleCollisionShapeLocalPosition (int shapeIndex)
 
float getCircleCollisionShapeRadius (int shapeIndex)
 
float getCircleCollisionShapeRadius (int shapeIndex)
 
bool getCollisionCallback ()
 
bool getCollisionCallback ()
 
string getCollisionGroups ()
 
string getCollisionGroups ()
 
string getCollisionLayers ()
 
string getCollisionLayers ()
 
string getCollisionMasks (groupMask/layerMask)
 
string getCollisionMasks (groupMask/layerMask)
 
float getCollisionShapeArea (int shapeIndex)
 
float getCollisionShapeArea (int shapeIndex)
 
int getCollisionShapeCount ()
 
int getCollisionShapeCount ()
 
float getCollisionShapeDensity (int shapeIndex)
 
float getCollisionShapeDensity (int shapeIndex)
 
float getCollisionShapeFriction (int shapeIndex)
 
float getCollisionShapeFriction (int shapeIndex)
 
bool getCollisionShapeIsSensor (int shapeIndex)
 
bool getCollisionShapeIsSensor (int shapeIndex)
 
float getCollisionShapeRestitution (int shapeIndex)
 
float getCollisionShapeRestitution (int shapeIndex)
 
string getCollisionShapeType (int shapeIndex)
 
string getCollisionShapeType (int shapeIndex)
 
bool getCollisionSuppress ()
 
bool getCollisionSuppress ()
 
string getContact (contactIndex)
 
string getContact (contactIndex)
 
int getContactCount ()
 
int getContactCount ()
 
float getDefaultDensity ()
 
float getDefaultDensity ()
 
float getDefaultFriction ()
 
float getDefaultFriction ()
 
float getDefaultRestitution ()
 
float getDefaultRestitution ()
 
string getDstBlendFactor ()
 
string getDstBlendFactor ()
 
string getEdgeCollisionShapeAdjacentEnd (int shapeIndex)
 
string getEdgeCollisionShapeAdjacentEnd (int shapeIndex)
 
string getEdgeCollisionShapeAdjacentStart (int shapeIndex)
 
string getEdgeCollisionShapeAdjacentStart (int shapeIndex)
 
bool getEdgeCollisionShapeHasAdjacentEnd (int shapeIndex)
 
bool getEdgeCollisionShapeHasAdjacentEnd (int shapeIndex)
 
bool getEdgeCollisionShapeHasAdjacentStart (int shapeIndex)
 
bool getEdgeCollisionShapeHasAdjacentStart (int shapeIndex)
 
string getEdgeCollisionShapeLocalPositionEnd (int shapeIndex)
 
string getEdgeCollisionShapeLocalPositionEnd (int shapeIndex)
 
string getEdgeCollisionShapeLocalPositionStart (int shapeIndex)
 
string getEdgeCollisionShapeLocalPositionStart (int shapeIndex)
 
bool getFixedAngle ()
 
bool getFixedAngle ()
 
bool getGatherContacts ()
 
bool getGatherContacts ()
 
float getGravityScale ()
 
float getGravityScale ()
 
float getHeight ()
 
float getHeight ()
 
float getInertia ()
 
float getInertia ()
 
bool getIsPointInCollisionShape (int shapeIndex, worldPointX/Y)
 
bool getIsPointInCollisionShape (int shapeIndex, worldPointX/Y)
 
bool getIsPointInOOBB (worldPointX/Y)
 
bool getIsPointInOOBB (worldPointX/Y)
 
float getLifetime ()
 
float getLifetime ()
 
float getLinearDamping ()
 
float getLinearDamping ()
 
string getLinearVelocity ()
 
string getLinearVelocity ()
 
string getLinearVelocityFromLocalPoint (localPointX/Y)
 
string getLinearVelocityFromLocalPoint (localPointX/Y)
 
string getLinearVelocityFromWorldPoint (worldPointX/Y)
 
string getLinearVelocityFromWorldPoint (worldPointX/Y)
 
string getLinearVelocityPolar ()
 
string getLinearVelocityPolar ()
 
float getLinearVelocityX ()
 
float getLinearVelocityX ()
 
float getLinearVelocityY ()
 
float getLinearVelocityY ()
 
string getLocalCenter ()
 
string getLocalCenter ()
 
string getLocalPoint (float worldPointX/Y)
 
string getLocalPoint (float worldPointX/Y)
 
string getLocalVector (float worldVectorX/Y)
 
string getLocalVector (float worldVectorX/Y)
 
float getMass ()
 
float getMass ()
 
bool getPickingAllowed ()
 
bool getPickingAllowed ()
 
string getPolygonCollisionShapeLocalPoint (int shapeIndex, int pointIndex)
 
string getPolygonCollisionShapeLocalPoint (int shapeIndex, int pointIndex)
 
int getPolygonCollisionShapePointCount (int shapeIndex)
 
int getPolygonCollisionShapePointCount (int shapeIndex)
 
string getPosition ()
 
string getPosition ()
 
float getRenderAngle ()
 
float getRenderAngle ()
 
string getRenderGroup ()
 
string getRenderGroup ()
 
string getRenderPosition ()
 
string getRenderPosition ()
 
int getScene ()
 
int getScene ()
 
int getSceneGroup ()
 
int getSceneGroup ()
 
int getSceneLayer ()
 
int getSceneLayer ()
 
float getSceneLayerDepth ()
 
float getSceneLayerDepth ()
 
string getSize ()
 
string getSize ()
 
float getSizeX ()
 
float getSizeX ()
 
float getSizeY ()
 
float getSizeY ()
 
bool getSleepingAllowed ()
 
bool getSleepingAllowed ()
 
bool getSleepingCallback ()
 
bool getSleepingCallback ()
 
string getSortPoint ()
 
string getSortPoint ()
 
float getSortPointX ()
 
float getSortPointX ()
 
float getSortPointY ()
 
float getSortPointY ()
 
string getSrcBlendFactor ()
 
string getSrcBlendFactor ()
 
bool getUpdateCallback ()
 
bool getUpdateCallback ()
 
bool getUseInputEvents ()
 
bool getUseInputEvents ()
 
bool getVisible ()
 
bool getVisible ()
 
float getWidth ()
 
float getWidth ()
 
string getWorldCenter ()
 
string getWorldCenter ()
 
string getWorldPoint (float localPointX/Y)
 
string getWorldPoint (float localPointX/Y)
 
string getWorldVector (float localVectorX/Y)
 
string getWorldVector (float localVectorX/Y)
 
bool isMoveToComplete ()
 
bool isMoveToComplete ()
 
bool isRotateToComplete ()
 
bool isRotateToComplete ()
 
bool moveTo (worldPoint X/Y, speed,[autoStop=true],[warpToTarget=true])
 
bool moveTo (worldPoint X/Y, speed,[autoStop=true],[warpToTarget=true])
 
void removeFromScene ()
 
void removeFromScene ()
 
bool rotateTo (angle, speed,[autoStop=true],[warpToTarget=true])
 
bool rotateTo (angle, speed,[autoStop=true],[warpToTarget=true])
 
void safeDelete ()
 
void safeDelete ()
 
void setActive ([bool status?])
 
void setActive ([bool status?])
 
void setAlphaTest (float alpha)
 
void setAlphaTest (float alpha)
 
void setAngle (float angle)
 
void setAngle (float angle)
 
void setAngularDamping (float damping)
 
void setAngularDamping (float damping)
 
void setAngularVelocity (float velocity)
 
void setAngularVelocity (float velocity)
 
void setArea (float x1, float y1, float x2, float y2)
 
void setArea (float x1, float y1, float x2, float y2)
 
void setAwake ([bool status?])
 
void setAwake ([bool status?])
 
void setBlendAlpha (float alpha)
 
void setBlendAlpha (float alpha)
 
void setBlendColor (float red, float green, float blue,[float alpha=1.0])
 
void setBlendColor (float red, float green, float blue,[float alpha=1.0])
 
void setBlendMode (bool blendMode)
 
void setBlendMode (bool blendMode)
 
void setBodyType (bodyType type)
 
void setBodyType (bodyType type)
 
void setBullet ([bool status?])
 
void setBullet ([bool status?])
 
void setCollisionAgainst (SceneObject object,[clearMasks?=false])
 
void setCollisionAgainst (SceneObject object,[clearMasks?=false])
 
void setCollisionCallback ([bool status?])
 
void setCollisionCallback ([bool status?])
 
void setCollisionGroups (groups)
 
void setCollisionGroups (groups)
 
void setCollisionLayers (layers)
 
void setCollisionLayers (layers)
 
void setCollisionMasks (groupMask,[layerMask])
 
void setCollisionMasks (groupMask,[layerMask])
 
void setCollisionShapeDensity (int shapeIndex, float density)
 
void setCollisionShapeDensity (int shapeIndex, float density)
 
void setCollisionShapeFriction (int shapeIndex, float friction)
 
void setCollisionShapeFriction (int shapeIndex, float friction)
 
void setCollisionShapeIsSensor (int shapeIndex, bool status)
 
void setCollisionShapeIsSensor (int shapeIndex, bool status)
 
void setCollisionShapeRestitution (int shapeIndex, float restitution)
 
void setCollisionShapeRestitution (int shapeIndex, float restitution)
 
void setCollisionSuppress ([bool status?])
 
void setCollisionSuppress ([bool status?])
 
void setDebugOff (debugOptions)
 
void setDebugOff (debugOptions)
 
void setDebugOn (debugOptions)
 
void setDebugOn (debugOptions)
 
void setDefaultDensity (float density,[bool updateShapes])
 
void setDefaultDensity (float density,[bool updateShapes])
 
void setDefaultFriction (float friction,[bool updateShapes])
 
void setDefaultFriction (float friction,[bool updateShapes])
 
void setDefaultRestitution (float restitution,[bool updateShapes])
 
void setDefaultRestitution (float restitution,[bool updateShapes])
 
void setDstBlendFactor (dstBlend)
 
void setDstBlendFactor (dstBlend)
 
void setEnabled (bool status)
 
void setEnabled (bool status)
 
void setFixedAngle (bool status?)
 
void setFixedAngle (bool status?)
 
void setGatherContacts (bool gatherContacts)
 
void setGatherContacts (bool gatherContacts)
 
void setGravityScale (float scale)
 
void setGravityScale (float scale)
 
void setHeight (float height)
 
void setHeight (float height)
 
void setLifetime (float lifetime)
 
void setLifetime (float lifetime)
 
void setLinearDamping (float damping)
 
void setLinearDamping (float damping)
 
void setLinearVelocity (float velocityX, float velocityY)
 
void setLinearVelocity (float velocityX, float velocityY)
 
void setLinearVelocityPolar (float angle, float speed)
 
void setLinearVelocityPolar (float angle, float speed)
 
void setLinearVelocityX (float velocityX)
 
void setLinearVelocityX (float velocityX)
 
void setLinearVelocityY (float velocityY)
 
void setLinearVelocityY (float velocityY)
 
void setPickingAllowed (bool pickingAllowed)
 
void setPickingAllowed (bool pickingAllowed)
 
void setPosition (float x, float y)
 
void setPosition (float x, float y)
 
void setPositionX (float x)
 
void setPositionX (float x)
 
void setPositionY (float y)
 
void setPositionY (float y)
 
void setRenderGroup (renderGroup)
 
void setRenderGroup (renderGroup)
 
void setSceneGroup (integer group)
 
void setSceneGroup (integer group)
 
void setSceneLayer (integer layer)
 
void setSceneLayer (integer layer)
 
void setSceneLayerDepth (float layerDepth)
 
void setSceneLayerDepth (float layerDepth)
 
bool setSceneLayerDepthBack ()
 
bool setSceneLayerDepthBack ()
 
bool setSceneLayerDepthBackward ()
 
bool setSceneLayerDepthBackward ()
 
bool setSceneLayerDepthForward ()
 
bool setSceneLayerDepthForward ()
 
bool setSceneLayerDepthFront ()
 
bool setSceneLayerDepthFront ()
 
void setSize (float width, float height)
 
void setSize (float width, float height)
 
void setSizeX (float width)
 
void setSizeX (float width)
 
void setSizeY (float height)
 
void setSizeY (float height)
 
void setSleepingAllowed ([bool status?])
 
void setSleepingAllowed ([bool status?])
 
void setSleepingCallback ([bool status?])
 
void setSleepingCallback ([bool status?])
 
void setSortPoint (float x, float y)
 
void setSortPoint (float x, float y)
 
void setSortPointX (float x)
 
void setSortPointX (float x)
 
void setSortPointY (float y)
 
void setSortPointY (float y)
 
void setSrcBlendFactor (srcBlend)
 
void setSrcBlendFactor (srcBlend)
 
void setUpdateCallback ([bool status?])
 
void setUpdateCallback ([bool status?])
 
void setUseInputEvents (bool inputStatus)
 
void setUseInputEvents (bool inputStatus)
 
void setVisible (bool status)
 
void setVisible (bool status)
 
void setWidth (float width)
 
void setWidth (float width)
 
- Methods inherited from BehaviorComponent
bool addBehavior (BehaviorInstance bi)
 
bool addBehavior (BehaviorInstance bi)
 
void clearBehaviors ()
 
void clearBehaviors ()
 
bool connect (outputBehavior, inputBehavior, outputName, inputName)
 
bool connect (outputBehavior, inputBehavior, outputName, inputName)
 
bool disconnect (outputBehavior, inputBehavior, outputName, inputName)
 
bool disconnect (outputBehavior, inputBehavior, outputName, inputName)
 
int getBehavior (string BehaviorTemplateName)
 
int getBehavior (string BehaviorTemplateName)
 
int getBehaviorByIndex (int index)
 
int getBehaviorByIndex (int index)
 
string getBehaviorConnection (outputBehavior, outputName, connectionIndex)
 
string getBehaviorConnection (outputBehavior, outputName, connectionIndex)
 
int getBehaviorConnectionCount (outputBehavior, outputName)
 
int getBehaviorConnectionCount (outputBehavior, outputName)
 
int getBehaviorCount ()
 
int getBehaviorCount ()
 
bool raise (outputBehavior, outputName,[deltaTime])
 
bool raise (outputBehavior, outputName,[deltaTime])
 
bool removeBehavior (BehaviorInstance bi,[bool deleteBehavior=true])
 
bool removeBehavior (BehaviorInstance bi,[bool deleteBehavior=true])
 
bool reOrder (BehaviorInstance inst,[int desiredIndex=0])
 
bool reOrder (BehaviorInstance inst,[int desiredIndex=0])
 
- Methods inherited from DynamicConsoleMethodComponent
string callOnBehaviors (methodName, argi)
 
string callOnBehaviors (methodName, argi)
 
- Methods inherited from SimComponent
bool addComponents (%compObjName,%compObjName2,...)
 
bool addComponents (%compObjName,%compObjName2,...)
 
int getComponent (idx)
 
int getComponent (idx)
 
int getComponentCount ()
 
int getComponentCount ()
 
bool isEnabled ()
 
bool isEnabled ()
 
bool removeComponents (%compObjName,%compObjName2,...)
 
bool removeComponents (%compObjName,%compObjName2,...)
 
void setEnabled (enabled)
 
void setEnabled (enabled)
 
- 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

bool Active
 
float AlphaTest
 
float Angle
 
float AngularDamping
 
float AngularVelocity
 
animationAssetPtr Animation
 
bool Awake
 
ColorF BlendColor
 
bool BlendMode
 
enumval BodyType
 
bool Bullet
 
bool CollisionCallback
 
int CollisionGroups
 
int CollisionLayers
 
bool CollisionSuppress
 
float DefaultDensity
 
float DefaultFriction
 
float DefaultRestitution
 
enumval DstBlendFactor
 
bool Enabled
 
bool FixedAngle
 
int Frame
 
bool GatherContacts
 
float GravityScale
 
imageAssetPtr Image
 
float Lifetime
 
float LinearDamping
 
Vector2 LinearVelocity
 
bool PickingAllowed
 
Vector2 Position
 
string RenderGroup
 
SimObjectPtr Scene
 
int SceneGroup
 
int SceneLayer
 
float SceneLayerDepth
 
Vector2 Size
 
bool SleepingAllowed
 
bool SleepingCallback
 
Vector2 SortPoint
 
enumval SrcBlendFactor
 
bool UpdateCallback
 
bool UseInputEvents
 
bool Visible
 
SimBase
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
Namespace Linking
string superclass
 
string class
 
- Fields inherited from SceneObject
bool Active
 
float AlphaTest
 
float Angle
 
float AngularDamping
 
float AngularVelocity
 
bool Awake
 
ColorF BlendColor
 
bool BlendMode
 
enumval BodyType
 
bool Bullet
 
bool CollisionCallback
 
int CollisionGroups
 
int CollisionLayers
 
bool CollisionSuppress
 
float DefaultDensity
 
float DefaultFriction
 
float DefaultRestitution
 
enumval DstBlendFactor
 
bool Enabled
 
bool FixedAngle
 
bool GatherContacts
 
float GravityScale
 
float Lifetime
 
float LinearDamping
 
Vector2 LinearVelocity
 
bool PickingAllowed
 
Vector2 Position
 
string RenderGroup
 
SimObjectPtr Scene
 
int SceneGroup
 
int SceneLayer
 
float SceneLayerDepth
 
Vector2 Size
 
bool SleepingAllowed
 
bool SleepingCallback
 
Vector2 SortPoint
 
enumval SrcBlendFactor
 
bool UpdateCallback
 
bool UseInputEvents
 
bool Visible
 
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
string superclass
 
string class
 
- Fields inherited from BehaviorComponent
bool Enabled
 
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
string superclass
 
string class
 
- Fields inherited from DynamicConsoleMethodComponent
bool Enabled
 
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
string superclass
 
string class
 
- Fields inherited from SimComponent
bool Enabled
 
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

string SpriteBase::getAnimation ( )
  • Gets current animation asset Id.
    Returns
    (string AnimationAssetId) The current animation asset Id.
string SpriteBase::getAnimation ( )
  • Gets current animation asset Id.
    Returns
    (string AnimationAssetId) The current animation asset Id.
int SpriteBase::getAnimationFrame ( )
  • Gets current animation frame.
    Returns
    (int frame) The current animation frame
int SpriteBase::getAnimationFrame ( )
  • Gets current animation frame.
    Returns
    (int frame) The current animation frame
float SpriteBase::getAnimationTime ( )
  • Gets current animation time.
    Returns
    (float time) The current animation time
float SpriteBase::getAnimationTime ( )
  • Gets current animation time.
    Returns
    (float time) The current animation time
float SpriteBase::getAnimationTimeScale ( )
  • Get the animation time scale for this sprite.
    Returns
    (float) Returns the animation time scale for this sprite.
float SpriteBase::getAnimationTimeScale ( )
  • Get the animation time scale for this sprite.
    Returns
    (float) Returns the animation time scale for this sprite.
string SpriteBase::getImage ( )
  • Gets current image asset Id.
    Returns
    (string imageAssetId) The image being displayed
string SpriteBase::getImage ( )
  • Gets current image asset Id.
    Returns
    (string imageAssetId) The image being displayed
int SpriteBase::getImageFrame ( )
  • Gets the current image Frame.
    Returns
    The current image frame.
int SpriteBase::getImageFrame ( )
  • Gets the current image Frame.
    Returns
    The current image frame.
bool SpriteBase::getIsAnimationFinished ( )
  • Checks animation status.
    Returns
    (bool finished) Whether or not the animation is finished
bool SpriteBase::getIsAnimationFinished ( )
  • Checks animation status.
    Returns
    (bool finished) Whether or not the animation is finished
bool SpriteBase::isStaticFrameProvider ( )
  • Gets whether the sprite is in static or dynamic (animated)mode.
    Returns
    Returns whether the sprite is in static or dynamic (animated)mode.
bool SpriteBase::isStaticFrameProvider ( )
  • Gets whether the sprite is in static or dynamic (animated)mode.
    Returns
    Returns whether the sprite is in static or dynamic (animated)mode.
void SpriteBase::pauseAnimation ( bool  enable)
  • Pause the current animation
    Parameters
    enableIf true, pause the animation. If false, continue animating
void SpriteBase::pauseAnimation ( bool  enable)
  • Pause the current animation
    Parameters
    enableIf true, pause the animation. If false, continue animating
bool SpriteBase::playAnimation ( string  animationAssetId)
  • Plays an animation.
    Parameters
    animationAssetIdThe animation asset Id to play.
    Returns
    Returns true on success.
bool SpriteBase::playAnimation ( string  animationAssetId)
  • Plays an animation.
    Parameters
    animationAssetIdThe animation asset Id to play.
    Returns
    Returns true on success.
void SpriteBase::setAnimationFrame ( int  frame)
  • Sets the current animation frame.
    Parameters
    frameWhich frame of the animation to display
    Returns
    No return value.
void SpriteBase::setAnimationFrame ( int  frame)
  • Sets the current animation frame.
    Parameters
    frameWhich frame of the animation to display
    Returns
    No return value.
void SpriteBase::setAnimationTimeScale ( float  timeScale)
  • Change the rate of animation.
    Parameters
    timeScaleValue which will scale the frame animation speed. 1 by default.
void SpriteBase::setAnimationTimeScale ( float  timeScale)
  • Change the rate of animation.
    Parameters
    timeScaleValue which will scale the frame animation speed. 1 by default.
bool SpriteBase::setImage ( string  imageAssetId)
  • Sets the sprite image and optionally frame.
    Parameters
    imageAssetIdThe image asset Id to display
    frameThe frame of the image to display
    Returns
    Returns true on success.
bool SpriteBase::setImage ( string  imageAssetId)
  • Sets the sprite image and optionally frame.
    Parameters
    imageAssetIdThe image asset Id to display
    frameThe frame of the image to display
    Returns
    Returns true on success.
bool SpriteBase::setImageFrame ( frame  )
  • Sets the image frame.
    Parameters
    frameThe frame to display
    Returns
    Returns true on success.
bool SpriteBase::setImageFrame ( frame  )
  • Sets the image frame.
    Parameters
    frameThe frame to display
    Returns
    Returns true on success.
void SpriteBase::stopAnimation ( )
  • Stop the current animation
    Returns
    No return value.
void SpriteBase::stopAnimation ( )
  • Stop the current animation
    Returns
    No return value.

Member Data Documentation

bool SpriteBase::Active
float SpriteBase::AlphaTest
float SpriteBase::Angle
float SpriteBase::AngularDamping
float SpriteBase::AngularVelocity
animationAssetPtr SpriteBase::Animation
bool SpriteBase::Awake
ColorF SpriteBase::BlendColor
bool SpriteBase::BlendMode
enumval SpriteBase::BodyType
bool SpriteBase::Bullet
bool SpriteBase::canSaveDynamicFields
string SpriteBase::class

Script SuperClass of object.

bool SpriteBase::CollisionCallback
int SpriteBase::CollisionGroups
int SpriteBase::CollisionLayers
bool SpriteBase::CollisionSuppress
float SpriteBase::DefaultDensity
float SpriteBase::DefaultFriction
float SpriteBase::DefaultRestitution
enumval SpriteBase::DstBlendFactor
bool SpriteBase::Enabled
bool SpriteBase::FixedAngle
int SpriteBase::Frame
bool SpriteBase::GatherContacts
float SpriteBase::GravityScale
imageAssetPtr SpriteBase::Image
string SpriteBase::internalName
float SpriteBase::Lifetime
float SpriteBase::LinearDamping
Vector2 SpriteBase::LinearVelocity
SimObjectPtr SpriteBase::parentGroup

Group hierarchy parent of the object.

bool SpriteBase::PickingAllowed
Vector2 SpriteBase::Position
string SpriteBase::RenderGroup
SimObjectPtr SpriteBase::Scene
int SpriteBase::SceneGroup
int SpriteBase::SceneLayer
float SpriteBase::SceneLayerDepth
Vector2 SpriteBase::Size
bool SpriteBase::SleepingAllowed
bool SpriteBase::SleepingCallback
Vector2 SpriteBase::SortPoint
enumval SpriteBase::SrcBlendFactor
string SpriteBase::superclass

Script Class of object.

bool SpriteBase::UpdateCallback
bool SpriteBase::UseInputEvents
bool SpriteBase::Visible


Copyright © 2013 GarageGames, LLC. All Rights Reserved.