[Bf-blender-cvs] [73dfd3d3824] master: Pydocs: Expand bge.contraint docs

Aaron Carlisle noreply at git.blender.org
Sun Apr 15 00:26:45 CEST 2018


Commit: 73dfd3d38241735c7182862cd43a6fb5df6e054b
Author: Aaron Carlisle
Date:   Thu Mar 29 18:18:04 2018 -0400
Branches: master
https://developer.blender.org/rB73dfd3d38241735c7182862cd43a6fb5df6e054b

Pydocs: Expand bge.contraint docs

Takes information from the manual and dumps it here.

===================================================================

M	doc/python_api/rst/bge.constraints.rst

===================================================================

diff --git a/doc/python_api/rst/bge.constraints.rst b/doc/python_api/rst/bge.constraints.rst
index ed965c3dfc1..3cca22e9cff 100644
--- a/doc/python_api/rst/bge.constraints.rst
+++ b/doc/python_api/rst/bge.constraints.rst
@@ -2,12 +2,33 @@
 Physics Constraints (bge.constraints)
 =====================================
 
+Bullet Physics provides collision detection
+and rigid body dynamics for the Blender Game Engine.
+
+Features:
+
+- Vehicle simulation.
+- Rigid body constraints: hinge and point to point (ball socket).
+- Access to internal physics settings,
+  like deactivation time, and debugging features
+
 .. module:: bge.constraints
 
+.. note:: Note about parameter settings
+
+   Since this API is not well documented, it can be unclear what kind of values to use for setting parameters.
+   In general, damping settings should be in the range of 0 to 1 and
+   stiffness settings should not be much higher than about 10.
+
 
 Examples
 --------
 
+.. seealso::
+
+   For more examples of Bullet physics and how to use them
+   see the `pybullet forum <https://pybullet.org/Bullet/phpBB3/viewforum.php?f=17>`__.
+
 .. include:: __/examples/bge.constraints.py
    :start-line: 1
    :end-line: 4
@@ -333,4 +354,3 @@ Constraint type to be used with :func:`createConstraint`.
 .. data:: GENERIC_6DOF_CONSTRAINT
 
    .. to do
-



More information about the Bf-blender-cvs mailing list