BGE Docs: Moving the BL_ArmatureConstraint constant docs from bge.types.rst to bge...

[blender.git] / doc / python_api / rst / bge.logic.rst

diff --git a/doc/python_api/rst/bge.logic.rst b/doc/python_api/rst/bge.logic.rst
index ef52f94b995448dc81694cf5b0a99260348a5ddc..8cf2561be584f9f266935718e7a39d83af072f90 100644 (file)
--- a/doc/python_api/rst/bge.logic.rst
+++ b/doc/python_api/rst/bge.logic.rst
@@ -991,3 +991,88 @@ Blender Material
 .. data:: BL_SRC_ALPHA_SATURATE
 .. data:: BL_SRC_COLOR
 .. data:: BL_ZERO
+
+----------------
+Armature Constraint
+----------------
+   .. _armatureconstraint-constants-type:
+
+   See :class:`bge.types.BL_ArmatureConstraint.type`
+
+   .. data:: CONSTRAINT_TYPE_TRACKTO
+   .. data:: CONSTRAINT_TYPE_KINEMATIC
+   .. data:: CONSTRAINT_TYPE_ROTLIKE
+   .. data:: CONSTRAINT_TYPE_LOCLIKE
+   .. data:: CONSTRAINT_TYPE_MINMAX
+   .. data:: CONSTRAINT_TYPE_SIZELIKE
+   .. data:: CONSTRAINT_TYPE_LOCKTRACK
+   .. data:: CONSTRAINT_TYPE_STRETCHTO
+   .. data:: CONSTRAINT_TYPE_CLAMPTO
+   .. data:: CONSTRAINT_TYPE_TRANSFORM
+   .. data:: CONSTRAINT_TYPE_DISTLIMIT
+
+   .. _armatureconstraint-constants-ik-type:
+
+   See :class:`bge.types.BL_ArmatureConstraint.ik_type`
+      
+   .. data:: CONSTRAINT_IK_COPYPOSE
+      
+      constraint is trying to match the position and eventually the rotation of the target.
+      
+      :value: 0
+   
+   .. data:: CONSTRAINT_IK_DISTANCE
+      
+      Constraint is maintaining a certain distance to target subject to ik_mode
+      
+      :value: 1
+
+   .. _armatureconstraint-constants-ik-flag:
+
+   See :class:`bge.types.BL_ArmatureConstraint.ik_flag`
+
+   .. data:: CONSTRAINT_IK_FLAG_TIP
+      
+      Set when the constraint operates on the head of the bone and not the tail
+      
+      :value: 1
+      
+   .. data:: CONSTRAINT_IK_FLAG_ROT
+      
+      Set when the constraint tries to match the orientation of the target
+      
+      :value: 2
+      
+   .. data:: CONSTRAINT_IK_FLAG_STRETCH
+      
+      Set when the armature is allowed to stretch (only the bones with stretch factor > 0.0)
+      
+      :value: 16
+      
+   .. data:: CONSTRAINT_IK_FLAG_POS
+      
+      Set when the constraint tries to match the position of the target.
+      
+      :value: 32
+      
+   .. _armatureconstraint-constants-ik-mode:
+
+   See :class:`bge.types.BL_ArmatureConstraint.ik_mode`
+   
+   .. data:: CONSTRAINT_IK_MODE_INSIDE
+      
+      The constraint tries to keep the bone within ik_dist of target
+      
+      :value: 0
+      
+   .. data:: CONSTRAINT_IK_MODE_OUTSIDE
+      
+      The constraint tries to keep the bone outside ik_dist of the target
+      
+      :value: 1
+      
+   .. data:: CONSTRAINT_IK_MODE_ONSURFACE
+      
+      The constraint tries to keep the bone exactly at ik_dist of the target.
+      
+      :value: 2