State Machines

Interact with the Rive State Machine in Unity.

For more information on Rive State Machines see the respective runtime and editor documentation.

State Machines

(Runtime) Rive’s state machines provide a way to combine a set of animations and manage the transition between them through a series of inputs that can be programmatically controlled.

State Machines

(Editor) State Machines are a visual way to connect animations together and define the logic that drives the transitions.

Overview

A StateMachine advances (plays) animations in an Artboard.

Components

A Rive Widget automatically loads and advances the state machine from your artboard configuration settings. Here’s how you can access the loaded state machine in your scripts:

[SerializeField] private RiveWidget m_riveWidget;

...

void OnEnable()
{
    m_riveWidget.OnWidgetStatusChanged += OnWidgetStatusChanged;
}

private void OnWidgetStatusChanged()
{
    // Wait for the Rive Widget to load before accessing the state machine.
    if (m_riveWidget.Status == WidgetStatus.Loaded)
    {
        StateMachine m_stateMachine = m_riveWidget.StateMachine;
    }
}


void OnDisable()
{
    m_riveWidget.OnWidgetStatusChanged -= OnWidgetStatusChanged;
}

Legacy API

Using the low-level API is no longer recommended. Please use the Component API instead for ease of use and maintainability. This content is provided for legacy support only.

State Machines are instantiated from an Arboard instance:

private StateMachine m_stateMachine;

...

m_stateMachine = m_artboard?.StateMachine(); // default state machine
m_stateMachine = m_artboard?.StateMachine(0); // state machine at index
m_stateMachine = m_artboard?.StateMachine("Name"); // state machine with name

The state machine is played by calling advance and passing in the delta time:

private void Update()
{
    m_stateMachine?.Advance(Time.deltaTime);
}