Module KX_RaySensor :: Class KX_RaySensor

Class KX_RaySensor

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
            SCA_ISensor.SCA_ISensor --+
                                      |
                                     KX_RaySensor

A ray sensor detects the first object in a given direction.

Instance Methods
KX_GameObject
getHitObject()
DEPRECATED: Use the hitObject property instead.
list [x, y, z]
getHitPosition()
DEPRECATED: Use the hitPosition property instead.
list [nx, ny, nz]
getHitNormal()
DEPRECATED: Use the hitNormal property instead.
list [dx, dy, dz]
getRayDirection()
DEPRECATED: Use the rayDirection property instead.
integer
getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
integer
getFrequency()
The frequency for pulse mode sensors. (Inherited from SCA_ISensor.SCA_ISensor)
 
getInvert()
True if this sensor activates on negative events. (Inherited from SCA_ISensor.SCA_ISensor)
boolean
getLevel()
Returns whether this sensor is a level detector or a edge detector. (Inherited from SCA_ISensor.SCA_ISensor)
KX_GameObject
getOwner()
Gets the game object associated with this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
getUseNegPulseMode()
True if the sensor is in negative pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
 
getUsePosPulseMode()
True if the sensor is in positive pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
 
isPositive()
True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor)
 
isTriggered()
True if this sensor brick has triggered the current controller. (Inherited from SCA_ISensor.SCA_ISensor)
 
reset()
Reset sensor internal state, effect depends on the type of sensor and settings. (Inherited from SCA_ISensor.SCA_ISensor)
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
setFrequency(freq)
Sets the frequency for pulse mode sensors. (Inherited from SCA_ISensor.SCA_ISensor)
 
setInvert(invert)
Sets if this sensor activates on positive or negative events. (Inherited from SCA_ISensor.SCA_ISensor)
 
setLevel(level)
Set whether to detect level or edge transition when entering a state. (Inherited from SCA_ISensor.SCA_ISensor)
 
setUseNegPulseMode(pulse)
Sets negative pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
 
setUsePosPulseMode(pulse)
Sets positive pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
Instance Variables
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 axis
The axis the ray is pointing on.
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
int frequency
The frequency for pulse mode sensors. (Inherited from SCA_ISensor.SCA_ISensor)
list [x, y, z] hitNormal
The normal (in worldcoordinates) of the object at the location where the object was hit by the ray.
KX_GameObject hitObject
The game object that was hit by the ray.
list [x, y, z] hitPosition
The position (in worldcoordinates) where the object was hit by the ray.
boolean invert
Flag to set if this sensor activates on positive or negative events. (Inherited from SCA_ISensor.SCA_ISensor)
boolean level
Flag to set whether to detect level or edge transition when entering a state. (Inherited from SCA_ISensor.SCA_ISensor)
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read only). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
boolean positive
True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor)
string property
The property the ray is looking for.
float range
The distance of the ray.
list [x, y, z] rayDirection
The direction from the ray (in worldcoordinates).
boolean triggered
True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor)
boolean useMaterial
Whether or not to look for a material (false = property)
boolean useNegPulseMode
Flag to turn negative pulse mode on and off. (Inherited from SCA_ISensor.SCA_ISensor)
boolean usePosPulseMode
Flag to turn positive pulse mode on and off. (Inherited from SCA_ISensor.SCA_ISensor)
boolean useXRay
Whether or not to use XRay.
Method Details

getHitObject()

 

DEPRECATED: Use the hitObject property instead. Returns the game object that was hit by this ray.

Returns: KX_GameObject

getHitPosition()

 

DEPRECATED: Use the hitPosition property instead. Returns the position (in worldcoordinates) where the object was hit by this ray.

Returns: list [x, y, z]

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.

Returns: list [nx, ny, nz]

getRayDirection()

 

DEPRECATED: Use the rayDirection property instead. Returns the direction from the ray (in worldcoordinates)

Returns: list [dx, dy, dz]

Instance Variable Details

hitNormal

The normal (in worldcoordinates) of the object at the location where the object was hit by the ray. (Read-only)
Type:
list [x, y, z]

hitObject

The game object that was hit by the ray. (Read-only)
Type:
KX_GameObject

hitPosition

The position (in worldcoordinates) where the object was hit by the ray. (Read-only)
Type:
list [x, y, z]

rayDirection

The direction from the ray (in worldcoordinates). (Read-only)
Type:
list [x, y, z]