Module GameTypes :: Class KX_TouchSensor
[frames] | no frames]

Class KX_TouchSensor

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
             SCA_ISensor --+
                           |
                          KX_TouchSensor
Known Subclasses:

Touch sensor detects collisions between objects.

Instance Methods
bool
isA(game_type)
Check if this is a type or a subtype game_type. (Inherited from GameTypes.PyObjectPlus)
 
reset()
Reset sensor internal state, effect depends on the type of sensor and settings. (Inherited from GameTypes.SCA_ISensor)
    Deprecated
 
setProperty(name)
Set the property or material to collide with.
string
getProperty()
Returns the property or material to collide with.
KX_GameObject
getHitObject()
Returns the last object hit by this touch sensor.
CListValue of hitObjectList
getHitObjectList()
Returns a list of all objects hit in the last frame.
 
getTouchMaterial()
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 GameTypes.SCA_ILogicBrick)
integer
getFrequency()
The frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)
 
getInvert()
True if this sensor activates on negative events. (Inherited from GameTypes.SCA_ISensor)
boolean
getLevel()
Returns whether this sensor is a level detector or a edge detector. (Inherited from GameTypes.SCA_ISensor)
string
getName()
Returns the name of the CValue. (Inherited from GameTypes.CValue)
KX_GameObject
getOwner()
Gets the game object associated with this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)
 
getUseNegPulseMode()
True if the sensor is in negative pulse mode. (Inherited from GameTypes.SCA_ISensor)
 
getUsePosPulseMode()
True if the sensor is in positive pulse mode. (Inherited from GameTypes.SCA_ISensor)
 
isPositive()
True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)
 
isTriggered()
True if this sensor brick has triggered the current controller. (Inherited from GameTypes.SCA_ISensor)
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)
 
setFrequency(freq)
Sets the frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)
 
setInvert(invert)
Sets if this sensor activates on positive or negative events. (Inherited from GameTypes.SCA_ISensor)
 
setLevel(level)
Set whether to detect level or edge transition when entering a state. (Inherited from GameTypes.SCA_ISensor)
 
setUseNegPulseMode(pulse)
Sets negative pulse mode. (Inherited from GameTypes.SCA_ISensor)
 
setUsePosPulseMode(pulse)
Sets positive pulse mode. (Inherited from GameTypes.SCA_ISensor)
Instance Variables
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from GameTypes.SCA_ILogicBrick)
int frequency
The frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)
KX_GameObject or None hitObject
The last collided object.
CListValue of KX_GameObject hitObjectList
A list of colliding objects.
bool invalid
Test if the object has been freed by the game engine and is no longer valid. (Inherited from GameTypes.PyObjectPlus)
boolean invert
Flag to set if this sensor activates on positive or negative events. (Inherited from GameTypes.SCA_ISensor)
boolean level
Option whether to detect level or edge transition when entering a state. (Inherited from GameTypes.SCA_ISensor)
string name
The name of this CValue derived object (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
boolean positive
True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)
string propName
The property or material to collide with.
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. (Inherited from GameTypes.SCA_ISensor)
boolean triggered
True if this sensor brick is in a positive state. (Inherited from GameTypes.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 GameTypes.SCA_ISensor)
boolean usePosPulseMode
Flag to turn positive pulse mode on and off. (Inherited from GameTypes.SCA_ISensor)
bool usePulseCollision
When enabled, changes to the set of colliding objects generate a pulse.
Method Details

setProperty(name)

 

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

Parameters:
  • name (string)

Deprecated: use the property property

getProperty()

 

Returns the property or material to collide with. Use getTouchMaterial() to find out whether this sensor looks for properties or materials.

Returns: string

Deprecated: use the property property

getHitObject()

 

Returns the last object hit by this touch sensor.

Returns: KX_GameObject

Deprecated: use the hitObject property

getHitObjectList()

 

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 hitObjectList

Deprecated: use the hitObjectList property

getTouchMaterial()

 

Returns KX_TRUE if this sensor looks for a specific material, KX_FALSE if it looks for a specific property. (deprecated)

Deprecated: use the useMaterial property


Instance Variable Details

hitObject

The last collided object. (read-only)
Type:
KX_GameObject or None

hitObjectList

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