Pydoc: Fix multiple bpy.type modules
[blender.git] / doc / python_api / rst / bge_types / bge.types.KX_VehicleWrapper.rst
1 KX_VehicleWrapper(PyObjectPlus)
2 ===============================
3
4 base class --- :class:`PyObjectPlus`
5
6 .. class:: KX_VehicleWrapper(PyObjectPlus)
7
8    KX_VehicleWrapper
9
10    TODO - description
11
12    .. method:: addWheel(wheel, attachPos, downDir, axleDir, suspensionRestLength, wheelRadius, hasSteering)
13
14       Add a wheel to the vehicle
15
16       :arg wheel: The object to use as a wheel.
17       :type wheel: :class:`KX_GameObject` or a :class:`KX_GameObject` name
18       :arg attachPos: The position to attach the wheel, relative to the chassis object center.
19       :type attachPos: vector of 3 floats
20       :arg downDir: The direction vector pointing down to where the vehicle should collide with the floor.
21       :type downDir: vector of 3 floats
22       :arg axleDir: The axis the wheel rotates around, relative to the chassis.
23       :type axleDir: vector of 3 floats
24       :arg suspensionRestLength: The length of the suspension when no forces are being applied.
25       :type suspensionRestLength: float
26       :arg wheelRadius: The radius of the wheel (half the diameter).
27       :type wheelRadius: float
28       :arg hasSteering: True if the wheel should turn with steering, typically used in front wheels.
29       :type hasSteering: boolean
30
31
32    .. method:: applyBraking(force, wheelIndex)
33
34       Apply a braking force to the specified wheel
35
36       :arg force: the brake force
37       :type force: float
38
39       :arg wheelIndex: index of the wheel where the force needs to be applied
40       :type wheelIndex: integer
41
42
43    .. method:: applyEngineForce(force, wheelIndex)
44
45       Apply an engine force to the specified wheel
46
47       :arg force: the engine force
48       :type force: float
49
50       :arg wheelIndex: index of the wheel where the force needs to be applied
51       :type wheelIndex: integer
52
53
54    .. method:: getConstraintId()
55
56       Get the constraint ID
57
58       :return: the constraint id
59       :rtype: integer
60
61    .. method:: getConstraintType()
62
63       Returns the constraint type.
64
65       :return: constraint type
66       :rtype: integer
67
68    .. method:: getNumWheels()
69
70       Returns the number of wheels.
71
72       :return: the number of wheels for this vehicle
73       :rtype: integer
74
75    .. method:: getWheelOrientationQuaternion(wheelIndex)
76
77       Returns the wheel orientation as a quaternion.
78
79       :arg wheelIndex: the wheel index
80       :type wheelIndex: integer
81
82       :return: TODO Description
83       :rtype: TODO - type should be quat as per method name but from the code it looks like a matrix
84
85    .. method:: getWheelPosition(wheelIndex)
86
87       Returns the position of the specified wheel
88
89       :arg wheelIndex: the wheel index
90       :type wheelIndex: integer
91       :return: position vector
92       :rtype: list[x, y, z]
93
94    .. method:: getWheelRotation(wheelIndex)
95
96       Returns the rotation of the specified wheel
97
98       :arg wheelIndex: the wheel index
99       :type wheelIndex: integer
100
101       :return: the wheel rotation
102       :rtype: float
103
104    .. method:: setRollInfluence(rollInfluece, wheelIndex)
105
106       Set the specified wheel's roll influence.
107       The higher the roll influence the more the vehicle will tend to roll over in corners.
108
109       :arg rollInfluece: the wheel roll influence
110       :type rollInfluece: float
111
112       :arg wheelIndex: the wheel index
113       :type wheelIndex: integer
114
115    .. method:: setSteeringValue(steering, wheelIndex)
116
117       Set the specified wheel's steering
118
119       :arg steering: the wheel steering
120       :type steering: float
121
122       :arg wheelIndex: the wheel index
123       :type wheelIndex: integer
124
125    .. method:: setSuspensionCompression(compression, wheelIndex)
126
127       Set the specified wheel's compression
128
129       :arg compression: the wheel compression
130       :type compression: float
131
132       :arg wheelIndex: the wheel index
133       :type wheelIndex: integer
134
135    .. method:: setSuspensionDamping(damping, wheelIndex)
136
137       Set the specified wheel's damping
138
139       :arg damping: the wheel damping
140       :type damping: float
141
142       :arg wheelIndex: the wheel index
143       :type wheelIndex: integer
144
145    .. method:: setSuspensionStiffness(stiffness, wheelIndex)
146
147       Set the specified wheel's stiffness
148
149       :arg stiffness: the wheel stiffness
150       :type stiffness: float
151
152       :arg wheelIndex: the wheel index
153       :type wheelIndex: integer
154
155    .. method:: setTyreFriction(friction, wheelIndex)
156
157       Set the specified wheel's tyre friction
158
159       :arg friction: the tyre friction
160       :type friction: float
161
162       :arg wheelIndex: the wheel index
163       :type wheelIndex: integer