BGE API cleanup: action actuator.
[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 1.0.
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                 Sets the current action.
54                 
55                 @param action: The name of the action to set as the current action.
56                 @type action: string
57                 @param reset: Optional parameter indicating whether to reset the
58                               blend timer or not.  A value of 1 indicates that the
59                               timer should be reset.  A value of 0 will leave it
60                               unchanged.  If reset is not specified, the timer will
61                               be reset.
62                 """
63
64         def setStart(start):
65                 """
66                 Specifies the starting frame of the animation.
67                 
68                 @param start: the starting frame of the animation
69                 @type start: float
70                 """
71
72         def setEnd(end):
73                 """
74                 Specifies the ending frame of the animation.
75                 
76                 @param end: the ending frame of the animation
77                 @type end: float
78                 """
79         def setBlendin(blendin):
80                 """
81                 Specifies the number of frames of animation to generate
82                 when making transitions between actions.
83                 
84                 @param blendin: the number of frames in transition.
85                 @type blendin: float
86                 """
87
88         def setPriority(priority):
89                 """
90                 Sets the priority of this actuator.
91                 
92                 @param priority: Specifies the new priority.  Actuators will lower
93                                  priority numbers will override actuators with higher
94                                  numbers.
95                 @type priority: integer
96                 """
97         def setFrame(frame):
98                 """
99                 Sets the current frame for the animation.
100                 
101                 @param frame: Specifies the new current frame for the animation
102                 @type frame: float
103                 """
104
105         def setProperty(prop):
106                 """
107                 Sets the property to be used in FromProp playback mode.
108                 
109                 @param prop: the name of the property to use.
110                 @type prop: string.
111                 """
112
113         def setBlendtime(blendtime):
114                 """
115                 Sets the internal frame timer.
116                  
117                 Allows the script to directly modify the internal timer
118                 used when generating transitions between actions.  
119                 
120                 @param blendtime: The new time. This parameter must be in the range from 0.0 to 1.0.
121                 @type blendtime: float
122                 """
123
124         def setType(mode):
125                 """
126                 Sets the operation mode of the actuator
127
128                 @param mode: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
129                 @type mode: integer
130                 """
131         
132         def setContinue(cont):
133                 """
134                 Set the actions continue option True or False. see getContinue.
135
136                 @param cont: The continue option.
137                 @type cont: bool
138                 """
139
140         def getType():
141                 """
142                 Returns the operation mode of the actuator
143             
144                 @rtype: integer
145                 @return: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
146                 """
147
148         def getContinue():
149                 """
150                 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.
151             
152                 @rtype: bool
153                 """
154         
155         def getAction():
156                 """
157                 getAction() returns the name of the action associated with this actuator.
158                 
159                 @rtype: string
160                 """
161         
162         def getStart():
163                 """
164                 Returns the starting frame of the action.
165                 
166                 @rtype: float
167                 """
168         def getEnd():
169                 """
170                 Returns the last frame of the action.
171                 
172                 @rtype: float
173                 """
174         def getBlendin():
175                 """
176                 Returns the number of interpolation animation frames to be generated when this actuator is triggered.
177                 
178                 @rtype: float
179                 """
180         def getPriority():
181                 """
182                 Returns the priority for this actuator.  Actuators with lower Priority numbers will
183                 override actuators with higher numbers.
184                 
185                 @rtype: integer
186                 """
187         def getFrame():
188                 """
189                 Returns the current frame number.
190                 
191                 @rtype: float
192                 """
193         def getProperty():
194                 """
195                 Returns the name of the property to be used in FromProp mode.
196                 
197                 @rtype: string
198                 """
199         def setFrameProperty(prop):
200                 """
201                 @param prop: A string specifying the property of the object that will be updated with the action frame number.
202                 @type prop: string
203                 """
204         def getFrameProperty():
205                 """
206                 Returns the name of the property that is set to the current frame number.
207                 
208                 @rtype: string
209                 """