patch [#27885] bge.constraints documentation
[blender.git] / doc / python_api / rst / bge.constraints.rst
1
2 Game Engine bge.constraints Module
3 ==================================
4
5 .. note::
6    This documentation is still very weak, and needs some help!
7
8 .. function:: createConstraint([obj1, [obj2, [restLength, [restitution, [damping]]]]])
9
10    Creates a constraint.
11
12    :arg obj1: first object on Constraint
13    :type obj1: :class:'bge.types.KX_GameObject' #I think, there is no error when I use one
14
15    :arg obj2: second object on Constraint
16    :type obj2: :class:'bge.types.KX_GameObject' #too
17
18    :arg restLength: #to be filled
19    :type restLength: float
20
21    :arg restitution: #to be filled
22    :type restitution: float
23
24    :arg damping: #to be filled
25    :type damping: float
26
27 .. attribute:: error
28
29    Simbolic constant string that indicates error.
30
31 .. function:: exportBulletFile(filename)
32
33    export a .bullet file
34
35    :arg filename: File name
36    :type filename: string
37
38 .. function:: getAppliedImpulse(constraintId)
39
40    :arg constraintId: The id of the constraint.
41    :type constraintId: int
42
43    :return: the most recent applied impulse.
44    :rtype: float
45
46 .. function:: getVehicleConstraint(constraintId)
47
48    :arg constraintId: The id of the vehicle constraint.
49    :type constraintId: int
50
51    :return: a vehicle constraint object.
52    :rtype: :class:'KX_VehicleWrapper'
53
54 .. function:: removeConstraint(constraintId)
55
56    Removes a constraint.
57
58    :arg constraintId: The id of the constraint to be removed.
59    :type constraintId: int
60
61 .. function:: setCcdMode(ccdMode)
62
63    ..note::
64       Very experimental, not recommended
65
66    Sets the CCD mode in the Physics Environment.
67
68    :arg ccdMode: The new CCD mode.
69    :type ccdMode: int
70
71 .. function:: setContactBreakingTreshold(breakingTreshold)
72
73    .. note::
74       Reasonable default is 0.02 (if units are meters)
75
76    Sets the contact breaking treshold in the Physics Environment.
77
78    :arg breakingTreshold: The new contact breaking treshold.
79    :type breakingTreshold: float
80
81 .. function:: setDeactivationAngularTreshold(angularTreshold)
82
83    Sets the deactivation angular treshold.
84
85    :arg angularTreshold: New deactivation angular treshold.
86    :type angularTreshold: float
87
88 .. function:: setDeactivationLinearTreshold(linearTreshold)
89
90    Sets the deactivation linear treshold.
91
92    :arg linearTreshold: New deactivation linear treshold.
93    :type linearTreshold: float
94
95 .. function:: setDeactivationTime(time)
96
97    Sets the time after which a resting rigidbody gets deactived.
98
99    :arg time: The deactivation time.
100    :type time: float
101
102 .. function:: setDebugMode(mode)
103
104    Sets the debug mode.
105
106    Debug modes:
107       - No debug: 0
108       - Draw wireframe: 1
109       - Draw Aabb: 2 #What's Aabb?
110       - Draw freatures text: 4
111       - Draw contact points: 8
112       - No deactivation: 16
113       - No help text: 32
114       - Draw text: 64
115       - Profile timings: 128
116       - Enable sat comparision: 256
117       - Disable Bullet LCP: 512
118       - Enable CCD: 1024
119       - Draw Constraints: #(1 << 11) = ?
120       - Draw Constraint Limits: #(1 << 12) = ?
121       - Fast Wireframe: #(1 << 13) = ?
122
123    :arg mode: The new debug mode.
124    :type mode: int
125
126 .. function:: setGravity(x, y, z)
127
128    Sets the gravity force.
129
130    :arg x: Gravity X force.
131    :type x: float
132
133    :arg y: Gravity Y force.
134    :type y: float
135
136    :arg z: Gravity Z force.
137    :type z: float
138
139 .. function:: setLinearAirDamping(damping)
140
141    Not implemented.
142
143 .. function:: setNumIterations(numiter)
144
145    Sets the number of iterations for an iterative constraint solver.
146
147    :arg numiter: New number of iterations.
148    :type numiter: int
149
150 .. function:: setNumTimeSubSteps(numsubstep)
151
152    Sets the number of substeps for each physics proceed. Tradeoff quality for performance.
153
154    :arg numsubstep: New number of substeps.
155    :type numsubstep: int
156
157 .. function:: setSolverDamping(damping)
158
159    ..note::
160       Very experimental, not recommended
161
162    Sets the solver damping.
163
164    :arg damping: New damping for the solver.
165    :type damping: float
166
167 .. function:: setSolverTau(tau)
168
169    .. note::
170       Very experimental, not recommended
171
172    Sets the solver tau.
173
174    :arg tau: New tau for the solver.
175    :type tau: float
176
177 .. function:: setSolverType(solverType)
178
179    .. note::
180       Very experimental, not recommended
181
182    Sets the solver type.
183
184    :arg solverType: The new type of the solver.
185    :type solverType: int
186
187 .. function:: setSorConstant(sor)
188
189    .. note::
190       Very experimental, not recommended
191
192    Sets the sor constant.
193
194    :arg sor: New sor value.
195    :type sor: float
196
197 .. function:: setUseEpa(epa)
198
199    Not implemented.