merge with 2.5 at r18679
[blender.git] / source / gameengine / PyDoc / SCA_ILogicBrick.py
1 # $Id$
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         @ivar executePriority: This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).
10         @type executePriority: int
11         """
12         
13         def getOwner():
14                 """
15                 Gets the game object associated with this logic brick.
16                 
17                 @rtype: L{KX_GameObject}
18                 """
19
20         #--The following methods are deprecated--
21         def setExecutePriority(priority):
22                 """
23                 Sets the priority of this logic brick.
24                 
25                 This determines the order controllers are evaluated, and actuators are activated.
26                 Bricks with lower priority will be executed first.
27                 
28                 Deprecated: Use the "executePriority" property instead.
29                 
30                 @type priority: integer
31                 @param priority: the priority of this logic brick.
32                 """
33         def getExecutePriority():
34                 """
35                 Gets the execution priority of this logic brick.
36                 
37                 Deprecated: Use the "executePriority" property instead.
38                 
39                 @rtype: integer
40                 @return: this logic bricks current priority.
41                 """