← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/blender/gutsy-security

« back to all changes in this revision

Viewing changes to source/gameengine/PyDoc/SCA_PythonController.py

  • Committer: Bazaar Package Importer
  • Author(s): Florian Ernst
  • Date: 2005-11-06 12:40:03 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20051106124003-3pgs7tcg5rox96xg
Tags: 2.37a-1.1
http://bugs.debian.org/333958
* Non-maintainer upload.
* Split out parts of 01_SConstruct_debian.dpatch again: root_build_dir
  really needs to get adjusted before the clean target runs - closes: #333958,
  see #288882 for reference

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/gameengine/PyDoc/SCA_PythonController.py
 
1
# $Id: SCA_PythonController.py,v 1.3 2004/06/02 12:43:27 kester Exp $
 
2
# Documentation for SCA_PythonController
 
3
from SCA_IController import *
 
4
 
 
5
class SCA_PythonController(SCA_IController):
 
6
        """
 
7
        A Python controller uses a Python script to activate it's actuators,
 
8
        based on it's sensors.
 
9
        """
 
10
 
 
11
        def getSensors():
 
12
                """
 
13
                Gets a list of all sensors attached to this controller.
 
14
                
 
15
                @rtype: list [L{SCA_ISensor}]
 
16
                """
 
17
        def getSensor(name):
 
18
                """
 
19
                Gets the named linked sensor.
 
20
                
 
21
                @type name: string
 
22
                @rtype: L{SCA_ISensor}
 
23
                """
 
24
        def getActuators():
 
25
                """
 
26
                Gets a list of all actuators linked to this controller.
 
27
                
 
28
                @rtype: list [L{SCA_IActuator}]
 
29
                """
 
30
        def getActuator(name):
 
31
                """
 
32
                Gets the named linked actuator.
 
33
                
 
34
                @type name: string
 
35
                @rtype: L{SCA_IActuator}
 
36
                """
 
37
        def getScript():
 
38
                """
 
39
                Gets the Python script this controller executes.
 
40
                
 
41
                @rtype: string
 
42
                """
 
43
        def setScript(script):
 
44
                """
 
45
                Sets the Python script this controller executes.
 
46
                
 
47
                @type script: string.
 
48
                """
 
49