[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [38425] branches/soc-2011-pepper/doc/ python_api/rst/bge.types.rst: BGE Animations: Updating the python docs.
Mitchell Stokes
mogurijin at gmail.com
Sat Jul 16 07:29:16 CEST 2011
Revision: 38425
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=38425
Author: moguri
Date: 2011-07-16 05:29:15 +0000 (Sat, 16 Jul 2011)
Log Message:
-----------
BGE Animations: Updating the python docs.
Modified Paths:
--------------
branches/soc-2011-pepper/doc/python_api/rst/bge.types.rst
Modified: branches/soc-2011-pepper/doc/python_api/rst/bge.types.rst
===================================================================
--- branches/soc-2011-pepper/doc/python_api/rst/bge.types.rst 2011-07-16 05:25:15 UTC (rev 38424)
+++ branches/soc-2011-pepper/doc/python_api/rst/bge.types.rst 2011-07-16 05:29:15 UTC (rev 38425)
@@ -1564,24 +1564,38 @@
:arg speed: the playback speed of the action as a factor (1.0 = normal speed, 2.0 = 2x speed, etc)
:type speed: float
- .. method:: getActionFrame(layer)
+ .. method:: stopAction(layer=0)
+
+ Stop playing the action on the given layer.
+
+ :arg layer: The layer to stop playing.
+ :type layer: integer
+
+ .. method:: getActionFrame(layer=0)
- Gets the current frame of the action playing in the supplied layer
+ Gets the current frame of the action playing in the supplied layer.
:arg layer: The layer that you want to get the frame from.
:type layer: integer
:return: The current frame of the action
- .. method:: setActionFrame(layer, frame)
+ .. method:: setActionFrame(frame, layer=0)
- Set the current frame of the action playing in the supplied layer
+ Set the current frame of the action playing in the supplied layer.
:arg layer: The layer where you want to set the frame
:type layer: integer
:arg frame: The frame to set the action to
:type frame: float
+ .. method:: isPlayingAction(layer=0)
+
+ Checks to see if there is an action playing in the given layer.
+
+ :arg layer: The layer to check for a playing action.
+ :type layer: integer
+
.. class:: KX_IpoActuator(SCA_IActuator)
IPO actuator activates an animation.
More information about the Bf-blender-cvs
mailing list