BGE API cleanup: AddObject, DeleteObject and Scene actuator added.

2 files changed, 29 insertions, 0 deletions

diff --git a/source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py b/source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py
index 56068fa641a..974ef718ccf 100644
--- a/source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py
+++ b/source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py
@@ -9,6 +9,12 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
 	@type object: KX_GameObject or None
 	@ivar objectLastCreated: the last added object from this actuator (read only).
 	@type objectLastCreated: KX_GameObject or None
+	@ivar time: the lifetime of added objects, in frames.
+	@type time: integer
+	@ivar linearVelocity: the initial linear velocity of added objects.
+	@type linearVelocity: list [vx, vy, vz]
+	@ivar angularVelocity: the initial angular velocity of added objects.
+	@type angularVelocity: list [vx, vy, vz]
 	
 	@warning: An Add Object actuator will be ignored if at game start, the linked object doesn't exist
 		  (or is empty) or the linked object is in an active layer.
@@ -19,6 +25,7 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
 	"""
 	def setObject(object):
 		"""
+		DEPRECATED: use the object property
 		Sets the game object to add.
 		
 		A copy of the object will be added to the scene when the actuator is activated.
@@ -31,6 +38,7 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
 		"""
 	def getObject(name_only = 0):
 		"""
+		DEPRECATED: use the object property
 		Returns the name of the game object to be added.
 		
 		Returns None if no game object has been assigned to be added.
@@ -40,6 +48,7 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
 		"""
 	def setTime(time):
 		"""
+		DEPRECATED: use the time property
 		Sets the lifetime of added objects, in frames.
 		
 		If time == 0, the object will last forever.
@@ -49,12 +58,14 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
 		"""
 	def getTime():
 		"""
+		DEPRECATED: use the time property
 		Returns the lifetime of the added object, in frames.
 		
 		@rtype: integer
 		"""
 	def setLinearVelocity(vx, vy, vz):
 		"""
+		DEPRECATED: use the linearVelocity property
 		Sets the initial linear velocity of added objects.
 		
 		@type vx: float
@@ -66,12 +77,14 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
 		"""
 	def getLinearVelocity():
 		"""
+		DEPRECATED: use the linearVelocity property
 		Returns the initial linear velocity of added objects.
 		
 		@rtype: list [vx, vy, vz]
 		"""
 	def setAngularVelocity(vx, vy, vz):
 		"""
+		DEPRECATED: use the angularVelocity property
 		Sets the initial angular velocity of added objects.
 		
 		@type vx: float
@@ -83,12 +96,14 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
 		"""
 	def getAngularVelocity():
 		"""
+		DEPRECATED: use the angularVelocity property
 		Returns the initial angular velocity of added objects.
 		
 		@rtype: list [vx, vy, vz]
 		"""
 	def getLastCreatedObject():
 		"""
+		DEPRECATED: use the objectLastCreated property
 		Returns the last object created by this actuator.
 		
 		@rtype: L{KX_GameObject}
diff --git a/source/gameengine/PyDoc/KX_SceneActuator.py b/source/gameengine/PyDoc/KX_SceneActuator.py
index cfb40ae072f..c8912783ab7 100644
--- a/source/gameengine/PyDoc/KX_SceneActuator.py
+++ b/source/gameengine/PyDoc/KX_SceneActuator.py
@@ -12,21 +12,32 @@ class KX_SceneActuator(SCA_IActuator):
 		  This will generate a warning in the console:
 		  
 		  C{ERROR: GameObject I{OBName} has a SceneActuator I{ActuatorName} (SetScene) without scene}
+
+	Properties:
+	
+	@ivar scene: the name of the scene to change to/overlay/underlay/remove/suspend/resume
+	@type scene: string.
+	@ivar camera: the camera to change to.
+	              When setting the attribute, you can use either a L{KX_Camera} or the name of the camera.
+	@type camera: L{KX_Camera} on read, string or L{KX_Camera} on write
 	"""
 	def setUseRestart(flag):
 		"""
+		DEPRECATED
 		Set flag to True to restart the scene.
 		
 		@type flag: boolean
 		"""
 	def setScene(scene):
 		"""
+		DEPRECATED: use the scene property instead
 		Sets the name of the scene to change to/overlay/underlay/remove/suspend/resume.
 		
 		@type scene: string
 		"""
 	def setCamera(camera):
 		"""
+		DEPRECATED: use the camera property instead
 		Sets the camera to change to.
 		
 		Camera can be either a L{KX_Camera} or the name of the camera.
@@ -35,12 +46,14 @@ class KX_SceneActuator(SCA_IActuator):
 		"""
 	def getUseRestart():
 		"""
+		DEPRECATED
 		Returns True if the scene will be restarted.
 		
 		@rtype: boolean
 		"""
 	def getScene():
 		"""
+		DEPRECATED: use the scene property instead
 		Returns the name of the scene to change to/overlay/underlay/remove/suspend/resume.
 		
 		Returns an empty string ("") if no scene has been set.
@@ -49,6 +62,7 @@ class KX_SceneActuator(SCA_IActuator):
 		"""
 	def getCamera():
 		"""
+		DEPRECATED: use the camera property instead
 		Returns the name of the camera to change to.
 		
 		@rtype: string