This repository has been archived on 2023-10-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
blender-archive/source/gameengine/PyDoc/KX_PhysicsObjectWrapper.py
Campbell Barton e847bcf784 BGE Doc updates thanks to Roelf de Kock
--- Notes from Roelf, maybe some other BGE devs could help resolve these
Here is what I have so far. I've left "TODO's" were there needs to be some more comments.

The following things also need to be resolved:

-KX_VehicleWrapper.getWheelOrientationQuaternion looks like it should return a quaternion but if I look at the code it looks like it returns a rotation matrix.

-I still need to find out what exactly KX_VehicleWrapper.getWheelRotation is. I've got the return type but I would like to add some explanation for what it actualy means (and units if any).

-BL_Shader.setNumberOfPasses ignores the parameter but from the comment in the code it looks like the parameter that is being set (it is harcoded to be =1) in setNumberOfPasses is not used. So I'm not sure if this method should be documented at all.
2009-05-11 21:35:38 +00:00

61 lines
1.1 KiB
Python

from PyObjectPlus import *
class KX_PhysicsObjectWrapper(PyObjectPlus):
"""
KX_PhysicsObjectWrapper
"""
def setActive(active):
"""
Set the object to be active.
@param active: set to True to be active
@type active: bool
"""
def setAngularVelocity(x, y, z, local):
"""
Set the angular velocity of the object.
@param x: angular velocity for the x-axis
@type x: float
@param y: angular velocity for the y-axis
@type y: float
@param z: angular velocity for the z-axis
@type z: float
@param local: set to True for local axis
@type local: bool
"""
def setLinearVelocity(x, y, z, local):
"""
Set the linear velocity of the object.
@param x: linear velocity for the x-axis
@type x: float
@param y: linear velocity for the y-axis
@type y: float
@param z: linear velocity for the z-axis
@type z: float
@param local: set to True for local axis
@type local: bool
"""
def setPosition(x, y, z):
"""
Set the position of the object
@param x: x coordinate
@type x: float
@param y: y coordinate
@type y: float
@param z: z coordinate
@type z: float
"""