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