Module KX_TouchSensor :: Class KX_TouchSensor

Class KX_TouchSensor

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
            SCA_ISensor.SCA_ISensor --+
                                      |
                                     KX_TouchSensor
Known Subclasses:

Touch sensor detects collisions between objects.

Instance Methods
 
setProperty(name)
DEPRECATED: use the property property Set the property or material to collide with.
string
getProperty()
DEPRECATED: use the property property Returns the property or material to collide with.
KX_GameObject
getHitObject()
DEPRECATED: use the objectHit property Returns the last object hit by this touch sensor.
CListValue of KX_GameObject
getHitObjectList()
DEPRECATED: use the objectHitList property Returns a list of all objects hit in the last frame.
 
getTouchMaterial()
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.
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 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)
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 objectHit
The last collided object.
CListValue of KX_GameObject objectHitList
A list of colliding objects.
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 or material to collide with.
bool pulseCollisions
The last collided object.
boolean triggered
True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor)
boolean useMaterial
Determines if the sensor is looking for a property or material.
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)
Method Details

setProperty(name)

 

DEPRECATED: use the property property Set the property or material to collide with. Use setTouchMaterial() to switch between properties and materials.

Parameters:
  • name (string)

getProperty()

 

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. (deprecated)

Returns: string

getHitObject()

 

DEPRECATED: use the objectHit property Returns the last object hit by this touch sensor. (deprecated)

Returns: KX_GameObject

getHitObjectList()

 

DEPRECATED: use the objectHitList property Returns a list of all objects hit in the last frame. (deprecated)

Only objects that have the requisite material/property are listed.

Returns: CListValue of KX_GameObject

getTouchMaterial()

 

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. (deprecated)


Instance Variable Details

objectHit

The last collided object. (Read Only)
Type:
KX_GameObject or None

objectHitList

A list of colliding objects. (Read Only)
Type:
CListValue of KX_GameObject

useMaterial

Determines if the sensor is looking for a property or material. KX_True = Find material; KX_False = Find property
Type:
boolean