Game Python Reference Manual.
[blender.git] / source / gameengine / PyDoc / SCA_ISensor.py
1 # Documentation for SCA_ISensor
2 from SCA_ILogicBrick import *
3
4 class SCA_ISensor(SCA_ILogicBrick):
5         """
6         Base class for all sensor logic bricks.
7         """
8         
9         def isPositive():
10                 """
11                 True if this sensor brick has been activated.
12                 """
13         
14         def getUsePosPulseMode():
15                 """
16                 True if the sensor is in positive pulse mode.
17                 """
18         def setUsePosPulseMode(pulse):
19                 """
20                 Sets positive pulse mode.
21                 
22                 @type pulse: boolean
23                 @param pulse: If True, will activate positive pulse mode for this sensor.
24                 """
25         def getFrequency():
26                 """
27                 The frequency for pulse mode sensors.
28                 
29                 @rtype integer
30                 @return the pulse frequency in 1/50 sec.
31                 """
32         def setFrequency(freq):
33                 """
34                 Sets the frequency for pulse mode sensors.
35                 
36                 @type freq: integer
37                 @return the pulse frequency in 1/50 sec.
38                 """
39         def getUseNegPulseMode():
40                 """
41                 True if the sensor is in negative pulse mode.
42                 """
43         def setUseNegPulseMode(pulse):
44                 """
45                 Sets negative pulse mode.
46                 
47                 @type pulse: boolean
48                 @param pulse: If True, will activate negative pulse mode for this sensor.
49                 """
50         def getInvert():
51                 """
52                 True if this sensor activates on negative events.
53                 """
54         def setInvert(invert):
55                 """
56                 Sets if this sensor activates on positive or negative events.
57                 
58                 @type invert: boolean
59                 @param invert: true if activates on negative events; false if activates on positive events.
60                 """
61