diff options
author | Mitchell Stokes <mogurijin@gmail.com> | 2011-07-16 09:29:15 +0400 |
---|---|---|
committer | Mitchell Stokes <mogurijin@gmail.com> | 2011-07-16 09:29:15 +0400 |
commit | 9fa6e32d5cab7e1655adf9206b28547591cc46ba (patch) | |
tree | b277290129d3ad066fd0764e7e6472a6cf259d5d /doc | |
parent | c9c51776ee08827f7d6c7b8b4d671a4660c32b64 (diff) |
BGE Animations: Updating the python docs.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/python_api/rst/bge.types.rst | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/doc/python_api/rst/bge.types.rst b/doc/python_api/rst/bge.types.rst index b3841aaea0b..367f6470f19 100644 --- a/doc/python_api/rst/bge.types.rst +++ b/doc/python_api/rst/bge.types.rst @@ -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. |