BGE patch: Add PyDoc for new logic bricks, set exception message on Py error, remove...
[blender.git] / source / gameengine / PyDoc / KX_IpoActuator.py
1 # $Id$
2 # Documentation for KX_IpoActuator
3 from SCA_IActuator import *
4
5 class KX_IpoActuator(SCA_IActuator):
6         """
7         IPO actuator activates an animation.
8         """
9         def set(mode, startframe, endframe, mode):
10                 """
11                 Sets the properties of the actuator.
12                 
13                 @param mode:       "Play", "PingPong", "Flipper", "LoopStop", "LoopEnd" or "FromProp"
14                 @type mode: string
15                 @param startframe: first frame to use
16                 @type startframe: integer
17                 @param endframe: last frame to use
18                 @type endframe: integer
19                 @param mode: special mode
20                 @type mode: integer (0=normal, 1=interpret location as force, 2=additive)
21                 """
22         def setProperty(property):
23                 """
24                 Sets the name of the property to be used in FromProp mode.
25                 
26                 @type property: string
27                 """
28         def setStart(startframe):
29                 """
30                 Sets the frame from which the IPO starts playing.
31                 
32                 @type startframe: integer
33                 """
34         def getStart():
35                 """
36                 Returns the frame from which the IPO starts playing.
37                 
38                 @rtype: integer
39                 """
40         def setEnd(endframe):
41                 """
42                 Sets the frame at which the IPO stops playing.
43                 
44                 @type endframe: integer
45                 """
46         def getEnd():
47                 """
48                 Returns the frame at which the IPO stops playing.
49                 
50                 @rtype: integer
51                 """
52         def setIpoAsForce(force):
53                 """
54                 Set whether to interpret the ipo as a force rather than a displacement.
55                 
56                 @type force: boolean
57                 @param force: KX_TRUE or KX_FALSE
58                 """
59         def getIpoAsForce():
60                 """
61                 Returns whether to interpret the ipo as a force rather than a displacement.
62                 
63                 @rtype: boolean
64                 """
65         def setIpoAdd(add):
66                 """
67                 Set whether to interpret the ipo as additive rather than absolute.
68                 
69                 @type add: boolean
70                 @param add: KX_TRUE or KX_FALSE
71                 """
72         def getIpoAdd():
73                 """
74                 Returns whether to interpret the ipo as additive rather than absolute.
75                 
76                 @rtype: boolean
77                 """
78         def setType(mode):
79                 """
80                 Sets the operation mode of the actuator.
81                 
82                 @param mode: KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND
83                 @type mode: string
84                 """
85         def getType():
86                 """
87                 Returns the operation mode of the actuator.
88                 
89                 @rtype: integer
90                 @return: KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND
91                 """
92         def setForceIpoActsLocal(local):
93                 """
94                 Set whether to apply the force in the object's local
95                 coordinates rather than the world global coordinates.
96         
97                 @param local: Apply the ipo-as-force in the object's local
98                               coordinates? (KX_TRUE, KX_FALSE)
99                 @type local: boolean
100                 """
101         def getForceIpoActsLocal():
102                 """
103                 Return whether to apply the force in the object's local
104                 coordinates rather than the world global coordinates.
105                 """