Module GameTypes :: Class KX_IpoActuator

Class KX_IpoActuator

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
           SCA_IActuator --+
                           |
                          KX_IpoActuator

IPO actuator activates an animation.

Instance Methods

bool

isA(game_type)
Check if this is a type or a subtype game_type. (Inherited from GameTypes.PyObjectPlus)

Deprecated

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 GameTypes.SCA_ILogicBrick)

string

getName()
Returns the name of the CValue. (Inherited from GameTypes.CValue)

KX_GameObject

getOwner()
Gets the game object associated with this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

Instance Variables
int	executePriority This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from GameTypes.SCA_ILogicBrick)
float	frameEnd End frame.
string	framePropName Assign this property this action current frame number
float	frameStart Start frame.
bool	invalid Test if the object has been freed by the game engine and is no longer valid. (Inherited from GameTypes.PyObjectPlus)
int	mode Play mode for the ipo.
string	name The name of this CValue derived object (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
KX_GameObject or None in exceptional cases.	owner The game object this logic brick is attached to (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
string	propName Use this property to define the Ipo position
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.

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

Deprecated: use other attributes.

setProperty(property)

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

Parameters:

property (string)

Deprecated: use propName

setStart(startframe)

Sets the frame from which the IPO starts playing.

Parameters:

startframe (integer)

Deprecated: use frameStart

getStart()

Returns the frame from which the IPO starts playing.

Returns: integer

Deprecated: use frameStart

setEnd(endframe)

Sets the frame at which the IPO stops playing.

Parameters:

endframe (integer)

Deprecated: use frameEnd

getEnd()

Returns the frame at which the IPO stops playing.

Returns: integer

Deprecated: use frameEnd

setIpoAsForce(force)

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

Parameters:

force (boolean) - KX_TRUE or KX_FALSE

Deprecated: use useIpoAsForce

getIpoAsForce()

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

Returns: boolean

Deprecated: use useIpoAsForce

setIpoAdd(add)

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

Parameters:

add (boolean) - KX_TRUE or KX_FALSE

Deprecated: use useIpoAdd

getIpoAdd()

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

Returns: boolean

Deprecated: use useIpoAdd

setType(mode)

Sets the operation mode of the actuator.

Parameters:

mode (string) - KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND

Deprecated: use type

getType()

Returns the operation mode of the actuator.

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

Deprecated: use type

setForceIpoActsLocal(local)

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

Parameters:

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

Deprecated: use useIpoLocal

getForceIpoActsLocal()

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

Deprecated: use useIpoLocal

Instance Variable Details

mode

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