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
 
setChannel(channel, matrix, mode=False)
 
setAction(action, reset=True)
DEPRECATED: use the 'action' property Sets the current action.
 
setStart(start)
DEPRECATED: use the 'start' property Specifies the starting frame of the animation.
 
setEnd(end)
DEPRECATED: use the 'end' property Specifies the ending frame of the animation.
 
setBlendin(blendin)
DEPRECATED: use the 'blendin' property Specifies the number of frames of animation to generate when making transitions between actions.
 
setPriority(priority)
DEPRECATED: use the 'priority' property Sets the priority of this actuator.
 
setFrame(frame)
DEPRECATED: use the 'frame' property Sets the current frame for the animation.
 
setProperty(prop)
DEPRECATED: use the 'property' property Sets the property to be used in FromProp playback mode.
 
setBlendtime(blendtime)
DEPRECATED: use the 'blendTime' property Sets the internal frame timer.
 
setType(mode)
DEPRECATED: use the 'type' property Sets the operation mode of the actuator
 
setContinue(cont)
DEPRECATED: use the 'continue' property Set the actions continue option True or False.
integer
getType()
DEPRECATED: use the 'type' property Returns the operation mode of the actuator
bool
getContinue()
DEPRECATED: use the 'continue' property When True, the action will always play from where last left off, otherwise negative events to this actuator will reset it to its start frame.
string
getAction()
DEPRECATED: use the 'action' property getAction() returns the name of the action associated with this actuator.
float
getStart()
DEPRECATED: use the 'start' property Returns the starting frame of the action.
float
getEnd()
DEPRECATED: use the 'end' property Returns the last frame of the action.
float
getBlendin()
DEPRECATED: use the 'blendin' property Returns the number of interpolation animation frames to be generated when this actuator is triggered.
integer
getPriority()
DEPRECATED: use the 'priority' property Returns the priority for this actuator.
float
getFrame()
DEPRECATED: use the 'frame' property Returns the current frame number.
string
getProperty()
DEPRECATED: use the 'property' property Returns the name of the property to be used in FromProp mode.
 
setFrameProperty(prop)
DEPRECATED: use the 'frameProperty' property
string
getFrameProperty()
DEPRECATED: use the 'frameProperty' property Returns the name of the property that is set to the current frame number.
integer
getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
KX_GameObject
getOwner()
Gets the game object associated with this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
Instance Variables
string action
The name of the action to set as the current action.
float blendTime
Sets the internal frame timer.
float blendin
Specifies the number of frames of animation to generate when making transitions between actions.
  continue
The actions continue option, True or False.
float end
Specifies the ending frame of the animation.
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
float frame
Sets the current frame for the animation.
string frameProperty
The name of the property that is set to the current frame number.
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read only). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
integer priority
Sets the priority of this actuator.
string property
Sets the property to be used in FromProp playback mode.
float start
Specifies the starting frame of the animation.
integer type
The operation mode of the actuator.
Method Details

setChannel(channel, matrix, mode=False)

 
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

setAction(action, reset=True)

 

DEPRECATED: use the 'action' property 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)

 

DEPRECATED: use the 'start' property Specifies the starting frame of the animation.

Parameters:
  • start (float) - the starting frame of the animation

setEnd(end)

 

DEPRECATED: use the 'end' property Specifies the ending frame of the animation.

Parameters:
  • end (float) - the ending frame of the animation

setBlendin(blendin)

 

DEPRECATED: use the 'blendin' property 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)

 

DEPRECATED: use the 'priority' property 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)

 

DEPRECATED: use the 'frame' property Sets the current frame for the animation.

Parameters:
  • frame (float) - Specifies the new current frame for the animation

setProperty(prop)

 

DEPRECATED: use the 'property' property Sets the property to be used in FromProp playback mode.

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

setBlendtime(blendtime)

 

DEPRECATED: use the 'blendTime' property 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)

 

DEPRECATED: use the 'type' property 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

setContinue(cont)

 

DEPRECATED: use the 'continue' property Set the actions continue option True or False. see getContinue.

Parameters:
  • cont (bool) - The continue option.

getType()

 

DEPRECATED: use the 'type' property 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()

 

DEPRECATED: use the 'priority' property Returns the priority for this actuator. Actuators with lower Priority numbers will override actuators with higher numbers.

Returns: integer

setFrameProperty(prop)

 

DEPRECATED: use the 'frameProperty' property

Parameters:
  • prop (string) - A string specifying the property of the object that will be updated with the action frame number.

Instance Variable Details

blendTime

Sets the internal frame timer. This property must be in the range from 0.0 to blendin.
Type:
float

continue

The actions continue option, True or False. When True, the action will always play from where last left off, otherwise negative events to this actuator will reset it to its start frame.

priority

Sets the priority of this actuator. Actuators will lower priority numbers will override actuators with higher numbers.
Type:
integer

type

The operation mode of the actuator. KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
Type:
integer