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:
authorMitchell Stokes <mogurijin@gmail.com>2012-11-23 01:52:30 +0400
committerMitchell Stokes <mogurijin@gmail.com>2012-11-23 01:52:30 +0400
commitf90298bc0a74326126ac51d6f2e693e4915dbe07 (patch)
treee0b58816b450510ec3e64688a1301f5170666aeb /doc/python_api
parent2765f1fffc23c645ff9e4529074f03e4a46b3414 (diff)
BGE Docs: Adding docs for the KX_GameObject.playAction() play_mode constants.
Diffstat (limited to 'doc/python_api')
-rw-r--r--doc/python_api/rst/bge.logic.rst26
-rw-r--r--doc/python_api/rst/bge.types.rst2
2 files changed, 27 insertions, 1 deletions
diff --git a/doc/python_api/rst/bge.logic.rst b/doc/python_api/rst/bge.logic.rst
index 4bfb1add4f6..da521d6b245 100644
--- a/doc/python_api/rst/bge.logic.rst
+++ b/doc/python_api/rst/bge.logic.rst
@@ -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
-------------
diff --git a/doc/python_api/rst/bge.types.rst b/doc/python_api/rst/bge.types.rst
index a7f73afd645..055ab7a04c1 100644
--- a/doc/python_api/rst/bge.types.rst
+++ b/doc/python_api/rst/bge.types.rst
@@ -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)