BGE PyAPI

while making a demo of using python to control bones found some more problems.
also added channelNames attribute to BL_ActionActuator to get a list of valid channels to use.
demo: http://www.graphicall.org/ftp/ideasman42/armature_python.blend

its still not that useful since theres not way to know rest bone locations yet but better then nothing.

1 files changed, 5 insertions, 2 deletions

diff --git a/source/gameengine/PyDoc/GameTypes.py b/source/gameengine/PyDoc/GameTypes.py
index 63dd1a7fabf..35d8cd63c44 100644
--- a/source/gameengine/PyDoc/GameTypes.py
+++ b/source/gameengine/PyDoc/GameTypes.py
@@ -310,6 +310,8 @@ class BL_ActionActuator(SCA_IActuator):
 	
 	@ivar action: The name of the action to set as the current action.
 	@type action: string
+	@ivar channelNames: A list of channel names that may be used with L{setChannel} and L{getChannel}
+	@type channelNames: list of strings
 	@ivar frameStart: Specifies the starting frame of the animation.
 	@type frameStart: float
 	@ivar frameEnd: Specifies the ending frame of the animation.
@@ -340,7 +342,8 @@ class BL_ActionActuator(SCA_IActuator):
 		"""
 		Alternative to the 2 arguments, 4 arguments (channel, matrix, loc, size, quat) are also supported.
 		
-		@param channel: A string specifying the name of the bone channel, created if missing.
+		@note: These values are relative to the bones rest position, currently the api has no way to get this info (which is annoying), but can be worked around by using bones with a rest pose that has no translation.
+		@param channel: A string specifying the name of the bone channel, error raised if not in L{channelNames}.
 		@type channel: string
 		@param matrix: A 4x4 matrix specifying the overriding transformation
 		               as an offset from the bone's rest position.
@@ -349,7 +352,7 @@ class BL_ActionActuator(SCA_IActuator):
 
 	def getChannel(channel):
 		"""
-		@param channel: A string specifying the name of the bone channel. error raised if missing.
+		@param channel: A string specifying the name of the bone channel. error raised if not in L{channelNames}.
 		@type channel: string
 		@rtype: tuple
 		@return: (loc, size, quat)