- fixed errors with bge epydocs
[blender.git] / source / gameengine / PyDoc / KX_TrackToActuator.py
1 # $Id$
2 # Documentation for KX_TrackToActuator
3 from SCA_IActuator import *
4
5 class KX_TrackToActuator(SCA_IActuator):
6         """
7         Edit Object actuator in Track To mode.
8         
9         @warning: Track To Actuators will be ignored if at game start, the
10                 object to track to is invalid.
11                 
12                 This will generate a warning in the console:
13                 
14                 C{ERROR: GameObject I{OBName} no object in EditObjectActuator I{ActuatorName}}
15
16         @ivar object: the object this actuator tracks.
17         @type object: KX_GameObject or None
18         @ivar time: the time in frames with which to delay the tracking motion
19         @type time: integer
20         @ivar use3D: the tracking motion to use 3D
21         @type use3D: boolean
22         
23         """
24         def setObject(object):
25                 """
26                 DEPRECATED: Use the object property.
27                 Sets the object to track.
28                 
29                 @type object: L{KX_GameObject}, string or None
30                 @param object: Either a reference to a game object or the name of the object to track.
31                 """
32         def getObject(name_only):
33                 """
34                 DEPRECATED: Use the object property.
35                 Returns the name of the object to track.
36                 
37                 @type name_only: bool
38                 @param name_only: optional argument, when 0 return a KX_GameObject
39                 @rtype: string, KX_GameObject or None if no object is set
40                 """
41         def setTime(time):
42                 """
43                 DEPRECATED: Use the time property.
44                 Sets the time in frames with which to delay the tracking motion.
45                 
46                 @type time: integer
47                 """
48         def getTime():
49                 """
50                 DEPRECATED: Use the time property.
51                 Returns the time in frames with which the tracking motion is delayed.
52                 
53                 @rtype: integer
54                 """
55         def setUse3D(use3d):
56                 """
57                 DEPRECATED: Use the use3D property.
58                 Sets the tracking motion to use 3D.
59                 
60                 @type use3d: boolean
61                 @param use3d: - True: allow the tracking motion to extend in the z-direction.
62                               - False: lock the tracking motion to the x-y plane.
63                 """
64         def getUse3D():
65                 """
66                 DEPRECATED: Use the use3D property.
67                 Returns True if the tracking motion will track in the z direction.
68                 
69                 @rtype: boolean
70                 """