Lumberyard
User Guide (Version 1.21)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Actions

You can use actions to trigger parameter value changes when an animation graph state or transition reaches a specified state.

You can set the Parameter Action on the following:

State

Set actions to trigger upon:

  • Entering a state – Action triggers when the state is fully blended into the node and is no longer in transition

  • Exiting a state – Action triggers when the state is fully blended out of the node and the node is no longer active

Transition

Set actions to trigger upon:

  • Entering a transition – Action triggers immediately upon starting a transition

  • Exiting a state – Action triggers when a transition is fully blended to the target state

Adding Actions to a State

Add an action to a state to achieve a parameter value change that triggers after the state is either fully blended into the node or fully blended out of the node.

To add an action to a state

  1. In the Animation Editor, open or create an animation graph.

  2. Select a node.

    
                        Select a node.
  3. In the Attributes panel, click Add action and then Parameter Action.

    
                        To add a Parameter Action, click Add action and then Parameter Action.
  4. In the Attributes panel, under Parameter Action, select a Trigger Mode. You can select one of the following options:

    • On Enter – Executes a State action when the state is fully blended into the node and is no longer in transition

    • On Exit – Executes a State action when the state is fully blended out of the node and the node is no longer active

    
                        For the Trigger Mode, select On Enter or On Exit.
  5. Choose Select parameter and select your preferred parameter.

    The selected parameter name replaces the text in the Select parameter box.

    
                        Choose Select parameter and select a parameter. The parameter name replaces the text in the Select parameter box.
  6. To turn the action on, set the Trigger Value to 1.

Adding Actions to a Transition

Add an action to a transition to achieve a parameter value change that triggers either when the transition starts or when the transition is fully blended to the target state.

To add an action to a transition

  1. In the Animation Editor, open or create an animation graph.

  2. Select a transition.

    
                        Select a transition.
  3. In the Attributes panel, click Add action and then Parameter Action.

    
                        To add a Parameter Action, click Add action and then Parameter Action.

    The following options trigger the change on a servant graph but with different inputs to the servant graph's parameter:

    • Servant Parameter Action – A constant value is provided

    • Symbolic Servant Parameter Action – A user-selected value is provided

  4. In the Attributes panel, under Parameter Action, select a Trigger Mode. You can select one of the following options:

    • On Enter – Executes the action immediately upon starting a transition

    • On Exit – Executes the action when a transition is fully blended to the target state

    
                        For the Trigger Mode, select On Enter or On Exit.
  5. Choose Select parameter and select your preferred parameter.

    The selected parameter name replaces the text in the Select parameter box.

    
                        Choose Select parameter and select a parameter. The parameter name replaces the text in the Select parameter box.
  6. To turn the action on, set the Trigger Value to 1.

    Note

    When you set a trigger on a transition, a square appears on the transition line, which represents the action.

    
                            Visual representation of an action set on a transition.