Module KX_IpoActuator :: Class KX_IpoActuator

Class KX_IpoActuator

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
        SCA_IActuator.SCA_IActuator --+
                                      |
                                     KX_IpoActuator

IPO actuator activates an animation.

Instance Methods
 
set(mode, startframe, endframe, force)
Sets the properties of the actuator.
 
setProperty(property)
Sets the name of the property to be used in FromProp mode.
 
setStart(startframe)
Sets the frame from which the IPO starts playing.
integer
getStart()
Returns the frame from which the IPO starts playing.
 
setEnd(endframe)
Sets the frame at which the IPO stops playing.
integer
getEnd()
Returns the frame at which the IPO stops playing.
 
setIpoAsForce(force)
Set whether to interpret the ipo as a force rather than a displacement.
boolean
getIpoAsForce()
Returns whether to interpret the ipo as a force rather than a displacement.
 
setIpoAdd(add)
Set whether to interpret the ipo as additive rather than absolute.
boolean
getIpoAdd()
Returns whether to interpret the ipo as additive rather than absolute.
 
setType(mode)
Sets the operation mode of the actuator.
integer
getType()
Returns the operation mode of the actuator.
 
setForceIpoActsLocal(local)
Set whether to apply the force in the object's local coordinates rather than the world global coordinates.
 
getForceIpoActsLocal()
Return whether to apply the force in the object's local coordinates rather than the world global coordinates.
integer
getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
KX_GameObject
getOwner()
Gets the game object associated with this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
Instance Variables
float endFrame
End frame.
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
string framePropName
Assign this property this action current frame number
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read only). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
string propName
Use this property to define the Ipo position
float startFrame
Start frame.
int type
Play mode for the ipo.
bool useChildren
Update IPO on all children Objects as well
bool useIpoAdd
Ipo is added to the current loc/rot/scale in global or local coordinate according to Local flag
bool useIpoAsForce
Apply Ipo as a global or local force depending on the local option (dynamic objects only)
bool useIpoLocal
Let the ipo acts in local coordinates, used in Force and Add mode.
Method Details

set(mode, startframe, endframe, force)

 

Sets the properties of the actuator. (deprecated)

Parameters:
  • mode (string) - "Play", "PingPong", "Flipper", "LoopStop", "LoopEnd" or "FromProp"
  • startframe (integer) - first frame to use
  • endframe (integer) - last frame to use
  • force (integer (0=normal, 1=interpret location as force, 2=additive)) - special mode

setProperty(property)

 

Sets the name of the property to be used in FromProp mode. (deprecated)

Parameters:
  • property (string)

setStart(startframe)

 

Sets the frame from which the IPO starts playing. (deprecated)

Parameters:
  • startframe (integer)

getStart()

 

Returns the frame from which the IPO starts playing. (deprecated)

Returns: integer

setEnd(endframe)

 

Sets the frame at which the IPO stops playing. (deprecated)

Parameters:
  • endframe (integer)

getEnd()

 

Returns the frame at which the IPO stops playing. (deprecated)

Returns: integer

setIpoAsForce(force)

 

Set whether to interpret the ipo as a force rather than a displacement. (deprecated)

Parameters:
  • force (boolean) - KX_TRUE or KX_FALSE

getIpoAsForce()

 

Returns whether to interpret the ipo as a force rather than a displacement. (deprecated)

Returns: boolean

setIpoAdd(add)

 

Set whether to interpret the ipo as additive rather than absolute. (deprecated)

Parameters:
  • add (boolean) - KX_TRUE or KX_FALSE

getIpoAdd()

 

Returns whether to interpret the ipo as additive rather than absolute. (deprecated)

Returns: boolean

setType(mode)

 

Sets the operation mode of the actuator. (deprecated)

Parameters:
  • mode (string) - KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND

getType()

 

Returns the operation mode of the actuator. (deprecated)

Returns: integer
KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND

setForceIpoActsLocal(local)

 

Set whether to apply the force in the object's local coordinates rather than the world global coordinates. (deprecated)

Parameters:
  • local (boolean) - Apply the ipo-as-force in the object's local coordinates? (KX_TRUE, KX_FALSE)

getForceIpoActsLocal()

 

Return whether to apply the force in the object's local coordinates rather than the world global coordinates. (deprecated)


Instance Variable Details

type

Play mode for the ipo. (In GameLogic.KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND, KX_IPOACT_FROM_PROP)
Type:
int