From 976e3a1824622c11c0bc72110345fcceae75fd73 Mon Sep 17 00:00:00 2001
From: Kester Maddock <Christopher.Maddock.1@uni.massey.ac.nz>
Date: Wed, 2 Jun 2004 12:43:27 +0000
Subject: Updates to GamePython Reference. Added Actuator documentation.

---
 .../gameengine/PyDoc/KX_SCA_AddObjectActuator.py   | 68 ++++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py

(limited to 'source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py')

diff --git a/source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py b/source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py
new file mode 100644
index 00000000000..eef08a3fd56
--- /dev/null
+++ b/source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py
@@ -0,0 +1,68 @@
+# $Id$
+# Documentation for KX_SCA_AddObjectActuator
+from SCA_IActuator import *
+
+class KX_SCA_AddObjectActuator(SCA_IActuator):
+	"""
+	Edit Object Actuator (in Add Object Mode)
+	
+	@warning: Add Object actuators 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.
+		  
+		  This will genereate a warning in the console:
+		  
+		  C{ERROR: GameObject I{OBName} has a AddObjectActuator I{ActuatorName} without object (in 'nonactive' layer)}
+	"""
+	def setObject(name):
+		"""
+		Sets the name of the game object to add.
+		
+		A copy of the named object will be added to the scene.
+		
+		If the named object does not exist, this function is ignored.
+		
+		@type name: string
+		"""
+	def getObject():
+		"""
+		Returns the name of the game object to be added.
+		
+		@rtype: string
+		"""
+	def setTime(time):
+		"""
+		Sets the lifetime of added objects, in frames.
+		
+		@type time: integer
+		@param time: The minimum value for time is 0.
+		"""
+	def getTime():
+		"""
+		Returns the lifetime of the added object, in frames.
+		
+		@rtype: integer
+		"""
+	def setLinearVelocity(vx, vy, vz):
+		"""
+		Sets the initial linear velocity of added objects.
+		
+		@type vx: float
+		@param vx: the x component of the initial linear velocity.
+		@type vy: float
+		@param vy: the y component of the initial linear velocity.
+		@type vz: float
+		@param vz: the z component of the initial linear velocity.
+		"""
+	def getLinearVelocity():
+		"""
+		Returns the initial linear velocity of added objects.
+		
+		@rtype: list [vx, vy, vz]
+		"""
+	def getLastCreatedObject():
+		"""
+		Returns the last object created by this actuator.
+		
+		@rtype: L{KX_GameObject}
+		@return: A L{KX_GameObject} or None if no object has been created.
+		"""
-- 
cgit v1.2.3