exodeui 6.3.45 → 6.3.46

package/README.md

@@ -45,14 +45,18 @@ function App() {
 
 ## Features
 
-### 1. State Machine & Logic
-ExodeUI supports complex interactive logic using a node-based **State Machine**.
-- **Inputs**: Control the flow with Boolean, Number, and Trigger inputs.
-- **Logic Nodes**: Combine inputs using AND, OR, NOT, XOR.
-- **Conditions**: Create transitions based on input values (e.g., `Speed > 10`, `IsHovered == true`).
-
+### 1. State Variables & Logic
+ExodeUI supports complex interactive logic using a node-based **State Machine**. At the core of this logic are **State Variables** (Inputs). ExodeUI supports several types of state variables:
+- **Boolean**: Simple `true` / `false` switches.
+- **Number**: Float or integer values (e.g. 0 to 100).
+- **Trigger**: Momentary pulses that auto-reset (e.g. for "Jump" or "Click").
+- **Array**: Arrays of numbers or strings (e.g. for charts or list data).
+- **Random Number / Random Color**: Engine-managed variables that dynamically evaluate based on seeds and time.
+
+#### Setting State Variables
+You can update variables to drive animations and logic from your React code:
 ```tsx
-const [engine, setEngine] = useState<ExodeUIEngine | null>(null);
+const { setEngine, setInputBool, fireTrigger, setInputNumberArray } = useExodeUI();
 
 // ... inside your component
 <ExodeUICanvas 
@@ -60,9 +64,21 @@ const [engine, setEngine] = useState<ExodeUIEngine | null>(null);
   onReady={setEngine}
 />
 
-// Button controls
-<button onClick={() => engine?.setInputBool('IsRunning', true)}>Run</button>
-<button onClick={() => engine?.fireTrigger('Jump')}>Jump</button>
+// Setting values
+<button onClick={() => setInputBool('IsRunning', true)}>Run</button>
+<button onClick={() => fireTrigger('Jump')}>Jump</button>
+<button onClick={() => setInputNumberArray('ChartData', [10, 20, 30])}>Update Chart</button>
+```
+
+#### Reading State Variables
+You can also read the current value of any state variable at runtime using `getInputValue()`. This works for standard variables you set, as well as dynamic ones like Random Number and Random Color evaluated internally by the engine:
+```tsx
+const { getInputValue } = useExodeUI();
+
+// Read a boolean, number, array, or dynamically generated variable
+const isRunning = getInputValue('IsRunning');
+const randomVal = getInputValue('MyRandomNumber'); // Read engine-managed random value
+console.log(`Running: ${isRunning}, Random: ${randomVal}`);
 ```
 
 ### 2. Physics Engine