BGE Docs: Adding docs for the KX_GameObject.playAction() play_mode constants.
authorMitchell Stokes <mogurijin@gmail.com>
Thu, 22 Nov 2012 21:52:30 +0000 (21:52 +0000)
committerMitchell Stokes <mogurijin@gmail.com>
Thu, 22 Nov 2012 21:52:30 +0000 (21:52 +0000)
doc/python_api/rst/bge.logic.rst
doc/python_api/rst/bge.types.rst

index 4bfb1ad..da521d6 100644 (file)
@@ -1068,6 +1068,32 @@ See :class:`bge.types.SCA_PythonKeyboard`, :class:`bge.types.SCA_PythonMouse`, :
 .. data:: KX_INPUT_ACTIVE
 .. data:: KX_INPUT_JUST_RELEASED
 
+------------
+KX_GameObject
+-----------
+.. _gameobject-playaction-mode:
+
+See :class:`bge.types.KX_GameObject.playAction`
+
+.. data:: KX_ACTION_MODE_PLAY
+
+   Play the action once.
+   
+   :value: 0
+
+.. data:: KX_ACTION_MODE_LOOP
+
+   Loop the action (repeat it).
+   
+   :value: 1
+
+.. data:: KX_ACTION_MODE_PING_PONG
+
+   Play the action one direct then back the other way when it has completed.
+   
+   :value: 2
+
+
 -------------
 Mouse Buttons
 -------------
index a7f73af..055ab7a 100644 (file)
@@ -1698,7 +1698,7 @@ Types
       :arg blendin: the amount of blending between this animation and the previous one on this layer
       :type blendin: float
       :arg play_mode: the play mode
-      :type play_mode: KX_ACTION_MODE_PLAY, KX_ACTION_MODE_LOOP, or KX_ACTION_MODE_PING_PONG
+      :type play_mode: one of :ref:`these constants <gameobject-playaction-mode>`
       :arg layer_weight: how much of the previous layer to use for blending (0 = add)
       :type layer_weight: float
       :arg ipo_flags: flags for the old IPO behaviors (force, etc)