blender/source/gameengine/PyDoc/KX_TrackToActuator.py
Kester Maddock fd5f3e13d2 Convert and use actuators with no target object set.
Certain actuators (Add Object/Replace Mesh/Scene/Track To) used to always require a target, or they would not influence the scene.  If the actuator target is always set from Python, this could be annoying.
2004-09-19 01:33:08 +00:00

58 lines
1.3 KiB
Python

# $Id$
# Documentation for KX_TrackToActuator
from SCA_IActuator import *
class KX_TrackToActuator(SCA_IActuator):
"""
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:
C{ERROR: GameObject I{OBName} no object in EditObjectActuator I{ActuatorName}}
"""
def setObject(object):
"""
Sets the object to track.
@type object: L{KX_GameObject} or string
@param object: Either a reference to a game object or the name of the object to track.
"""
def getObject():
"""
Returns the name of the object to track.
Returns None if no object has been set to track.
@rtype: string
"""
def setTime(time):
"""
Sets the time in frames with which to delay the tracking motion.
@type time: integer
"""
def getTime():
"""
Returns the time in frames with which the tracking motion is delayed.
@rtype: integer
"""
def setUse3D(use3d):
"""
Sets the tracking motion to use 3D.
@type use3d: boolean
@param use3d: - True: allow the tracking motion to extend in the z-direction.
- False: lock the tracking motion to the x-y plane.
"""
def getUse3D():
"""
Returns True if the tracking motion will track in the z direction.
@rtype: boolean
"""