Buttons

On this page

Edit

Trigger Button #

Triggers any button by its ID.
If the button ID does not exist, sends an extension trigger instead.
Inside the button that was triggered by this command, you can use Trigger Pull Data command to get the button and instance ID of the originating button, which can be used to set non persistent variables in the originating button.

You can right click on a button and left click on its ID to copy it into your clipboard.

Box Name	Type	Description
Button ID	String/Number	ID of a button you want to activate.
Delay Activation	Int	This exists to make a button happen without greying it out in case the button is showing valuable info. The delay is hidden and cannot be cancelled.
Queueable	checkbox	If checked and the button is already activated, it will wait for it to finish and trigger the button again. Will get queued as many times as you execute the command. If unchecked and the button is already activated, nothing will happen.

Edit

Modify Button/Group #

Changes the appearance of a button or group (color, text, image and border).
All changes are temporary, the button will return to its original state if you reset or close and reopen SAMMI.
If you wish to reset the button back to its default appearance, set the values to buttond_id, -1, -1, -1, notext, leave empty, -1.

Box Name	Type	Description
Button/Group ID	Any	Button ID or group ID to change the appearance of
Text	String	New button text. Use `-default-` to revert the button to its default value.
Picture	String/File Select	File name of an image to use. You can use the file explorer or manually type it.
Border	Int	Size of the button border, between 0-8. Use `-1` for default border size and `0` for no border.
Set Color	checkbox	Whether you want to also change the button color.
Color	color picker	Select new color for the button.

Edit

Modify Button/Group From Object #

Changes the appearance of a button or group (color, text, image and border) based on a provided object.
All changes are temporary, the button will return to its original state if you reset or close and reopen SAMMI.
Refer to Modify Button/Group command for further information about what values to use.

Example object:

{ 
    "color": 13057310, 
    "text": "Hello World", 
    "border": 2.0, 
    "image": "myImage.png" 
}

SAMMI uses BGR colors. Use 'Swap red and blue' command if providing a RGB color.

Box Name	Type	Description
Button/Group ID	String	Button ID or group ID to change the appearance of
Object Name	String	Object name containing your modifications

Edit

Stop Button/Group #

Stops the given button/group ID or all the buttons (in all decks) from running. You can choose to stop ongoing and queued buttons, too.
If you stop all buttons, you can specify whether you want to stop the button performing this command as well.

Box Name	Type	Description
Button ID/Group ID	Any	Button or group ID to stop, use `all` to stop all buttons
Stop Ongoing	Checkbox	Choose whether the ongoing buttons should be stopped
Stop Queued	Checkbox	Choose whether the queued buttons should be stopped
Include Self	Checkbox	Choose whether you want to stop this button as well

Edit

Block Button/Group #

Blocks or unblocks a button/group by its ID.
Won’t cancel an ongoing button/group but will prevent any already existing queue from happening when its turn comes.
The block does not persist when SAMMI is restarted.
By setting the ID to all you can remove all current blocks. This only works for unblocking buttons.

Box Name	Type	Description
Button ID/Group ID	Any	Button ID or Group ID to block/unblock
Block	Checkbox	Checked = block a button, Unchecked = unblock a button
Allow Queue	Checkbox	Checked = queue will wait for button to be unblocked and then will continue as normal Unchecked = any queue when the button is blocked will be ignored and deleted

Edit

Button Get Own ID #

Returns an ID of the button that executed this command.

Box Name	Type	Description
Save Variable As	String	Variable name to save the button ID

Edit

Reinitialize Button Variables #

Restores initial button variables. Works the same as right clicking on the button - Edit Init Variables and pressing Reinitialize button.

Box Name	Type	Description
Button ID	String/Number	ID of a button you want to reinitialize variables in.