* blender doesn't need the -w anymore to start in a window
[blender.git] / source / gameengine / PyDoc / KX_TouchSensor.py
1 # $Id$
2 # Documentation for KX_TouchSensor
3 from SCA_ISensor import *
4 from KX_GameObject import *
5
6 class KX_TouchSensor(SCA_ISensor):
7         """
8         Touch sensor detects collisions between objects.
9         
10         @ivar propertyName: The name of the property or material this sensor detects (depending on the materialCheck property).
11         @type propertyName: string
12         @ivar materialCheck: when enabled this sensor checks for object materials rather then properties.
13         @type materialCheck: bool
14         @ivar pulseCollisions: The last collided object.
15         @type pulseCollisions: bool
16         @ivar objectHit: The last collided object. (Read Only)
17         @type objectHit: L{KX_GameObject} or None
18         @ivar objectHitList: A list of colliding objects. (Read Only)
19         @type objectHitList: list
20         """
21         def setProperty(name):
22                 """
23                 DEPRECATED: use the propertyName property
24                 Set the property or material to collide with. Use
25                 setTouchMaterial() to switch between properties and
26                 materials.
27                 @type name: string
28                 """
29         def getProperty():
30                 """
31                 DEPRECATED: use the propertyName property
32                 Returns the property or material to collide with. Use
33                 getTouchMaterial() to find out whether this sensor
34                 looks for properties or materials. (B{deprecated})
35                 
36                 @rtype: string
37                 """
38
39         def getHitObject():
40                 """
41                 DEPRECATED: use the objectHit property
42                 Returns the last object hit by this touch sensor. (B{deprecated})
43                 
44                 @rtype: L{KX_GameObject}
45                 """
46         def getHitObjectList():
47                 """
48                 DEPRECATED: use the objectHitList property
49                 Returns a list of all objects hit in the last frame. (B{deprecated})
50                 
51                 Only objects that have the requisite material/property are listed.
52                 
53                 @rtype: list [L{KX_GameObject}]
54                 """
55         def getTouchMaterial():
56                 """
57                 DEPRECATED: use the materialCheck property
58                 Returns KX_TRUE if this sensor looks for a specific material,
59                 KX_FALSE if it looks for a specific property. (B{deprecated})
60                 """