Script Inputs

Scripted Inputs are the bridge between your scripts and the Rive editor, allowing you to customize and control script behavior through custom input fields. By defining inputs in your scripts, you expose configurable properties — like numbers, colors, booleans, view model instances, and artboard components — that appear directly in the Rive interface. This means you can write the logic once in a script, and then experiment freely with values, animate properties over time, bind data from external sources, and reuse the same script across multiple instances with different configurations. Inputs transform static scripts into flexible, designer-friendly tools that enable true collaboration and rapid iteration.

Defining Inputs

To make new script inputs, add them to the type and set the defaults in the script’s return function.

-- Define the script's data and inputs.
type ScriptInputs = {
  score: Input<number>,
  menu: Input<Data.MenuVM>,
  newArtboard: Input<Artboard<Data.NewVM>>,
}

-- Return a factory function that Rive uses to build the Node instance.
return function(): Node<ScriptInputs>
  return {
    score = 0,
    menu = late(),
    newArtboard = late(),
  }
end

Setting Input Values

To access the input properties in the right sidebar of the editor, select your Node or Layout script in the Hierarchy Panel or the Converter in the Data Panel.

Data Binding Inputs

You can use Data Binding to control input values at runtime. To data bind an input, right-click the input field in right sidebar, choose Data Bind, and select a property.

Listening for Changes to Inputs

The update function fires every time any input changes.

function update(self: MyNode)
  print('An update changed')
end

​Defining Inputs

​Setting Input Values

​Data Binding Inputs

​Listening for Changes to Inputs

Defining Inputs

Setting Input Values

Data Binding Inputs

Listening for Changes to Inputs