BGE API cleanup: CDActuator, ParentActuator, VisibilityActuator done. Thanks to Andre.

3 files changed, 30 insertions, 3 deletions

diff --git a/source/gameengine/PyDoc/KX_CDActuator.py b/source/gameengine/PyDoc/KX_CDActuator.py
index 2c202476584..ffc8ddefa43 100644
--- a/source/gameengine/PyDoc/KX_CDActuator.py
+++ b/source/gameengine/PyDoc/KX_CDActuator.py
@@ -3,6 +3,13 @@
 from SCA_IActuator import *
 
 class KX_CDActuator(SCA_IActuator):
+    """
+    CD Controller actuator.
+    @ivar volume: controls the volume to set the CD to. 0.0 = silent, 1.0 = max volume.
+    @type volume: float
+    @ivar track: the track selected to be played
+    @type track: integer
+    """
 	def startCD():
 		"""
 		Starts the CD playing.
@@ -15,8 +22,21 @@ class KX_CDActuator(SCA_IActuator):
 		"""
 		Pauses the CD.
 		"""
+	def resumeCD():
+		"""
+		Resumes the CD after a pause.
+		"""
+    def playAll():
+        """
+        Plays the CD from the beginning.
+        """
+    def playTrack(trackNumber):
+        """
+        Plays the track selected.
+        """
 	def setGain(gain):
 		"""
+        DEPRECATED: Use the volume property.
 		Sets the gain (volume) of the CD.
 		
 		@type gain: float
@@ -24,6 +44,7 @@ class KX_CDActuator(SCA_IActuator):
 		"""
 	def getGain():
 		"""
+        DEPRECATED: Use the volume property.
 		Gets the current gain (volume) of the CD.
 		
 		@rtype: float
diff --git a/source/gameengine/PyDoc/KX_ParentActuator.py b/source/gameengine/PyDoc/KX_ParentActuator.py
index 7b5625ec82d..76252e5cfad 100644
--- a/source/gameengine/PyDoc/KX_ParentActuator.py
+++ b/source/gameengine/PyDoc/KX_ParentActuator.py
@@ -4,13 +4,13 @@ from SCA_IActuator import *
 
 class KX_ParentActuator(SCA_IActuator):
 	"""
-	The parent actuator can set or remove an objects parent object.
-	
+	The parent actuator can set or remove an objects parent object.	
 	@ivar object: the object this actuator sets the parent too.
 	@type object: KX_GameObject or None
 	"""
 	def setObject(object):
 		"""
+        DEPRECATED: Use the object property.
 		Sets the object to set as parent.
 		
 		Object can be either a L{KX_GameObject} or the name of the object.
@@ -19,6 +19,7 @@ class KX_ParentActuator(SCA_IActuator):
 		"""
 	def getObject(name_only = 1):
 		"""
+        DEPRECATED: Use the object property.
 		Returns the name of the object to change to.
 		@type name_only: bool
 		@param name_only: optional argument, when 0 return a KX_GameObject
diff --git a/source/gameengine/PyDoc/KX_VisibilityActuator.py b/source/gameengine/PyDoc/KX_VisibilityActuator.py
index 22499f25d81..17d22fa5f83 100644
--- a/source/gameengine/PyDoc/KX_VisibilityActuator.py
+++ b/source/gameengine/PyDoc/KX_VisibilityActuator.py
@@ -5,13 +5,18 @@ from SCA_IActuator import *
 class KX_VisibilityActuator(SCA_IActuator):
 	"""
 	Visibility Actuator.
+    @ivar visibility: whether the actuator makes its parent object visible or invisible
+    @type visibility: boolean
+    @ivar recursion: whether the visibility/invisibility should be propagated to all children of the object
+    @type recursion: boolean
 	"""
 	def set(visible):
 		"""
+        DEPRECATED: Use the visibility property instead.
 		Sets whether the actuator makes its parent object visible or invisible.
 		
 		@param visible: - True: Makes its parent visible.
 		                - False: Makes its parent invisible.
 		"""
 
-	
\ No newline at end of file
+