BGE Animations: Updating the python docs.
authorMitchell Stokes <mogurijin@gmail.com>
Sat, 16 Jul 2011 05:29:15 +0000 (05:29 +0000)
committerMitchell Stokes <mogurijin@gmail.com>
Sat, 16 Jul 2011 05:29:15 +0000 (05:29 +0000)
doc/python_api/rst/bge.types.rst

index b3841aaea0b11505ac8fc91bcfd21eed15ace2c5..367f6470f19e1bbbed1f620e7f3e3404ef14894f 100644 (file)
@@ -1564,24 +1564,38 @@ Game Engine  bge.types Module
       :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.