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.

source code

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

source code

setStart(startframe)
Sets the frame from which the IPO starts playing.

source code

integer

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

source code

setEnd(endframe)
Sets the frame at which the IPO stops playing.

source code

integer

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

source code

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

source code

boolean

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

source code

setType(mode)
Sets the operation mode of the actuator.

source code

integer

getType()
Returns the operation mode of the actuator.

source code

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

source code

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

source code

Inherited from SCA_ILogicBrick.SCA_ILogicBrick: getExecutePriority, getOwner, setExecutePriority

Method Details

set(mode, startframe, endframe, force)

source code

Sets the properties of the actuator.

Parameters:

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