Module BL_ActionActuator :: Class BL_ActionActuator

Class BL_ActionActuator

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
        SCA_IActuator.SCA_IActuator --+
                                      |
                                     BL_ActionActuator

Action Actuators apply an action to an actor.

Instance Methods

setAction(action, reset=True)
Sets the current action.

source code

setStart(start)
Specifies the starting frame of the animation.

source code

setEnd(end)
Specifies the ending frame of the animation.

source code

setBlendin(blendin)
Specifies the number of frames of animation to generate when making transitions between actions.

source code

setPriority(priority)
Sets the priority of this actuator.

source code

setFrame(frame)
Sets the current frame for the animation.

source code

setProperty(prop)
Sets the property to be used in FromProp playback mode.

source code

setBlendtime(blendtime)
Sets the internal frame timer.

source code

setType(mode)
Sets the operation mode of the actuator

source code

integer

getType()
Returns the operation mode of the actuator

source code

string

getAction()
getAction() returns the name of the action associated with this actuator.

source code

float

getStart()
Returns the starting frame of the action.

source code

float

getEnd()
Returns the last frame of the action.

source code

float

getBlendin()
Returns the number of interpolation animation frames to be generated when this actuator is triggered.

source code

integer

getPriority()
Returns the priority for this actuator.

source code

float

getFrame()
Returns the current frame number.

source code

string

getProperty()
Returns the name of the property to be used in FromProp mode.

source code

setChannel(channel, matrix, mode=False)

source code

Inherited from SCA_ILogicBrick.SCA_ILogicBrick: getExecutePriority, getOwner, setExecutePriority

Method Details

setAction(action, reset=True)

source code

Sets the current action.

Parameters:

action (string) - The name of the action to set as the current action.
reset - Optional parameter indicating whether to reset the blend timer or not. A value of 1 indicates that the timer should be reset. A value of 0 will leave it unchanged. If reset is not specified, the timer will be reset.

setStart(start)

source code

Specifies the starting frame of the animation.

Parameters:

start (float) - the starting frame of the animation

setEnd(end)

source code

Specifies the ending frame of the animation.

Parameters:

end (float) - the ending frame of the animation

setBlendin(blendin)

source code

Specifies the number of frames of animation to generate when making transitions between actions.

Parameters:

blendin (float) - the number of frames in transition.

setPriority(priority)

source code

Sets the priority of this actuator.

Parameters:

priority (integer) - Specifies the new priority. Actuators will lower priority numbers will override actuators with higher numbers.

setFrame(frame)

source code

Sets the current frame for the animation.

Parameters:

frame (float) - Specifies the new current frame for the animation

setProperty(prop)

source code

Sets the property to be used in FromProp playback mode.

Parameters:

prop (string.) - the name of the property to use.

setBlendtime(blendtime)

source code

Sets the internal frame timer.

Allows the script to directly modify the internal timer used when generating transitions between actions.

Parameters:

blendtime (float) - The new time. This parameter must be in the range from 0.0 to 1.0.

setType(mode)

source code

Sets the operation mode of the actuator

Parameters:

mode (integer) - KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND

getType()

source code

Returns the operation mode of the actuator

Returns: integer: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND

getPriority()

source code

Returns the priority for this actuator. Actuators with lower Priority numbers will override actuators with higher numbers.

Returns: integer

setChannel(channel, matrix, mode=False)

source code

Parameters:

channel (string) - A string specifying the name of the bone channel.
matrix (list [[float]]) - A 4x4 matrix specifying the overriding transformation as an offset from the bone's rest position.
mode (boolean) - True for armature/world space, False for bone space