[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [52491] trunk/blender/doc/python_api/rst: BGE Docs: Adding docs for the KX_GameObject.playAction() play_mode constants.

Mitchell Stokes mogurijin at gmail.com
Thu Nov 22 22:52:31 CET 2012


Revision: 52491
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=52491
Author:   moguri
Date:     2012-11-22 21:52:30 +0000 (Thu, 22 Nov 2012)
Log Message:
-----------
BGE Docs: Adding docs for the KX_GameObject.playAction() play_mode constants.

Modified Paths:
--------------
    trunk/blender/doc/python_api/rst/bge.logic.rst
    trunk/blender/doc/python_api/rst/bge.types.rst

Modified: trunk/blender/doc/python_api/rst/bge.logic.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.logic.rst	2012-11-22 21:37:12 UTC (rev 52490)
+++ trunk/blender/doc/python_api/rst/bge.logic.rst	2012-11-22 21:52:30 UTC (rev 52491)
@@ -1068,6 +1068,32 @@
 .. 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
 -------------

Modified: trunk/blender/doc/python_api/rst/bge.types.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.types.rst	2012-11-22 21:37:12 UTC (rev 52490)
+++ trunk/blender/doc/python_api/rst/bge.types.rst	2012-11-22 21:52:30 UTC (rev 52491)
@@ -1698,7 +1698,7 @@
       :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)




More information about the Bf-blender-cvs mailing list