← Back to branch summary

~diresu/blender/blender-command-port

« back to all changes in this revision

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

  • Committer: theeth
  • Date: 2008-10-14 16:52:04 UTC
  • Revision ID: vcs-imports@canonical.com-20081014165204-r32w2gm6s0osvdhn
copy back trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/gameengine/PyDoc/SCA_ILogicBrick.py
 
1
# $Id: SCA_ILogicBrick.py 15444 2008-07-05 17:05:05Z lukep $
 
2
# Documentation for the logic brick base class SCA_ILogicBrick
 
3
from KX_GameObject import *
 
4
 
 
5
class SCA_ILogicBrick:
 
6
        """
 
7
        Base class for all logic bricks.
 
8
        """
 
9
        
 
10
        def getOwner():
 
11
                """
 
12
                Gets the game object associated with this logic brick.
 
13
                
 
14
                @rtype: L{KX_GameObject}
 
15
                """
 
16
        def setExecutePriority(priority):
 
17
                """
 
18
                Sets the priority of this logic brick.
 
19
                
 
20
                This determines the order controllers are evaluated, and actuators are activated.
 
21
                Bricks with lower priority will be executed first.
 
22
                
 
23
                @type priority: integer
 
24
                @param priority: the priority of this logic brick.
 
25
                """
 
26
        def getExecutePriority():
 
27
                """
 
28
                Gets the execution priority of this logic brick.
 
29
                
 
30
                @rtype: integer
 
31
                @return: this logic bricks current priority.
 
32
                """