BGE API cleanup: apply patch from Moguri: Near, Radar, Touch sensor updated.
[blender.git] / source / gameengine / PyDoc / KX_RadarSensor.py
index 64be858371a733a1f2aef02c3260efda7d6e7ee1..b68bf4ea0f3ee050e45234d1b14464726b7bd312 100644 (file)
@@ -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