PluginToolbarButton

ClickableWhenViewportHidden détermine si un bouton de plugin peut être cliqué pendant que le viewport du jeu est caché, comme lorsqu'un Script est en cours de modification dans une autre onglet.

En général, cette propriété est bonne à activer si un événement Click activé par le bouton d'un plugin se produit dans le monde du jeu (Workspace). Par exemple, un bouton qui ouvre un widget devrait avoir cette propriété être vrai, car en montrant un widget, il est visible pour l'utilisateur même si la vue du jeu n'est pas visible.

Activé détermine si un bouton est cliquable en général. Lorsque cette propriété est fausse, le bouton est grisé et non cliquable, ce qui empêche l'utilisateur de déclencher l'événement Click. Les boutons sont activés par défaut.

Lors de la réactivation de cette propriété, l'état du bouton ne sera pas mémorisé à partir de l'état précédent dans lequel l'utilisateur a quitté le bouton. Au lieu de cela, il sera réinitialisé à l'état dernier défini par SetActive() ou à l'état inactif si SetActive() n'a jamais été utilisé.

Les plugins devraient désactiver leurs boutons lorsque l'action du bouton n'est pas pertinente dans le contexte actuel. Par exemple, un bouton de plugin qui attribue des couleurs aléatoires aux sélections ne devrait pas être activé lorsque la sélection ne contient pas de parties. Voir les exemples de code pour plus d'informations.

Voir aussi :

• ClickableWhenViewportHidden , qui détermine si un bouton est cliquable lorsque la fenêtre de jeu est cachée (et pas seulement en général)

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()

Icône détermine ce qui doit être affiché pour le bouton dans la barre d'outils du plugin. Lorsque cette propriété n'est pas configurer, le bouton utilise plutôt le texte du bouton donné par icon.

Cette méthode peut être utilisée pour définir manuellement l'état actif du bouton du plugin.

Lorsque la propriété Enabled est basculée, le bouton reviendra soit à l'état dernier défini par cette méthode ou par défaut si cette méthode n'a pas été utilisée auparavant.

Paramètres

Retours

Cliquez sur les feux se déclenchent lorsque le PluginToolbarButton est pressé et relâché par l'utilisateur.

En cliquant sur un PluginToolbarButton, l'état du bouton est activer/désactiver. Appeler SetActive pour activer manuellement l'état du bouton.

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)