diff options
Diffstat (limited to 'source/gameengine/PyDoc/KX_VehicleWrapper.py')
| -rw-r--r-- | source/gameengine/PyDoc/KX_VehicleWrapper.py | 174 |
1 files changed, 83 insertions, 91 deletions
diff --git a/source/gameengine/PyDoc/KX_VehicleWrapper.py b/source/gameengine/PyDoc/KX_VehicleWrapper.py index 3d91b7db676..86991634f2d 100644 --- a/source/gameengine/PyDoc/KX_VehicleWrapper.py +++ b/source/gameengine/PyDoc/KX_VehicleWrapper.py @@ -4,13 +4,13 @@ class KX_VehicleWrapper(PyObjectPlus): """ KX_VehicleWrapper - All placeholders have a __ prefix + TODO - description """ def addWheel(wheel, attachPos, attachDir, axleDir, suspensionRestLength, wheelRadius, hasSteering): """ - TODO - Description + Add a wheel to the vehicle @param wheel: The object to use as a wheel. @type wheel: L{KX_GameObject<KX_GameObject.KX_GameObject>} or a KX_GameObject name @@ -26,143 +26,135 @@ class KX_VehicleWrapper(PyObjectPlus): @type wheelRadius: float """ - def __applyBraking(val): + def applyBraking(force, wheelIndex): """ - TODO - Description + Apply a braking force to the specified wheel - @param val: the starting frame of the animation - @type val: float + @param force: the brake force + @type force: float - @rtype: integer - @return: TODO Description + @param wheelIndex: index of the wheel where the force needs to be applied + @type wheelIndex: integer """ - def __applyEngineForce(val): + def applyEngineForce(force, wheelIndex): """ - TODO - Description + Apply an engine force to the specified wheel - @param val: the starting frame of the animation - @type val: float + @param force: the engine force + @type force: float - @rtype: integer - @return: TODO Description + @param wheelIndex: index of the wheel where the force needs to be applied + @type wheelIndex: integer """ - def __getConstraintId(val): + def getConstraintId(): """ - TODO - Description - - @param val: the starting frame of the animation - @type val: float + Get the constraint ID @rtype: integer - @return: TODO Description + @return: the constraint id """ - def __getConstraintType(val): + def getConstraintType(): """ - TODO - Description - - @param val: the starting frame of the animation - @type val: float + Returns the constraint type. @rtype: integer - @return: TODO Description + @return: constraint type """ - def __getNumWheels(val): + def getNumWheels(): """ - TODO - Description - - @param val: the starting frame of the animation - @type val: float + Returns the number of wheels. @rtype: integer - @return: TODO Description + @return: the number of wheels for this vehicle """ - def __getWheelOrientationQuaternion(val): + def getWheelOrientationQuaternion(wheelIndex): """ - TODO - Description + Returns the wheel orientation as a quaternion. - @param val: the starting frame of the animation - @type val: float + @param wheelIndex: the wheel index + @type wheelIndex: integer - @rtype: integer + @rtype: TODO - type should be quat as per method name but from the code it looks like a matrix @return: TODO Description """ - def __getWheelPosition(val): + def getWheelPosition(wheelIndex): """ - TODO - Description + Returns the position of the specified wheel - @param val: the starting frame of the animation - @type val: float + @param wheelIndex: the wheel index + @type wheelIndex: integer - @rtype: integer - @return: TODO Description + @rtype: list[x, y, z] + @return: position vector """ - def __getWheelRotation(val): + def getWheelRotation(wheelIndex): """ - TODO - Description + Returns the rotation of the specified wheel - @param val: the starting frame of the animation - @type val: float + @param wheelIndex: the wheel index + @type wheelIndex: integer - @rtype: integer - @return: TODO Description + @rtype: float + @return: the wheel rotation """ - def __setRollInfluence(val): + def setRollInfluence(rollInfluece, wheelIndex): """ - TODO - Description + Set the specified wheel's roll influence. + The higher the roll influence the more the vehicle will tend to roll over in corners. - @param val: the starting frame of the animation - @type val: float - - @rtype: integer - @return: TODO Description + @param rollInfluece: the wheel roll influence + @type rollInfluece: float + + @param wheelIndex: the wheel index + @type wheelIndex: integer """ - def __setSteeringValue(val): + def setSteeringValue(steering, wheelIndex): """ - TODO - Description - - @param val: the starting frame of the animation - @type val: float + Set the specified wheel's steering - @rtype: integer - @return: TODO Description + @param steering: the wheel steering + @type steering: float + + @param wheelIndex: the wheel index + @type wheelIndex: integer """ - def __setSuspensionCompression(val): + def setSuspensionCompression(compression, wheelIndex): """ - TODO - Description + Set the specified wheel's compression - @param val: the starting frame of the animation - @type val: float - - @rtype: integer - @return: TODO Description + @param compression: the wheel compression + @type compression: float + + @param wheelIndex: the wheel index + @type wheelIndex: integer """ - def __setSuspensionDamping(val): + def setSuspensionDamping(damping, wheelIndex): """ - TODO - Description - - @param val: the starting frame of the animation - @type val: float + Set the specified wheel's damping - @rtype: integer - @return: TODO Description + @param damping: the wheel damping + @type damping: float + + @param wheelIndex: the wheel index + @type wheelIndex: integer """ - def __setSuspensionStiffness(val): + def setSuspensionStiffness(stiffness, wheelIndex): """ - TODO - Description - - @param val: the starting frame of the animation - @type val: float + Set the specified wheel's stiffness - @rtype: integer - @return: TODO Description + @param stiffness: the wheel stiffness + @type stiffness: float + + @param wheelIndex: the wheel index + @type wheelIndex: integer """ - def __setTyreFriction(val): + def setTyreFriction(friction, wheelIndex): """ - TODO - Description + Set the specified wheel's tyre friction - @param val: the starting frame of the animation - @type val: float - - @rtype: integer - @return: TODO Description + @param friction: the tyre friction + @type friction: float + + @param wheelIndex: the wheel index + @type wheelIndex: integer """ |