Module KX_TrackToActuator :: Class KX_TrackToActuator
[frames | no frames]

Class KX_TrackToActuator

SCA_ILogicBrick --+    
                  |    
      SCA_IActuator --+
                      |
                     KX_TrackToActuator


Edit Object actuator in Track To mode.

Warning:

Track To Actuators will be ignored if at game start, the object to track to is invalid.

This will generate a warning in the console:

ERROR: GameObject OBName no object in EditObjectActuator ActuatorName

Method Summary
string getObject()
Returns the name of the object to track.
integer getTime()
Returns the time in frames with which the tracking motion is delayed.
boolean getUse3D()
Returns True if the tracking motion will track in the z direction.
  setObject(object)
Sets the object to track.
  setTime(time)
Sets the time in frames with which to delay the tracking motion.
  setUse3D(use3d)
Sets the tracking motion to use 3D.
    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

getObject()

Returns the name of the object to track.

Returns None if no object has been set to track.
Returns:
string

getTime()

Returns the time in frames with which the tracking motion is delayed.
Returns:
integer

getUse3D()

Returns True if the tracking motion will track in the z direction.
Returns:
boolean

setObject(object)

Sets the object to track.
Parameters:
object - Either a reference to a game object or the name of the object to track.
           (type=KX_GameObject or string)

setTime(time)

Sets the time in frames with which to delay the tracking motion.
Parameters:
time
           (type=integer)

setUse3D(use3d)

Sets the tracking motion to use 3D.
Parameters:
use3d - - True: allow the tracking motion to extend in the z-direction.
  • False: lock the tracking motion to the x-y plane.

           (type=boolean)

Generated by Epydoc 2.1 on Thu Feb 1 00:12:33 2007 http://epydoc.sf.net