blob: cfb4c18a826674dcfb4737600e13056e3130eaa4 (
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
58
59
60
61
62
63
|
# $Id$
# Documentation for KX_CameraActuator
from SCA_ILogicBrick import *
class SCA_IController(SCA_ILogicBrick):
"""
Base class for all controller logic bricks.
@ivar state: the controllers state bitmask.
This can be used with the GameObject's state to test if the controller is active.
@type state: int bitmask
@ivar sensors: a list of sensors linked to this controller
- note: the sensors are not necessarily owned by the same object.
- note: when objects are instanced in dupligroups links may be lost from objects outside the dupligroup.
@type sensors: sequence supporting index/string lookups and iteration.
@ivar actuators: a list of actuators linked to this controller.
- note: the sensors are not necessarily owned by the same object.
- note: when objects are instanced in dupligroups links may be lost from objects outside the dupligroup.
@type actuators: sequence supporting index/string lookups and iteration.
@group Deprecated: getState, getSensors, getActuators, getSensor, getActuator
"""
def getState():
"""
DEPRECATED: use the state property
Get the controllers state bitmask, this can be used with the GameObject's state to test if the the controller is active.
This for instance will always be true however you could compare with a previous state to see when the state was activated.
GameLogic.getCurrentController().getState() & GameLogic.getCurrentController().getOwner().getState()
@rtype: int
"""
def getSensors():
"""
DEPRECATED: use the sensors property
Gets a list of all sensors attached to this controller.
@rtype: list [L{SCA_ISensor}]
"""
def getSensor(name):
"""
DEPRECATED: use the sensors[name] property
Gets the named linked sensor.
@type name: string
@rtype: L{SCA_ISensor}
"""
def getActuators():
"""
DEPRECATED: use the actuators property
Gets a list of all actuators linked to this controller.
@rtype: list [L{SCA_IActuator}]
"""
def getActuator(name):
"""
DEPRECATED: use the actuators[name] property
Gets the named linked actuator.
@type name: string
@rtype: L{SCA_IActuator}
"""
|
