BGE API cleanup: shape action actuator.
[blender.git] / source / gameengine / PyDoc / BL_ShapeActionActuator.py
1 # $Id$
2 # Documentation for BL_ShapeActionActuator
3 from SCA_IActuator import *
4
5 class BL_ShapeActionActuator(SCA_IActuator):
6         """
7         ShapeAction Actuators apply an shape action to an mesh object.\
8
9         @ivar action: The name of the action to set as the current shape action.
10         @type action: string
11         @ivar start: Specifies the starting frame of the shape animation.
12         @type start: float
13         @type end: Specifies the ending frame of the shape 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 frameProperty: The name of the property that is set to the current frame number.
33         @type frameProperty: string
34         
35         """
36         def setAction(action, reset = True):
37                 """
38                 DEPRECATED: use the 'action' property
39                 Sets the current action.
40                 
41                 @param action: The name of the action to set as the current action.
42                 @type action: string
43                 @param reset: Optional parameter indicating whether to reset the
44                               blend timer or not.  A value of 1 indicates that the
45                               timer should be reset.  A value of 0 will leave it
46                               unchanged.  If reset is not specified, the timer will
47                               be reset.
48                 """
49
50         def setStart(start):
51                 """
52                 DEPRECATED: use the 'start' property
53                 Specifies the starting frame of the animation.
54                 
55                 @param start: the starting frame of the animation
56                 @type start: float
57                 """
58
59         def setEnd(end):
60                 """
61                 DEPRECATED: use the 'end' property
62                 Specifies the ending frame of the animation.
63                 
64                 @param end: the ending frame of the animation
65                 @type end: float
66                 """
67         def setBlendin(blendin):
68                 """
69                 DEPRECATED: use the 'blendin' property
70                 Specifies the number of frames of animation to generate
71                 when making transitions between actions.
72                 
73                 @param blendin: the number of frames in transition.
74                 @type blendin: float
75                 """
76
77         def setPriority(priority):
78                 """
79                 DEPRECATED: use the 'priority' property
80                 Sets the priority of this actuator.
81                 
82                 @param priority: Specifies the new priority.  Actuators will lower
83                                  priority numbers will override actuators with higher
84                                  numbers.
85                 @type priority: integer
86                 """
87         def setFrame(frame):
88                 """
89                 DEPRECATED: use the 'frame' property
90                 Sets the current frame for the animation.
91                 
92                 @param frame: Specifies the new current frame for the animation
93                 @type frame: float
94                 """
95
96         def setProperty(prop):
97                 """
98                 DEPRECATED: use the 'property' property
99                 Sets the property to be used in FromProp playback mode.
100                 
101                 @param prop: the name of the property to use.
102                 @type prop: string.
103                 """
104
105         def setBlendtime(blendtime):
106                 """
107                 DEPRECATED: use the 'blendTime' property
108                 Sets the internal frame timer.
109                  
110                 Allows the script to directly modify the internal timer
111                 used when generating transitions between actions.  
112                 
113                 @param blendtime: The new time. This parameter must be in the range from 0.0 to 1.0.
114                 @type blendtime: float
115                 """
116
117         def setType(mode):
118                 """
119                 DEPRECATED: use the 'type' property
120                 Sets the operation mode of the actuator
121
122                 @param mode: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
123                 @type mode: integer
124                 """
125         
126         def getType():
127                 """
128                 DEPRECATED: use the 'type' property
129                 Returns the operation mode of the actuator
130             
131                 @rtype: integer
132                 @return: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
133                 """
134
135         def getAction():
136                 """
137                 DEPRECATED: use the 'action' property
138                 getAction() returns the name of the action associated with this actuator.
139                 
140                 @rtype: string
141                 """
142         
143         def getStart():
144                 """
145                 DEPRECATED: use the 'start' property
146                 Returns the starting frame of the action.
147                 
148                 @rtype: float
149                 """
150         def getEnd():
151                 """
152                 DEPRECATED: use the 'end' property
153                 Returns the last frame of the action.
154                 
155                 @rtype: float
156                 """
157         def getBlendin():
158                 """
159                 DEPRECATED: use the 'blendin' property
160                 Returns the number of interpolation animation frames to be generated when this actuator is triggered.
161                 
162                 @rtype: float
163                 """
164         def getPriority():
165                 """
166                 DEPRECATED: use the 'priority' property
167                 Returns the priority for this actuator.  Actuators with lower Priority numbers will
168                 override actuators with higher numbers.
169                 
170                 @rtype: integer
171                 """
172         def getFrame():
173                 """
174                 DEPRECATED: use the 'frame' property
175                 Returns the current frame number.
176                 
177                 @rtype: float
178                 """
179         def getProperty():
180                 """
181                 DEPRECATED: use the 'property' property
182                 Returns the name of the property to be used in FromProp mode.
183                 
184                 @rtype: string
185                 """
186         def setFrameProperty(prop):
187                 """
188                 DEPRECATED: use the 'frameProperty' property
189                 @param prop: A string specifying the property of the object that will be updated with the action frame number.
190                 @type prop: string
191                 """
192         def getFrameProperty():
193                 """
194                 DEPRECATED: use the 'frameProperty' property
195                 Returns the name of the property that is set to the current frame number.
196                 
197                 @rtype: string
198                 """