BGE patch #10492 approved: getLinearVelocity() now can provide local velocity as well. This patch is harmless and backward compatible; it can go safely into 2.46 release

1 files changed, 7 insertions, 3 deletions

diff --git a/source/gameengine/PyDoc/KX_GameObject.py b/source/gameengine/PyDoc/KX_GameObject.py
index 31c9993e194..8ef82b4943b 100644
--- a/source/gameengine/PyDoc/KX_GameObject.py
+++ b/source/gameengine/PyDoc/KX_GameObject.py
@@ -58,15 +58,16 @@ class KX_GameObject:
 		@rtype: 3x3 rotation matrix
 		@return: The game object's rotation matrix
 		"""
-	def getLinearVelocity():
+	def getLinearVelocity(local):
 		"""
 		Gets the game object's linear velocity.
 		
 		This method returns the game object's velocity through it's centre of mass,
 		ie no angular velocity component.
 		
-		cf getVelocity()
-		
+		@type local: boolean
+		@param local: - False: you get the "global" velocity ie: relative to world orientation.
+		              - True: you get the "local" velocity ie: relative to object orientation.
 		@rtype: list [vx, vy, vz]
 		@return: the object's linear velocity.
 		"""
@@ -138,6 +139,9 @@ class KX_GameObject:
 	def setParent(parent):
 		"""
 		Sets this object's parent.
+		
+		@type parent: L{KX_GameObject}
+		@param parent: new parent object.
 		"""
 	def removeParent():
 		"""