blob: 22de8d8b986d73a5f98ee78426f81227fa196661 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
# $Id$
# Documentation for SCA_PropertySensor
from SCA_ISensor import *
class SCA_PropertySensor(SCA_ISensor):
"""
Activates when the game object property matches.
"""
def getType():
"""
Gets when to activate this sensor.
@return: KX_PROPSENSOR_EQUAL, KX_PROPSENSOR_NOTEQUAL,
KX_PROPSENSOR_INTERVAL, KX_PROPSENSOR_CHANGED,
or KX_PROPSENSOR_EXPRESSION.
"""
def setType(checktype):
"""
Set the type of check to perform.
@type checktype: KX_PROPSENSOR_EQUAL, KX_PROPSENSOR_NOTEQUAL,
KX_PROPSENSOR_INTERVAL, KX_PROPSENSOR_CHANGED,
or KX_PROPSENSOR_EXPRESSION.
"""
def getProperty():
"""
Return the property with which the sensor operates.
@rtype: string
@return: the name of the property this sensor is watching.
"""
def setProperty(name):
"""
Sets the property with which to operate. If there is no property
of that name, this call is ignored.
@type name: string.
"""
def getValue():
"""
Return the value with which the sensor compares to the value of the property.
@rtype: string
@return: the value of the property this sensor is watching.
"""
def setValue(value):
"""
Set the value with which the sensor operates. If the value
is not compatible with the type of the property, the subsequent
action is ignored.
@type value: string
"""
|
