Trees       Indices       Help   
Module KX_IpoActuator :: Class KX_IpoActuator
[hide private]
[frames] | no frames]

Class KX_IpoActuator

source code

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

IPO actuator activates an animation.

Instance Methods [hide private]
 
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.SCA_ILogicBrick: getExecutePriority, getOwner, setExecutePriority

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

setProperty(property)

source code 

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

Parameters:
  • property (string)

setStart(startframe)

source code 

Sets the frame from which the IPO starts playing.

Parameters:
  • startframe (integer)

setEnd(endframe)

source code 

Sets the frame at which the IPO stops playing.

Parameters:
  • endframe (integer)

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

setIpoAdd(add)

source code 

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

Parameters:
  • add (boolean) - KX_TRUE or KX_FALSE

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

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

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)

   Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri Oct 24 10:23:57 2008 http://epydoc.sourceforge.net