blender/source/gameengine/PyDoc/KX_VehicleWrapper.py
Campbell Barton eee8dd9086 - Updated BGE docs to match the game engines class inheritance more closely.
- Grouped deprecated functions for KX_Camera, KX_GameObject, SCA_ISensor, SCA_ILogicBrick, KX_Scene
2009-04-28 13:02:49 +00:00

169 lines
3.4 KiB
Python

from PyObjectPlus import *
class KX_VehicleWrapper(PyObjectPlus):
"""
KX_VehicleWrapper
All placeholders have a __ prefix
"""
def addWheel(wheel, attachPos, attachDir, axleDir, suspensionRestLength, wheelRadius, hasSteering):
"""
TODO - Description
@param wheel: The object to use as a wheel.
@type wheel: L{KX_GameObject<KX_GameObject.KX_GameObject>} or a KX_GameObject name
@param attachPos: The position that this wheel will attach to.
@type attachPos: vector of 3 floats
@param attachDir: The direction this wheel points.
@type attachDir: vector of 3 floats
@param axleDir: The direction of this wheels axle.
@type axleDir: vector of 3 floats
@param suspensionRestLength: TODO - Description
@type suspensionRestLength: float
@param wheelRadius: The size of the wheel.
@type wheelRadius: float
"""
def __applyBraking(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __applyEngineForce(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __getConstraintId(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __getConstraintType(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __getNumWheels(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __getWheelOrientationQuaternion(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __getWheelPosition(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __getWheelRotation(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __setRollInfluence(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __setSteeringValue(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __setSuspensionCompression(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __setSuspensionDamping(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __setSuspensionStiffness(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __setTyreFriction(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""