Game Python Reference Manual.
[blender.git] / source / gameengine / PyDoc / KX_TouchSensor.py
1 # Documentation for KX_TouchSensor
2 from SCA_ISensor import *
3
4 class KX_TouchSensor(SCA_ISensor):
5         """
6         Touch sensor detects collisions between objects.
7         """
8         def setProperty(name):
9                 """
10                 Set the property or material to collide with. Use
11                 setTouchMaterial() to switch between properties and
12                 materials.
13                 @type name: string
14                 """
15         def getProperty():
16                 """
17                 Returns the property or material to collide with. Use
18                 getTouchMaterial() to find out whether this sensor
19                 looks for properties or materials.
20                 
21                 @rtype: string
22                 """
23
24         def getHitObject():
25                 """
26                 Returns the last object hit by this touch sensor.
27                 
28                 @rtype: KX_GameObject
29                 """
30         def getHitObjectList():
31                 """
32                 Returns a list of all objects hit in the last frame.
33                 
34                 Only objects that have the requisite material/property are listed.
35                 
36                 @rtype: list [KX_GameObject]
37                 """
38         def getTouchMaterial():
39                 """
40                 Returns KX_TRUE if this sensor looks for a specific material,
41                 KX_FALSE if it looks for a specific property.
42                 """
43         def setTouchMaterial(flag):
44                 """
45                 Set flag to KX_TRUE to switch on positive pulse mode,
46                 KX_FALSE to switch off positive pulse mode.
47                 
48                 @type flag: KX_TRUE or KX_FALSE.
49                 """