BGE API cleanup: DynamicActuator, ReplaceMeshActuator, TrackToActuator.

4 files changed, 57 insertions, 0 deletions

diff --git a/source/gameengine/PyDoc/GameLogic.py b/source/gameengine/PyDoc/GameLogic.py
index 833d896ba6b..f158b410975 100644
--- a/source/gameengine/PyDoc/GameLogic.py
+++ b/source/gameengine/PyDoc/GameLogic.py
@@ -72,6 +72,7 @@ Documentation for the GameLogic Module.
 		- L{SoundActuator<KX_SoundActuator.KX_SoundActuator>}
 		- L{TrackToActuator<KX_TrackToActuator.KX_TrackToActuator>}
 		- L{VisibilityActuator<KX_VisibilityActuator.KX_VisibilityActuator>}
+		- L{DynamicActuator<KX_SCA_DynamicActuator.KX_SCA_DynamicActuator>}
 	
 	Most logic brick's methods are accessors for the properties available in the logic buttons.
 	Consult the logic bricks documentation for more information on how each logic brick works.
@@ -156,6 +157,14 @@ Documentation for the GameLogic Module.
 @var KX_RAY_AXIS_NEG_X:		    See L{KX_RaySensor}
 @var KX_RAY_AXIS_NEG_Y:		    See L{KX_RaySensor}
 @var KX_RAY_AXIS_NEG_Z:		    See L{KX_RaySensor}
+
+@group Dynamic Actuator: KX_DYN_RESTORE_DYNAMICS, KX_DYN_DISABLE_DYNAMICS, KX_DYN_ENABLE_RIGID_BODY, KX_DYN_DISABLE_RIGID_BODY,	KX_DYN_SET_MASS
+@var KX_DYN_RESTORE_DYNAMICS:	See L{KX_SCA_DynamicActuator}
+@var KX_DYN_DISABLE_DYNAMICS:	See L{KX_SCA_DynamicActuator}
+@var KX_DYN_ENABLE_RIGID_BODY:	See L{KX_SCA_DynamicActuator}
+@var KX_DYN_DISABLE_RIGID_BODY:	See L{KX_SCA_DynamicActuator}
+@var KX_DYN_SET_MASS:			See L{KX_SCA_DynamicActuator}
+
 """
 
 
diff --git a/source/gameengine/PyDoc/KX_SCA_DynamicActuator.py b/source/gameengine/PyDoc/KX_SCA_DynamicActuator.py
new file mode 100644
index 00000000000..a6a3bce1f31
--- /dev/null
+++ b/source/gameengine/PyDoc/KX_SCA_DynamicActuator.py
@@ -0,0 +1,30 @@
+# $Id$
+# Documentation for  KX_SCA_DynamicActuator
+from SCA_IActuator import *
+
+class KX_SCA_DynamicActuator(SCA_IActuator):
+	"""
+	Dynamic Actuator.
+    @ivar operation: the type of operation of the actuator, 0-4
+                     KX_DYN_RESTORE_DYNAMICS, KX_DYN_DISABLE_DYNAMICS, 
+                     KX_DYN_ENABLE_RIGID_BODY, KX_DYN_DISABLE_RIGID_BODY, KX_DYN_SET_MASS
+    @type operation: integer
+    @ivar mass: the mass value for the KX_DYN_SET_MASS operation
+    @type mass: float
+	"""
+	def setOperation(operation):
+		"""
+        DEPRECATED: Use the operation property instead.
+		Set the type of operation when the actuator is activated:
+                0 = restore dynamics
+                1 = disable dynamics
+                2 = enable rigid body
+                3 = disable rigid body
+                4 = set mass
+        """
+	def getOperatoin()
+		"""
+        DEPRECATED: Use the operation property instead.
+		return the type of operation
+		"""
+	
diff --git a/source/gameengine/PyDoc/KX_SCA_ReplaceMeshActuator.py b/source/gameengine/PyDoc/KX_SCA_ReplaceMeshActuator.py
index 498f6072e23..1faf215ed56 100644
--- a/source/gameengine/PyDoc/KX_SCA_ReplaceMeshActuator.py
+++ b/source/gameengine/PyDoc/KX_SCA_ReplaceMeshActuator.py
@@ -55,9 +55,15 @@ class KX_SCA_ReplaceMeshActuator(SCA_IActuator):
 		This will generate a warning in the console:
 		
 		C{ERROR: GameObject I{OBName} ReplaceMeshActuator I{ActuatorName} without object}
+		
+	Properties:
+	@ivar mesh: the name of the mesh that will replace the current one
+	            Set to None to disable actuator
+	@type mesh: string or None if no mesh is set
 	"""
 	def setMesh(name):
 		"""
+        DEPRECATED: Use the mesh property instead.
 		Sets the name of the mesh that will replace the current one.
 		When the name is None it will unset the mesh value so no action is taken.
 		
@@ -65,6 +71,7 @@ class KX_SCA_ReplaceMeshActuator(SCA_IActuator):
 		"""
 	def getMesh():
 		"""
+        DEPRECATED: Use the mesh property instead.
 		Returns the name of the mesh that will replace the current one.
 		
 		Returns None if no mesh has been scheduled to be added.
diff --git a/source/gameengine/PyDoc/KX_TrackToActuator.py b/source/gameengine/PyDoc/KX_TrackToActuator.py
index 730ab21166b..ff533e22ac0 100644
--- a/source/gameengine/PyDoc/KX_TrackToActuator.py
+++ b/source/gameengine/PyDoc/KX_TrackToActuator.py
@@ -15,9 +15,15 @@ class KX_TrackToActuator(SCA_IActuator):
 
 	@ivar object: the object this actuator tracks.
 	@type object: KX_GameObject or None
+	@ivar time: the time in frames with which to delay the tracking motion
+	@type time: integer
+	@ivar use3D: the tracking motion to use 3D
+	@type use3D: boolean
+	
 	"""
 	def setObject(object):
 		"""
+        DEPRECATED: Use the object property.
 		Sets the object to track.
 		
 		@type object: L{KX_GameObject}, string or None
@@ -25,6 +31,7 @@ class KX_TrackToActuator(SCA_IActuator):
 		"""
 	def getObject(name_only):
 		"""
+        DEPRECATED: Use the object property.
 		Returns the name of the object to track.
 		
 		@type name_only: bool
@@ -33,18 +40,21 @@ class KX_TrackToActuator(SCA_IActuator):
 		"""
 	def setTime(time):
 		"""
+        DEPRECATED: Use the time property.
 		Sets the time in frames with which to delay the tracking motion.
 		
 		@type time: integer
 		"""
 	def getTime():
 		"""
+        DEPRECATED: Use the time property.
 		Returns the time in frames with which the tracking motion is delayed.
 		
 		@rtype: integer
 		"""
 	def setUse3D(use3d):
 		"""
+        DEPRECATED: Use the use3D property.
 		Sets the tracking motion to use 3D.
 		
 		@type use3d: boolean
@@ -53,6 +63,7 @@ class KX_TrackToActuator(SCA_IActuator):
 		"""
 	def getUse3D():
 		"""
+        DEPRECATED: Use the use3D property.
 		Returns True if the tracking motion will track in the z direction.
 		
 		@rtype: boolean