API ReferenceGE Extensionsflowgraphnodesuibuttons
Get Button (Flowgraph Node)
- **Node Name:** `Get Button`
Overview
- Node Name:
Get Button - Category:
once_instant - File:
extensions/flowgraph/nodes/ui/buttons/getButton.lua
Reads the current state and properties of a button created by the Create Button node.
Pin Schema
Input Pins
| Pin | Type | Description |
|---|---|---|
buttonId | number | ID of the button to read |
Output Pins
| Pin | Type | Description |
|---|---|---|
clicked | flow | (Impulse) Fires once when the button is clicked |
used | flow | (Hidden) Fires after the button has been clicked at least once |
unused | flow | (Hidden) Fires while the button has not yet been clicked |
label | string | (Hidden) The button's label |
active | bool | (Hidden) Whether the button is active |
order | number | (Hidden) The button's order |
style | string | (Hidden) The button's style |
Legacy Pin Mapping
| Old Name | New Name |
|---|---|
complete | used |
incomplete | unused |
How It Works
workOnce()- Retrieves the button object fromself.mgr.modules.button:getButton(id).- Reads
clicked,complete,label,active,order, andstyleproperties from the button. - The
clickedpin is an impulse - it only fires for one frame when clicked.
Example Usage
-- Pair with createButton:
-- createButton → buttonId → getButton
-- Then branch on clicked/used/unused flow outputsSee Also
- Create Button (Flowgraph Node) - Related reference
- Get Multiple Buttons (Flowgraph Node) - Related reference
- Set Button Property (Flowgraph Node) - Related reference
- FlowGraph Guide - Guide