PluginToolbarButton

ClickableWhenViewportHidden determines whether a PluginToolbarButton may be clicked while the game viewport is hidden, such as when a Script is being edited in another tab.

Typically, this property is good to enable if an action triggered by a plugin button's Click event doesn't occur in the game world (Workspace). For example, a button that opens a widget should have this property be true, as showing a widget is visible to the user even if the game view isn't visible.

Enabled determines whether a button is clickable in general. When this property is false, the button will be greyed out and unclickable, preventing the user from firing the Click event. Buttons are enabled by default.

When re-enabling this property, the plugin button's state won't be remembered from the previous state in which the user left the button in. Instead, it will default to the last state set by SetActive() or to the inactive state if SetActive() was never used.

Plugins should disable their buttons when the button action isn't relevant in the current context. For example, a plugin button that assigns random colors to selected should not be enabled when the selection contains no parts. See the code samples for more information.

See also:

• ClickableWhenViewportHidden, which determines whether a button is clickable when the game view is hidden (and not just in general)

assert(plugin, "This script must be run as a plugin")

local Selection = game:GetService("Selection")

local toolbar = plugin:CreateToolbar("Parts")
local pluginToolbarButton = toolbar:CreateButton(
	"Randomize Colors",
	"Click this button to assign random colors to selected parts",
	"rbxassetid://5325741572" -- A rainbow
)

local function onClick()
	local selection = Selection:Get()
	for _, object in pairs(selection) do
		if object:IsA("BasePart") then
			object.BrickColor = BrickColor.random()
		end
	end
end
pluginToolbarButton.Click:Connect(onClick)

local function doesSelectionContainAPart()
	local selection = Selection:Get()
	for _, object in pairs(selection) do
		if object:IsA("BasePart") then
			return true
		end
	end
	return false
end

local function onSelectionChanged()
	pluginToolbarButton.Enabled = doesSelectionContainAPart()
end
Selection.SelectionChanged:Connect(onSelectionChanged)
onSelectionChanged()

Icon determines what icon should be shown for the button in the plugin toolbar. When this property is not set, the button will instead use the button's text given by PluginToolbar:CreateButton().

This method can be used to manually set the active state of the plugin button.

When the Enabled property is toggled back on, the button will either revert to the last state set by this method or default to inactive if this method hasn't been used previously.

Parameters

Returns

Click fires when the PluginToolbarButton is pressed and released by the user.

Clicking a PluginToolbarButton causes the state of the button to toggle. Call SetActive to manually set the state of the button.

assert(plugin, "This script must be run as a plugin")

local toolbar = plugin:CreateToolbar("Hello World Plugin Toolbar")
local pluginToolbarButton = toolbar:CreateButton(
	"Print Hello World",
	"Click this button to print Hello World!",
	"rbxassetid://133293265"
)

local function onClick()
	print("Hello, world")
end

pluginToolbarButton.Click:Connect(onClick)