Added a docstring for the inputs

defold · Nov 12, 2024 · a879154 · a879154
1 parent c9de4e1
commit a879154
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -231,6 +231,15 @@ go.set("#rivemodel", "Trigger 1", true)
 
 -- Set the numeric value "Number 1" to 0.8
 go.set("#rivemodel", "Number 1", 0.8)
+
+-- Read the input value of the current state machine
+local v = rive.get_state_machine_input("#rivemodel", "Number 1")
+
+-- Read the input value of a nested artboard from the current state machine
+local v = rive.get_state_machine_input("#rivemodel", "Number 1", "My_Nested_Artboard")
+
+-- To go deeper into the nested hierarchy, you can add slashes between each scope
+local v = rive.get_state_machine_input("#rivemodel", "Number 1", "My_Nested_Artboard/My_Inner_Nested_Artboard")
 ```
 
 #### Events