diff options
Diffstat (limited to 'source/gameengine/PyDoc')
-rw-r--r-- | source/gameengine/PyDoc/GameLogic.py | 8 | ||||
-rw-r--r-- | source/gameengine/PyDoc/KX_NetworkMessageActuator.py | 13 | ||||
-rw-r--r-- | source/gameengine/PyDoc/KX_NetworkMessageSensor.py | 17 | ||||
-rw-r--r-- | source/gameengine/PyDoc/KX_RaySensor.py | 25 |
4 files changed, 63 insertions, 0 deletions
diff --git a/source/gameengine/PyDoc/GameLogic.py b/source/gameengine/PyDoc/GameLogic.py index 0524a9df355..833d896ba6b 100644 --- a/source/gameengine/PyDoc/GameLogic.py +++ b/source/gameengine/PyDoc/GameLogic.py @@ -148,6 +148,14 @@ Documentation for the GameLogic Module. @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} + +@group Ray Sensor: KX_RAY_AXIS_POS_X, KX_RAY_AXIS_POS_Y, KX_RAY_AXIS_POS_Z, KX_RAY_AXIS_NEG_X, KX_RAY_AXIS_NEG_Y, KX_RAY_AXIS_NEG_Z +@var KX_RAY_AXIS_POS_X: See L{KX_RaySensor} +@var KX_RAY_AXIS_POS_Y: See L{KX_RaySensor} +@var KX_RAY_AXIS_POS_Z: See L{KX_RaySensor} +@var KX_RAY_AXIS_NEG_X: See L{KX_RaySensor} +@var KX_RAY_AXIS_NEG_Y: See L{KX_RaySensor} +@var KX_RAY_AXIS_NEG_Z: See L{KX_RaySensor} """ diff --git a/source/gameengine/PyDoc/KX_NetworkMessageActuator.py b/source/gameengine/PyDoc/KX_NetworkMessageActuator.py index aecd2897743..c9f48d47eb8 100644 --- a/source/gameengine/PyDoc/KX_NetworkMessageActuator.py +++ b/source/gameengine/PyDoc/KX_NetworkMessageActuator.py @@ -5,21 +5,33 @@ from SCA_IActuator import * class KX_NetworkMessageActuator(SCA_IActuator): """ Message Actuator + + @ivar propName: Messages will only be sent to objects with the given property name. + @type propName: string + @ivar subject: The subject field of the message. + @type subject: string + @ivar body: The body of the message. + @type body: string + @ivar usePropBody: Send a property instead of a regular body message. + @type usePropBody: boolean """ def setToPropName(name): """ + DEPRECATED: Use the propName property instead. Messages will only be sent to objects with the given property name. @type name: string """ def setSubject(subject): """ + DEPRECATED: Use the subject property instead. Sets the subject field of the message. @type subject: string """ def setBodyType(bodytype): """ + DEPRECATED: Use the usePropBody property instead. Sets the type of body to send. @type bodytype: boolean @@ -27,6 +39,7 @@ class KX_NetworkMessageActuator(SCA_IActuator): """ def setBody(body): """ + DEPRECATED: Use the body property instead. Sets the message body. @type body: string diff --git a/source/gameengine/PyDoc/KX_NetworkMessageSensor.py b/source/gameengine/PyDoc/KX_NetworkMessageSensor.py index 8f5f3609df7..0fecad58437 100644 --- a/source/gameengine/PyDoc/KX_NetworkMessageSensor.py +++ b/source/gameengine/PyDoc/KX_NetworkMessageSensor.py @@ -7,9 +7,22 @@ class KX_NetworkMessageSensor(SCA_ISensor): The Message Sensor logic brick. Currently only loopback (local) networks are supported. + + @ivar subject: The subject the sensor is looking for. + @type subject: string + @ivar frameMessageCount: The number of messages received since the last frame. + (Read-only) + @type framemessageCount: int + @ivar subjects: The list of message subjects received. (Read-only) + @type subjects: list of strings + @ivar bodies: The list of message bodies received. (Read-only) + @type bodies: list of strings """ + + def setSubjectFilterText(subject): """ + DEPRECATED: Use the subject property instead. Change the message subject text that this sensor is listening to. @type subject: string @@ -18,24 +31,28 @@ class KX_NetworkMessageSensor(SCA_ISensor): def getFrameMessageCount(): """ + DEPRECATED: Use the frameMessageCount property instead. Get the number of messages received since the last frame. @rtype: integer """ def getBodies(): """ + DEPRECATED: Use the bodies property instead. Gets the list of message bodies. @rtype: list """ def getSubject(): """ + DEPRECATED: Use the subject property instead. Gets the message subject this sensor is listening for from the Subject: field. @rtype: string """ def getSubjects(): """ + DEPRECATED: Use the subjects property instead. Gets the list of message subjects received. @rtype: list diff --git a/source/gameengine/PyDoc/KX_RaySensor.py b/source/gameengine/PyDoc/KX_RaySensor.py index e487edcb655..b9de54e92a5 100644 --- a/source/gameengine/PyDoc/KX_RaySensor.py +++ b/source/gameengine/PyDoc/KX_RaySensor.py @@ -5,28 +5,53 @@ from SCA_ISensor import * class KX_RaySensor(SCA_ISensor): """ A ray sensor detects the first object in a given direction. + + @ivar property: The property the ray is looking for. + @type property: string + @ivar range: The distance of the ray. + @type range: float + @ivar useMaterial: Whether or not to look for a material (false = property) + @type useMaterial: boolean + @ivar useXRay: Whether or not to use XRay. + @type useXRay: boolean + @ivar hitObject: The game object that was hit by the ray. (Read-only) + @type hitObject: KX_GameObject + @ivar hitPosition: The position (in worldcoordinates) where the object was hit by the ray. (Read-only) + @type hitPosition: list [x, y, z] + @ivar hitNormal: The normal (in worldcoordinates) of the object at the location where the object was hit by the ray. (Read-only) + @type hitNormal: list [x, y, z] + @ivar rayDirection: The direction from the ray (in worldcoordinates). (Read-only) + @type rayDirection: list [x, y, z] + @ivar axis: The axis the ray is pointing on. + @type axis: int from 0 to 5 + KX_RAY_AXIS_POS_X, KX_RAY_AXIS_POS_Y, KX_RAY_AXIS_POS_Z, + KX_RAY_AXIS_NEG_X, KX_RAY_AXIS_NEG_Y, KX_RAY_AXIS_NEG_Z """ def getHitObject(): """ + DEPRECATED: Use the hitObject property instead. Returns the game object that was hit by this ray. @rtype: KX_GameObject """ def getHitPosition(): """ + DEPRECATED: Use the hitPosition property instead. Returns the position (in worldcoordinates) where the object was hit by this ray. @rtype: list [x, y, z] """ def getHitNormal(): """ + DEPRECATED: Use the hitNormal property instead. Returns the normal (in worldcoordinates) of the object at the location where the object was hit by this ray. @rtype: list [nx, ny, nz] """ def getRayDirection(): """ + DEPRECATED: Use the rayDirection property instead. Returns the direction from the ray (in worldcoordinates) @rtype: list [dx, dy, dz] |