blob: 6ffc55a5854067faf6a9c52b41a654bba0e6d66f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
# $Id$
# Documentation for KX_CameraActuator
from SCA_IActuator import *
class KX_CameraActuator(SCA_IActuator):
"""
Applies changes to a camera.
@ivar min: minimum distance to the target object maintained by the actuator
@type min: float
@ivar max: maximum distance to stay from the target object
@type max: float
@ivar height: height to stay above the target object
@type height: float
@ivar xy: axis this actuator is tracking, true=X, false=Y
@type xy: boolean
@ivar object: the object this actuator tracks.
@type object: KX_GameObject or None
@author: snail
"""
def getObject(name_only = 1):
"""
Returns the name of the object this actuator tracks.
@type name_only: bool
@param name_only: optional argument, when 0 return a KX_GameObject
@rtype: string, KX_GameObject or None if no object is set
"""
def setObject(target):
"""
Sets the object this actuator tracks.
@param target: the object to track.
@type target: L{KX_GameObject}, string or None
"""
def getMin():
"""
Returns the minimum distance to target maintained by the actuator.
@rtype: float
"""
def setMin(distance):
"""
Sets the minimum distance to the target object maintained by the
actuator.
@param distance: The minimum distance to maintain.
@type distance: float
"""
def getMax():
"""
Gets the maximum distance to stay from the target object.
@rtype: float
"""
def setMax(distance):
"""
Sets the maximum distance to stay from the target object.
@param distance: The maximum distance to maintain.
@type distance: float
"""
def getHeight():
"""
Returns the height to stay above the target object.
@rtype: float
"""
def setHeight(height):
"""
Sets the height to stay above the target object.
@type height: float
@param height: The height to stay above the target object.
"""
def setXY(xaxis):
"""
Sets the axis to get behind.
@param xaxis: False to track Y axis, True to track X axis.
@type xaxis: boolean
"""
def getXY():
"""
Returns the axis this actuator is tracking.
@return: True if tracking X axis, False if tracking Y axis.
@rtype: boolean
"""
|
