3e95befe16b8fc7849e1c6ee2b929b895dc9cde8
[blender.git] / source / gameengine / PyDoc / BL_ActionActuator.py
1 # $Id$
2 # Documentation for BL_ActionActuator
3 from SCA_IActuator import *
4
5 class BL_ActionActuator(SCA_IActuator):
6         """
7         Action Actuators apply an action to an actor.
8         
9         @ivar action: The name of the action to set as the current action.
10         @type action: string
11         @ivar start: Specifies the starting frame of the animation.
12         @type start: float
13         @type end: Specifies the ending frame of the animation.
14         @type end: float
15         @ivar blendin: Specifies the number of frames of animation to generate when making transitions between actions.
16         @type blendin: float
17         @ivar priority: Sets the priority of this actuator. Actuators will lower
18                                  priority numbers will override actuators with higher
19                                  numbers.
20         @type priority: integer
21         @ivar frame: Sets the current frame for the animation.
22         @type frame: float
23         @ivar property: Sets the property to be used in FromProp playback mode.
24         @type property: string
25         @ivar blendTime: Sets the internal frame timer. This property must be in
26                                                 the range from 0.0 to blendin.
27         @type blendTime: float
28         @ivar type: The operation mode of the actuator.
29                                         KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER,
30                                         KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
31         @type type: integer
32         @ivar continue: The actions continue option, True or False.
33                                         When True, the action will always play from where last left off,
34                                         otherwise negative events to this actuator will reset it to its start frame.
35         @type: boolean
36         @ivar frameProperty: The name of the property that is set to the current frame number.
37         @type frameProperty: string
38         """
39         def setChannel(channel, matrix, mode = False):
40                 """
41                 @param channel: A string specifying the name of the bone channel.
42                 @type channel: string
43                 @param matrix: A 4x4 matrix specifying the overriding transformation
44                                as an offset from the bone's rest position.
45                 @type matrix: list [[float]]
46                 @param mode: True for armature/world space, False for bone space
47                 @type mode: boolean
48                 """
49
50         #--The following methods are deprecated--
51         def setAction(action, reset = True):
52                 """
53                 DEPRECATED: use the 'action' property
54                 Sets the current action.
55                 
56                 @param action: The name of the action to set as the current action.
57                 @type action: string
58                 @param reset: Optional parameter indicating whether to reset the
59                               blend timer or not.  A value of 1 indicates that the
60                               timer should be reset.  A value of 0 will leave it
61                               unchanged.  If reset is not specified, the timer will
62                               be reset.
63                 """
64
65         def setStart(start):
66                 """
67                 DEPRECATED: use the 'start' property
68                 Specifies the starting frame of the animation.
69                 
70                 @param start: the starting frame of the animation
71                 @type start: float
72                 """
73
74         def setEnd(end):
75                 """
76                 DEPRECATED: use the 'end' property
77                 Specifies the ending frame of the animation.
78                 
79                 @param end: the ending frame of the animation
80                 @type end: float
81                 """
82         def setBlendin(blendin):
83                 """
84                 DEPRECATED: use the 'blendin' property
85                 Specifies the number of frames of animation to generate
86                 when making transitions between actions.
87                 
88                 @param blendin: the number of frames in transition.
89                 @type blendin: float
90                 """
91
92         def setPriority(priority):
93                 """
94                 DEPRECATED: use the 'priority' property
95                 Sets the priority of this actuator.
96                 
97                 @param priority: Specifies the new priority.  Actuators will lower
98                                  priority numbers will override actuators with higher
99                                  numbers.
100                 @type priority: integer
101                 """
102         def setFrame(frame):
103                 """
104                 DEPRECATED: use the 'frame' property
105                 Sets the current frame for the animation.
106                 
107                 @param frame: Specifies the new current frame for the animation
108                 @type frame: float
109                 """
110
111         def setProperty(prop):
112                 """
113                 DEPRECATED: use the 'property' property
114                 Sets the property to be used in FromProp playback mode.
115                 
116                 @param prop: the name of the property to use.
117                 @type prop: string.
118                 """
119
120         def setBlendtime(blendtime):
121                 """
122                 DEPRECATED: use the 'blendTime' property
123                 Sets the internal frame timer.
124                  
125                 Allows the script to directly modify the internal timer
126                 used when generating transitions between actions.  
127                 
128                 @param blendtime: The new time. This parameter must be in the range from 0.0 to 1.0.
129                 @type blendtime: float
130                 """
131
132         def setType(mode):
133                 """
134                 DEPRECATED: use the 'type' property
135                 Sets the operation mode of the actuator
136
137                 @param mode: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
138                 @type mode: integer
139                 """
140         
141         def setContinue(cont):
142                 """
143                 DEPRECATED: use the 'continue' property
144                 Set the actions continue option True or False. see getContinue.
145
146                 @param cont: The continue option.
147                 @type cont: bool
148                 """
149
150         def getType():
151                 """
152                 DEPRECATED: use the 'type' property
153                 Returns the operation mode of the actuator
154             
155                 @rtype: integer
156                 @return: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
157                 """
158
159         def getContinue():
160                 """
161                 DEPRECATED: use the 'continue' property
162                 When True, the action will always play from where last left off, otherwise negative events to this actuator will reset it to its start frame.
163             
164                 @rtype: bool
165                 """
166         
167         def getAction():
168                 """
169                 DEPRECATED: use the 'action' property
170                 getAction() returns the name of the action associated with this actuator.
171                 
172                 @rtype: string
173                 """
174         
175         def getStart():
176                 """
177                 DEPRECATED: use the 'start' property
178                 Returns the starting frame of the action.
179                 
180                 @rtype: float
181                 """
182         def getEnd():
183                 """
184                 DEPRECATED: use the 'end' property
185                 Returns the last frame of the action.
186                 
187                 @rtype: float
188                 """
189         def getBlendin():
190                 """
191                 DEPRECATED: use the 'blendin' property
192                 Returns the number of interpolation animation frames to be generated when this actuator is triggered.
193                 
194                 @rtype: float
195                 """
196         def getPriority():
197                 """
198                 DEPRECATED: use the 'priority' property
199                 Returns the priority for this actuator.  Actuators with lower Priority numbers will
200                 override actuators with higher numbers.
201                 
202                 @rtype: integer
203                 """
204         def getFrame():
205                 """
206                 DEPRECATED: use the 'frame' property
207                 Returns the current frame number.
208                 
209                 @rtype: float
210                 """
211         def getProperty():
212                 """
213                 DEPRECATED: use the 'property' property
214                 Returns the name of the property to be used in FromProp mode.
215                 
216                 @rtype: string
217                 """
218         def setFrameProperty(prop):
219                 """
220                 DEPRECATED: use the 'frameProperty' property
221                 @param prop: A string specifying the property of the object that will be updated with the action frame number.
222                 @type prop: string
223                 """
224         def getFrameProperty():
225                 """
226                 DEPRECATED: use the 'frameProperty' property
227                 Returns the name of the property that is set to the current frame number.
228                 
229                 @rtype: string
230                 """