Menus · Step
Toggle button
Put an on/off button in the menu. Each click flips a true or false carry value and swaps its item.
m.menu.toggle_button
In a flow
“When a player uses a command → Open a menu → Toggle button sounds → a click flow reads {menu.carry.sounds}.”
When a player uses a command → Open a menu → Toggle button sounds → a click flow reads {menu.carry.sounds}.
What it does
Put an on/off button in the menu. Each click flips a true or false carry value and swaps its item. It's a step: it runs when the white wire reaches it, then the flow carries on from its Then pin. Find it under Menus in the palette.
When to use it
Use it when the flow needs to: put an on/off button in the menu. Each click flips a true or false carry value and swaps its item.
When not to
If nothing should change in Discord, a value node or a check is lighter.
Typical wiring
Sockets: settings you can wire
- Player Player
-
Leave unwired for the player who started the flow, or wire one in, like Player from When a player joins.
What goes there: Type it in the side panel, or wire in a player. e.g. Alex
If it's empty: Optional. Left empty and unwired, the step runs without it.
- Slot Number
-
Which slot, from 0 (top left) along each row. A 3 row menu ends at 26.
What goes there: Type it in the side panel, or wire in a number. e.g. 42
If it's empty: Optional. Left empty and unwired, it uses 11.
Connects fromA member's variablesAccept applicationActive membersAddAdd a forum tagAdd a labelAdd a row to a Google SheetAdd a staff noteand 501 more
- Name Text
-
The name on the button. {state} shows ON or OFF. Variables allowed; MiniMessage tags like <gold> work.
What goes there: Type it in the side panel, or wire in text. e.g. Hello there
If it's empty: Optional. Left empty and unwired, it uses <gray>Sounds: {state}.
Connects fromA member's variablesAccept applicationAdd a Notion pageAdd a Trello cardAdd an emojiAdd to number in objectAdd up timesAdd working daysand 845 more
- Carry name Text
-
The carry value that holds true or false, like sounds. Lower case letters, numbers and _.
What goes there: Type it in the side panel, or wire in text. e.g. Hello there
If it's empty: Optional. Left empty and unwired, it uses sounds.
Connects fromA member's variablesAccept applicationAdd a Notion pageAdd a Trello cardAdd an emojiAdd to number in objectAdd up timesAdd working daysand 845 more
- Starts on Yes / no
-
Starts on when the menu doesn't carry a value for it yet.
What goes there: Type it in the side panel, or wire in true or false. e.g. true
If it's empty: Optional. Left alone, it's off.
Connects fromAdd a labelAdd to a leaderboardAge from birthdayAI check a messageAnagram checkAndAnswer a deadlineAnti-nuke guardand 270 more
- Button Text
-
What the click flow reads as Button. Empty means no click flow starts.
What goes there: Type it in the side panel, or wire in text. e.g. Hello there
If it's empty: Optional. Left empty and unwired, the step runs without it.
Connects fromA member's variablesAccept applicationAdd a Notion pageAdd a Trello cardAdd an emojiAdd to number in objectAdd up timesAdd working daysand 845 more