From f727df6076241756a07aebdd495284203702dd1b Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 12 May 2015 17:59:37 +1000 Subject: Doc: correct rst syntax also remove some API docs from example --- doc/python_api/rst/bge.constraints.rst | 12 ++++++------ .../rst/bge_types/bge.types.KX_ConstraintWrapper.rst | 15 +++++++++------ 2 files changed, 15 insertions(+), 12 deletions(-) (limited to 'doc') diff --git a/doc/python_api/rst/bge.constraints.rst b/doc/python_api/rst/bge.constraints.rst index cf8565924b0..eaaf806a4a9 100644 --- a/doc/python_api/rst/bge.constraints.rst +++ b/doc/python_api/rst/bge.constraints.rst @@ -23,12 +23,12 @@ Physics Constraints (bge.constraints) :arg constrainttype: the type of the constraint. The constraint types are: :type constrainttype: int - - :class:`POINTTOPOINT_CONSTRAINT` - - :class:`LINEHINGE_CONSTRAINT` - - :class:`ANGULAR_CONSTRAINT` - - :class:`CONETWIST_CONSTRAINT` - - :class:`VEHICLE_CONSTRAINT` - - :class:`GENERIC_6DOF_CONSTRAINT` + - :class:`POINTTOPOINT_CONSTRAINT` + - :class:`LINEHINGE_CONSTRAINT` + - :class:`ANGULAR_CONSTRAINT` + - :class:`CONETWIST_CONSTRAINT` + - :class:`VEHICLE_CONSTRAINT` + - :class:`GENERIC_6DOF_CONSTRAINT` :arg pivot_X: pivot X position :type pivot_X: float (optional) diff --git a/doc/python_api/rst/bge_types/bge.types.KX_ConstraintWrapper.rst b/doc/python_api/rst/bge_types/bge.types.KX_ConstraintWrapper.rst index 2069bfb1dca..588f568cbb0 100644 --- a/doc/python_api/rst/bge_types/bge.types.KX_ConstraintWrapper.rst +++ b/doc/python_api/rst/bge_types/bge.types.KX_ConstraintWrapper.rst @@ -29,6 +29,7 @@ base class --- :class:`PyObjectPlus` * Lowerlimit < Upperlimit -> axis it limited in that range PHY_LINEHINGE_CONSTRAINT = 2 or PHY_ANGULAR_CONSTRAINT = 3: + axis = 3 is a constraint limit, with low/high limit value * 3: X axis angle @@ -38,6 +39,7 @@ base class --- :class:`PyObjectPlus` :type value1: float PHY_CONE_TWIST_CONSTRAINT = 3: + axis = 3..5 are constraint limits, high limit values * 3: X axis angle * 4: Y axis angle @@ -49,6 +51,7 @@ base class --- :class:`PyObjectPlus` :type value1: float PHY_GENERIC_6DOF_CONSTRAINT = 12: + axis = 0..2 are constraint limits, with low/high limit value * 0: X axis position * 1: Y axis position @@ -130,10 +133,10 @@ base class --- :class:`PyObjectPlus` Returns the contraint type (read only) :type: integer - - 1 = :class:`~bge.constraints.POINTTOPOINT_CONSTRAINT` - - 2 = :class:`~bge.constraints.LINEHINGE_CONSTRAINT` - - 3 = :class:`~bge.constraints.ANGULAR_CONSTRAINT` - - 4 = :class:`~bge.constraints.CONETWIST_CONSTRAINT` - - 11 = :class:`~bge.constraints.VEHICLE_CONSTRAINT` - - 12 = :class:`~bge.constraints.GENERIC_6DOF_CONSTRAINT` + - 1 = :class:`~bge.constraints.POINTTOPOINT_CONSTRAINT` + - 2 = :class:`~bge.constraints.LINEHINGE_CONSTRAINT` + - 3 = :class:`~bge.constraints.ANGULAR_CONSTRAINT` + - 4 = :class:`~bge.constraints.CONETWIST_CONSTRAINT` + - 11 = :class:`~bge.constraints.VEHICLE_CONSTRAINT` + - 12 = :class:`~bge.constraints.GENERIC_6DOF_CONSTRAINT` -- cgit v1.2.3