BGE API cleanup: apply patch from Moguri: Near, Radar, Touch sensor updated.

5 files changed, 55 insertions, 8 deletions

diff --git a/source/gameengine/PyDoc/GameLogic.py b/source/gameengine/PyDoc/GameLogic.py
index f743acf06fe..0524a9df355 100644
--- a/source/gameengine/PyDoc/GameLogic.py
+++ b/source/gameengine/PyDoc/GameLogic.py
@@ -140,6 +140,14 @@ Documentation for the GameLogic Module.
 @var KX_SOUNDACT_LOOPEND:		    See L{KX_SoundActuator}
 @var KX_SOUNDACT_LOOPBIDIRECTIONAL:	    See L{KX_SoundActuator}
 @var KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP:    See L{KX_SoundActuator}
+
+@group Radar Sensor: KX_RADAR_AXIS_POS_X, KX_RADAR_AXIS_POS_Y, KX_RADAR_AXIS_POS_Z, KX_RADAR_AXIS_NEG_X, KX_RADAR_AXIS_NEG_Y, KX_RADAR_AXIS_NEG_Z
+@var KX_RADAR_AXIS_POS_X:		    See L{KX_RadarSensor}
+@var KX_RADAR_AXIS_POS_Y:		    See L{KX_RadarSensor}
+@var KX_RADAR_AXIS_POS_Z:		    See L{KX_RadarSensor}
+@var KX_RADAR_AXIS_NEG_X:		    See L{KX_RadarSensor}
+@var KX_RADAR_AXIS_NEG_Y:		    See L{KX_RadarSensor}
+@var KX_RADAR_AXIS_NEG_Z:		    See L{KX_RadarSensor}
 """
 
 
diff --git a/source/gameengine/PyDoc/KX_NearSensor.py b/source/gameengine/PyDoc/KX_NearSensor.py
index fef2e4b2acc..a8c408827fe 100644
--- a/source/gameengine/PyDoc/KX_NearSensor.py
+++ b/source/gameengine/PyDoc/KX_NearSensor.py
@@ -5,5 +5,10 @@ from KX_TouchSensor import *
 class KX_NearSensor(KX_TouchSensor):
 	"""
 	A near sensor is a specialised form of touch sensor.
+	
+	@ivar distance: The near sensor activates when an object is within this distance.
+	@type distance: float
+	@ivar resetDistance: The near sensor deactivates when the object exceeds this distance.
+	@type resetDistance: float
 	"""
 
diff --git a/source/gameengine/PyDoc/KX_RadarSensor.py b/source/gameengine/PyDoc/KX_RadarSensor.py
index 64be858371a..b68bf4ea0f3 100644
--- a/source/gameengine/PyDoc/KX_RadarSensor.py
+++ b/source/gameengine/PyDoc/KX_RadarSensor.py
@@ -5,8 +5,26 @@ from KX_NearSensor import *
 class KX_RadarSensor(KX_NearSensor):
 	"""
 	Radar sensor is a near sensor with a conical sensor object.
+	
+	@ivar coneOrigin: The origin of the cone with which to test. The origin
+						is in the middle of the cone.
+						(Read only)
+	@type coneOrigin: list of floats [x, y, z]
+	@ivar coneTarget: The center of the bottom face of the cone with which to test.
+						(Read only)
+	@type coneTarget: list of floats [x, y, z]
+	@ivar distance: The height of the cone with which to test.
+	@type distance: float
+	@ivar angle: The angle of the cone (in degrees) with which to test.
+	@type angle: float from 0 to 360
+	@ivar axis: The axis on which the radar cone is cast
+	@type axis: int from 0 to 5
+		KX_RADAR_AXIS_POS_X, KX_RADAR_AXIS_POS_Y, KX_RADAR_AXIS_POS_Z,
+		KX_RADAR_AXIS_NEG_X, KX_RADAR_AXIS_NEG_Y, KX_RADAR_AXIS_NEG_Z
 	"""
 	
+	
+	#--The following methods are deprecated, please use properties instead.
 	def getConeOrigin():
 		"""
 		Returns the origin of the cone with which to test. The origin
diff --git a/source/gameengine/PyDoc/KX_Scene.py b/source/gameengine/PyDoc/KX_Scene.py
index 24b81bbf55e..5e357e6eefc 100644
--- a/source/gameengine/PyDoc/KX_Scene.py
+++ b/source/gameengine/PyDoc/KX_Scene.py
@@ -70,3 +70,16 @@ class KX_Scene:
 		@rtype: string
 		"""
 
+	def addObject(object, other, time=0)
+		"""
+		Adds an object to the scene like the Add Object Actuator would, and returns the created object.
+		
+		@param object: The object to add
+		@type object: L{KX_GameObject} or string
+		@param other: The object's center to use when adding the object
+		@type other: L{KX_GameObject} or string
+		@param time: The lifetime of the added object, in frames. A time of 0 means the object will last forever.
+		@type time: int
+		
+		@rtype: L{KX_GameObject}
+		"""
diff --git a/source/gameengine/PyDoc/KX_TouchSensor.py b/source/gameengine/PyDoc/KX_TouchSensor.py
index 4f020930c4c..d7277be4c2a 100644
--- a/source/gameengine/PyDoc/KX_TouchSensor.py
+++ b/source/gameengine/PyDoc/KX_TouchSensor.py
@@ -7,10 +7,11 @@ class KX_TouchSensor(SCA_ISensor):
 	"""
 	Touch sensor detects collisions between objects.
 	
-	@ivar propertyName: The name of the property or material this sensor detects (depending on the materialCheck property).
-	@type propertyName: string
-	@ivar materialCheck: when enabled this sensor checks for object materials rather then properties.
-	@type materialCheck: bool
+	@ivar property: The property or material to collide with.
+	@type property: string
+	@ivar useMaterial: Determines if the sensor is looking for a property or material.
+						KX_True = Find material; KX_False = Find property
+	@type useMaterial: boolean
 	@ivar pulseCollisions: The last collided object.
 	@type pulseCollisions: bool
 	@ivar objectHit: The last collided object. (Read Only)
@@ -18,24 +19,26 @@ class KX_TouchSensor(SCA_ISensor):
 	@ivar objectHitList: A list of colliding objects. (Read Only)
 	@type objectHitList: list
 	"""
+		
+	#--The following methods are deprecated, please use properties instead.
 	def setProperty(name):
 		"""
-		DEPRECATED: use the propertyName property
+		DEPRECATED: use the property property
 		Set the property or material to collide with. Use
 		setTouchMaterial() to switch between properties and
 		materials.
 		@type name: string
 		"""
+		
 	def getProperty():
 		"""
-		DEPRECATED: use the propertyName property
+		DEPRECATED: use the property property
 		Returns the property or material to collide with. Use
 		getTouchMaterial() to find out whether this sensor
 		looks for properties or materials. (B{deprecated})
 		
 		@rtype: string
 		"""
-
 	def getHitObject():
 		"""
 		DEPRECATED: use the objectHit property
@@ -54,7 +57,7 @@ class KX_TouchSensor(SCA_ISensor):
 		"""
 	def getTouchMaterial():
 		"""
-		DEPRECATED: use the materialCheck property
+		DEPRECATED: use the useMaterial property
 		Returns KX_TRUE if this sensor looks for a specific material,
 		KX_FALSE if it looks for a specific property. (B{deprecated})
 		"""