forked from bartvdbraak/blender
1c663bbc7e
The principle is to replace most get/set methods of logic bricks by direct property access. To make porting of game code easier, the properties have usually the same type and use than the return values/parameters of the get/set methods. More details on http://wiki.blender.org/index.php/GameEngineDev/Python_API_Clean_Up Old methods are still available but will produce deprecation warnings on the console: "<method> is deprecated, use the <property> property instead" You can avoid these messages by turning on the "Ignore deprecation warnings" option in Game menu. PyDoc is updated to include the new properties and display a deprecation warning for the get/set methods that are being deprecated.
68 lines
1.6 KiB
Python
68 lines
1.6 KiB
Python
# $Id$
|
|
# Documentation for SCA_PythonController
|
|
from SCA_IController import *
|
|
|
|
class SCA_PythonController(SCA_IController):
|
|
"""
|
|
A Python controller uses a Python script to activate it's actuators,
|
|
based on it's sensors.
|
|
|
|
Properties:
|
|
|
|
@ivar script: the Python script this controller executes
|
|
@type script: string, read-only
|
|
@ivar state: the controllers state bitmask.
|
|
This can be used with the GameObject's state to test if the controller is active.
|
|
@type state: integer
|
|
"""
|
|
|
|
def getSensors():
|
|
"""
|
|
Gets a list of all sensors attached to this controller.
|
|
|
|
@rtype: list [L{SCA_ISensor}]
|
|
"""
|
|
def getSensor(name):
|
|
"""
|
|
Gets the named linked sensor.
|
|
|
|
@type name: string
|
|
@rtype: L{SCA_ISensor}
|
|
"""
|
|
def getActuators():
|
|
"""
|
|
Gets a list of all actuators linked to this controller.
|
|
|
|
@rtype: list [L{SCA_IActuator}]
|
|
"""
|
|
def getActuator(name):
|
|
"""
|
|
Gets the named linked actuator.
|
|
|
|
@type name: string
|
|
@rtype: L{SCA_IActuator}
|
|
"""
|
|
def getScript():
|
|
"""
|
|
DEPRECATED: use the script property
|
|
Gets the Python script this controller executes.
|
|
|
|
@rtype: string
|
|
"""
|
|
def setScript(script):
|
|
"""
|
|
Sets the Python script this controller executes.
|
|
|
|
@type script: string.
|
|
"""
|
|
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
|
|
"""
|
|
|