Module GameTypes :: Class KX_IpoActuator

Class KX_IpoActuator

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

IPO actuator activates an animation.

Instance Methods

[hide private]

Deprecated

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

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

source code

boolean

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

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

integer

getExecutePriority()
Gets the execution priority of this logic brick.

source code

KX_GameObject

getOwner()
Gets the game object associated with this logic brick.

source code

setExecutePriority(priority)
Sets the priority of this logic brick.

source code

Inherited from CValue

string

getName()
Returns the name of the CValue.

source code

Inherited from PyObjectPlus

bool

isA(game_type)
Check if this is a type or a subtype game_type.

source code

Instance Variables

[hide private]

float

frameEnd
End frame.

string

framePropName
Assign this property this action current frame number

float

frameStart
Start frame.

int

mode
Play mode for the ipo.

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.

Inherited from SCA_ILogicBrick

int

executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).

string

name
The name of this CValue derived object (read-only).

KX_GameObject or None in exceptional cases.

owner
The game object this logic brick is attached to (read-only).

Inherited from PyObjectPlus

bool

invalid
Test if the object has been freed by the game engine and is no longer valid.

Method Details

[hide private]

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 (integer (0=normal, 1=interpret location as force, 2=additive)) - special mode

Deprecated: use other attributes.

setProperty(property)

source code

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

Deprecated: use propName

setStart(startframe)

source code

Sets the frame from which the IPO starts playing.

Deprecated: use frameStart

getStart()

source code

Returns the frame from which the IPO starts playing.

Returns: integer

Deprecated: use frameStart

setEnd(endframe)

source code

Sets the frame at which the IPO stops playing.

Deprecated: use frameEnd

getEnd()

source code

Returns the frame at which the IPO stops playing.

Returns: integer

Deprecated: use frameEnd

setIpoAsForce(force)

source code

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()

source code

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

Returns: boolean

Deprecated: use useIpoAsForce

setIpoAdd(add)

source code

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

Parameters:

add (boolean) - KX_TRUE or KX_FALSE

Deprecated: use useIpoAdd

getIpoAdd()

source code

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

Returns: boolean

Deprecated: use useIpoAdd

setType(mode)

source code

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()

source code

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)

source code

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()

source code

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

Deprecated: use useIpoLocal

Instance Variable Details

[hide private]

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