Module BL_ActionActuator :: Class BL_ActionActuator
[frames | no frames]

Class BL_ActionActuator

SCA_ILogicBrick --+    
                  |    
      SCA_IActuator --+
                      |
                     BL_ActionActuator


Action Actuators apply an action to an actor.
Method Summary
string getAction()
getAction() returns the name of the action associated with this actuator.
float getBlendin()
Returns the number of interpolation animation frames to be generated when this actuator is triggered.
float getEnd()
Returns the last frame of the action.
float getFrame()
Returns the current frame number.
integer getPriority()
Returns the priority for this actuator.
string getProperty()
Returns the name of the property to be used in FromProp mode.
float getStart()
Returns the starting frame of the action.
integer getType()
Returns the operation mode of the actuator
  setAction(action, reset)
Sets the current action.
  setBlendin(blendin)
Specifies the number of frames of animation to generate when making transitions between actions.
  setBlendtime(blendtime)
Sets the internal frame timer.
  setChannel(channel, matrix, mode)
  setEnd(end)
Specifies the ending frame of the animation.
  setFrame(frame)
Sets the current frame for the animation.
  setPriority(priority)
Sets the priority of this actuator.
  setProperty(prop)
Sets the property to be used in FromProp playback mode.
  setStart(start)
Specifies the starting frame of the animation.
  setType(mode)
Sets the operation mode of the actuator
    Inherited from SCA_ILogicBrick
integer getExecutePriority()
Gets the execution priority of this logic brick.
KX_GameObject getOwner()
Gets the game object associated with this logic brick.
  setExecutePriority(priority)
Sets the priority of this logic brick.

Method Details

getAction()

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

getBlendin()

Returns the number of interpolation animation frames to be generated when this actuator is triggered.
Returns:
float

getEnd()

Returns the last frame of the action.
Returns:
float

getFrame()

Returns the current frame number.
Returns:
float

getPriority()

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

getProperty()

Returns the name of the property to be used in FromProp mode.
Returns:
string

getStart()

Returns the starting frame of the action.
Returns:
float

getType()

Returns the operation mode of the actuator
Returns:
KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
           (type=integer)

setAction(action, reset=True)

Sets the current action.
Parameters:
action - The name of the action to set as the current action.
           (type=string)
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.

setBlendin(blendin)

Specifies the number of frames of animation to generate when making transitions between actions.
Parameters:
blendin - the number of frames in transition.
           (type=float)

setBlendtime(blendtime)

Sets the internal frame timer.

Allows the script to directly modify the internal timer used when generating transitions between actions.
Parameters:
blendtime - The new time. This parameter must be in the range from 0.0 to 1.0.
           (type=float)

setChannel(channel, matrix, mode=False)

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

setEnd(end)

Specifies the ending frame of the animation.
Parameters:
end - the ending frame of the animation
           (type=float)

setFrame(frame)

Sets the current frame for the animation.
Parameters:
frame - Specifies the new current frame for the animation
           (type=float)

setPriority(priority)

Sets the priority of this actuator.
Parameters:
priority - Specifies the new priority. Actuators will lower priority numbers will override actuators with higher numbers.
           (type=integer)

setProperty(prop)

Sets the property to be used in FromProp playback mode.
Parameters:
prop - the name of the property to use.
           (type=string.)

setStart(start)

Specifies the starting frame of the animation.
Parameters:
start - the starting frame of the animation
           (type=float)

setType(mode)

Sets the operation mode of the actuator
Parameters:
mode - KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
           (type=integer)

Generated by Epydoc 2.1 on Thu Feb 1 00:12:33 2007 http://epydoc.sf.net