KX_IpoActuator.KX_IpoActuator

Module KX_IpoActuator :: Class KX_IpoActuator

Class KX_IpoActuator

SCA_ILogicBrick --+    
                  |    
      SCA_IActuator --+
                      |
                     KX_IpoActuator

IPO actuator activates an animation.

Method Summary
integer	`getEnd()` Returns the frame at which the IPO stops playing.
	`getForceIpoActsLocal()` Return whether to apply the force in the object's local coordinates rather than the world global coordinates.
boolean	`getIpoAsForce()` Returns whether to interpret the ipo as a force rather than a displacement.
integer	`getStart()` Returns the frame from which the IPO starts playing.
integer	`getType()` Returns the operation mode of the actuator.
	`set(mode, startframe, endframe, force)` Sets the properties of the actuator.
	`setEnd(endframe)` Sets the frame at which the IPO stops playing.
	`setForceIpoActsLocal(local)` Set whether to apply the force in the object's local coordinates rather than the world global coordinates.
	`setIpoAsForce(force)` Set whether to interpret the ipo as a force rather than a displacement.
	`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.
	`setType(mode)` Sets the operation mode of the actuator.
Inherited from SCA_ILogicBrick
integer	`getExecutePriority()` Gets the execution priority of this logic brick.
`KX_GameObject`	`getOwner()` Gets the game object associated with this logic brick.
	`setExecutePriority(priority)` Sets the priority of this logic brick.

Method Details

Returns the frame at which the IPO stops playing.

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

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

Returns the frame from which the IPO starts playing.

Returns the operation mode of the actuator.

Returns:: KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND
(type=integer)

Sets the properties of the actuator.

Parameters:: mode - "Play", "PingPong", "Flipper", "LoopStop", "LoopEnd" or "FromProp"
(type=string); startframe - first frame to use
(type=integer); endframe - last frame to use
(type=integer); force - interpret this ipo as a force
(type=boolean (KX_TRUE, KX_FALSE))

Sets the frame at which the IPO stops playing.

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

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

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

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

Sets the frame from which the IPO starts playing.

Sets the operation mode of the actuator.

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

Generated by Epydoc 2.1 on Fri Aug 27 21:08:03 2004