Module GameTypes :: Class KX_RaySensor
[hide private]
[frames] | no frames]

Class KX_RaySensor

source code

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
             SCA_ISensor --+
                           |
                          KX_RaySensor

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

Instance Methods [hide private]
    Deprecated
KX_GameObject
getHitObject()
Returns the game object that was hit by this ray.
source code
list [x, y, z]
getHitPosition()
Returns the position (in worldcoordinates) where the object was hit by this ray.
source code
list [nx, ny, nz]
getHitNormal()
Returns the normal (in worldcoordinates) of the object at the location where the object was hit by this ray.
source code
list [dx, dy, dz]
getRayDirection()
Returns the direction from the ray (in worldcoordinates)
source code
    Inherited from SCA_ISensor
 
reset()
Reset sensor internal state, effect depends on the type of sensor and settings.
source code
integer
getFrequency()
The frequency for pulse mode sensors.
source code
 
getInvert()
True if this sensor activates on negative events.
source code
boolean
getLevel()
Returns whether this sensor is a level detector or a edge detector.
source code
 
getUseNegPulseMode()
True if the sensor is in negative pulse mode.
source code
 
getUsePosPulseMode()
True if the sensor is in positive pulse mode.
source code
 
isPositive()
True if this sensor brick is in a positive state.
source code
 
isTriggered()
True if this sensor brick has triggered the current controller.
source code
 
setFrequency(freq)
Sets the frequency for pulse mode sensors.
source code
 
setInvert(invert)
Sets if this sensor activates on positive or negative events.
source code
 
setLevel(level)
Set whether to detect level or edge transition when entering a state.
source code
 
setUseNegPulseMode(pulse)
Sets negative pulse mode.
source code
 
setUsePosPulseMode(pulse)
Sets positive pulse mode.
source code
    Inherited from SCA_ILogicBrick
integer
getExecutePriority()
Gets the execution priority of this logic brick.
source code
KX_GameObject
getOwner()
Gets the game object associated with this logic brick.
source code
 
setExecutePriority(priority)
Sets the priority of this logic brick.
source code
    Inherited from CValue
string
getName()
Returns the name of the CValue.
source code
    Inherited from PyObjectPlus
bool
isA(game_type)
Check if this is a type or a subtype game_type.
source code
Instance Variables [hide private]
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.
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.
string propName
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 useMaterial
Whether or not to look for a material (false = property)
boolean useXRay
Whether or not to use XRay.
    Inherited from SCA_ISensor
int frequency
The frequency for pulse mode sensors.
boolean invert
Flag to set if this sensor activates on positive or negative events.
boolean level
Option whether to detect level or edge transition when entering a state.
boolean positive
True if this sensor brick is in a positive state.
boolean tap
When enabled only sensors that are just activated will send a positive event, after this they will be detected as negative by the controllers.
boolean triggered
True if this sensor brick is in a positive state.
boolean useNegPulseMode
Flag to turn negative pulse mode on and off.
boolean usePosPulseMode
Flag to turn positive pulse mode on and off.
    Inherited from SCA_ILogicBrick
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).
string name
The name of this CValue derived object (read-only).
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read-only).
    Inherited from PyObjectPlus
bool invalid
Test if the object has been freed by the game engine and is no longer valid.
Method Details [hide private]

getHitObject()

source code 
Returns the game object that was hit by this ray.
Returns: KX_GameObject

Deprecated: Use the hitObject attribute instead.

getHitPosition()

source code 
Returns the position (in worldcoordinates) where the object was hit by this ray.
Returns: list [x, y, z]

Deprecated: Use the hitPosition attribute instead.

getHitNormal()

source code 
Returns the normal (in worldcoordinates) of the object at the location where the object was hit by this ray.
Returns: list [nx, ny, nz]

Deprecated: Use the hitNormal attribute instead.

getRayDirection()

source code 
Returns the direction from the ray (in worldcoordinates)
Returns: list [dx, dy, dz]

Deprecated: Use the rayDirection attribute instead.


Instance Variable Details [hide private]

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]