Pydoc: Fix multiple bpy.type modules
[blender.git] / doc / python_api / rst / bge_types / bge.types.BL_ActionActuator.rst
1 BL_ActionActuator(SCA_IActuator)
2 ================================
3
4 base class --- :class:`SCA_IActuator`
5
6 .. class:: BL_ActionActuator(SCA_IActuator)
7
8    Action Actuators apply an action to an actor.
9
10    .. attribute:: action
11
12       The name of the action to set as the current action.
13
14       :type: string
15
16    .. attribute:: frameStart
17
18       Specifies the starting frame of the animation.
19
20       :type: float
21
22    .. attribute:: frameEnd
23
24       Specifies the ending frame of the animation.
25
26       :type: float
27
28    .. attribute:: blendIn
29
30       Specifies the number of frames of animation to generate when making transitions between actions.
31
32       :type: float
33
34    .. attribute:: priority
35
36       Sets the priority of this actuator. Actuators will lower priority numbers will override actuators with higher numbers.
37
38       :type: integer
39
40    .. attribute:: frame
41
42       Sets the current frame for the animation.
43
44       :type: float
45
46    .. attribute:: propName
47
48       Sets the property to be used in FromProp playback mode.
49
50       :type: string
51
52    .. attribute:: blendTime
53
54       Sets the internal frame timer. This property must be in the range from 0.0 to blendIn.
55
56       :type: float
57
58    .. attribute:: mode
59
60       The operation mode of the actuator. Can be one of :ref:`these constants<action-actuator>`.
61
62       :type: integer
63
64    .. attribute:: useContinue
65
66       The actions continue option, True or False. When True, the action will always play from where last left off,
67       otherwise negative events to this actuator will reset it to its start frame.
68
69       :type: boolean
70
71    .. attribute:: framePropName
72
73       The name of the property that is set to the current frame number.
74
75       :type: string