Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Szepe <HG1_public@gmx.net>2015-04-11 17:16:46 +0300
committerThomas Szepe <HG1_public@gmx.net>2015-04-11 17:17:07 +0300
commit87b6d3c7960461249e80c4c8c304cfc968c6586c (patch)
tree336bd2dfc3b85652b978723c459801630e9a96ab /doc/python_api
parentb329016b29c3189e23bafebbe984008dae0d60a2 (diff)
BGE: Add keyword arguments to createConstraint API
Added keyword arguments to createConstraint. Changed initial values for the pivod XYZ form 1 to 0.0. Changed initial values for the axis Z form 1 to 0.0. Delete the parsing for 4 parameters, because parsing only the X pivot is not necessary, also it was not working correctly (int instead of float). Reviewers: brita_, sybren, lordloki, campbellbarton, moguri Reviewed By: lordloki, campbellbarton Subscribers: campbellbarton Differential Revision: https://developer.blender.org/D705
Diffstat (limited to 'doc/python_api')
-rw-r--r--doc/python_api/rst/bge.constraints.rst32
1 files changed, 16 insertions, 16 deletions
diff --git a/doc/python_api/rst/bge.constraints.rst b/doc/python_api/rst/bge.constraints.rst
index 018be96fd14..636a66273e8 100644
--- a/doc/python_api/rst/bge.constraints.rst
+++ b/doc/python_api/rst/bge.constraints.rst
@@ -11,14 +11,14 @@ Physics Constraints (bge.constraints)
.. literalinclude:: ../examples/bge.constraints.py
:lines: 6-
-.. function:: createConstraint(physicsid, physicsid2, constrainttype, [pivotX, pivotY, pivotZ, [axisX, axisY, axisZ, [flag]]]])
+.. function:: createConstraint(physicsid_1, physicsid_2, constraint_type, pivot_X, pivot_y, pivot_z, axis_x, axis_y, axis_z, flag)
Creates a constraint.
- :arg physicsid: the physics id of the first object in constraint
+ :arg physicsid_1: the physics id of the first object in constraint
:type physicsid: int
- :arg physicsid2: the physics id of the second object in constraint
+ :arg physicsid_2: the physics id of the second object in constraint
:type physicsid2: int
:arg constrainttype: the type of the constraint. The constraint types are:
@@ -32,26 +32,26 @@ Physics Constraints (bge.constraints)
:type constrainttype: int
- :arg pivotX: pivot X position
- :type pivotX: float
+ :arg pivot_X: pivot X position
+ :type pivot_X: float (optional)
- :arg pivotY: pivot Y position
- :type pivotY: float
+ :arg pivot_Y: pivot Y position
+ :type pivot_Y: float (optional)
- :arg pivotZ: pivot Z position
- :type pivotZ: float
+ :arg pivot_Z: pivot Z position
+ :type pivot_Z: float (optional)
- :arg axisX: X axis
- :type axisX: float
+ :arg axis_X: X axis angle in degrees
+ :type axis_X: float (optional)
- :arg axisY: Y axis
- :type axisY: float
+ :arg axis_Y: Y axis angle in degrees
+ :type axis_Y: float (optional)
- :arg axisZ: Z axis
- :type axisZ: float
+ :arg axis_Z: Z axis angle in degrees
+ :type axis_Z: float (optional)
:arg flag: 128 to disable collision between linked bodies
- :type flag: int
+ :type flag: int (optional)
.. attribute:: error