diff options
| author | Ines Almeida <britalmeida@gmail.com> | 2015-02-09 17:45:29 +0300 |
|---|---|---|
| committer | Ines Almeida <britalmeida@gmail.com> | 2015-02-09 23:58:15 +0300 |
| commit | 4edc1bbe0277620aa9f272d98ea8d4f3642ce2ec (patch) | |
| tree | 22d5692ad79f4fdf9b3cb53b5574789f1eaefcbd /doc | |
| parent | a088b9488d1be7388ddff34c0708616643900940 (diff) | |
BGE - Vehicle Controller - add background and API checks for arguments of function calls
Fixes T41570 crash
For readability, attachDir was renamed to downDir and the Python API docs renamed accordingly
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/python_api/rst/bge_types/bge.types.KX_VehicleWrapper.rst | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/doc/python_api/rst/bge_types/bge.types.KX_VehicleWrapper.rst b/doc/python_api/rst/bge_types/bge.types.KX_VehicleWrapper.rst index 9340d33f8a9..631075363ca 100644 --- a/doc/python_api/rst/bge_types/bge.types.KX_VehicleWrapper.rst +++ b/doc/python_api/rst/bge_types/bge.types.KX_VehicleWrapper.rst @@ -11,22 +11,25 @@ base class --- :class:`PyObjectPlus` TODO - description - .. method:: addWheel(wheel, attachPos, attachDir, axleDir, suspensionRestLength, wheelRadius, hasSteering) + .. method:: addWheel(wheel, attachPos, downDir, axleDir, suspensionRestLength, wheelRadius, hasSteering) Add a wheel to the vehicle :arg wheel: The object to use as a wheel. - :type wheel: :class:`KX_GameObject` or a KX_GameObject name - :arg attachPos: The position that this wheel will attach to. + :type wheel: :class:`KX_GameObject` or a :class:`KX_GameObject` name + :arg attachPos: The position to attach the wheel, relative to the chassis object center. :type attachPos: vector of 3 floats - :arg attachDir: The direction this wheel points. - :type attachDir: vector of 3 floats - :arg axleDir: The direction of this wheels axle. + :arg downDir: The direction vector pointing down to where the vehicle should collide with the floor. + :type downDir: vector of 3 floats + :arg axleDir: The axis the wheel rotates around, relative to the chassis. :type axleDir: vector of 3 floats - :arg suspensionRestLength: TODO - Description + :arg suspensionRestLength: The length of the suspension when no forces are being applied. :type suspensionRestLength: float - :arg wheelRadius: The size of the wheel. + :arg wheelRadius: The radius of the wheel (half the diameter). :type wheelRadius: float + :arg hasSteering: True if the wheel should turn with steering, typically used in front wheels. + :type hasSteering: boolean + .. method:: applyBraking(force, wheelIndex) @@ -38,6 +41,7 @@ base class --- :class:`PyObjectPlus` :arg wheelIndex: index of the wheel where the force needs to be applied :type wheelIndex: integer + .. method:: applyEngineForce(force, wheelIndex) Apply an engine force to the specified wheel @@ -48,6 +52,7 @@ base class --- :class:`PyObjectPlus` :arg wheelIndex: index of the wheel where the force needs to be applied :type wheelIndex: integer + .. method:: getConstraintId() Get the constraint ID |