PluginToolbarButton

CliqueableWhenViewportHidden détermine si un bouton de barre d'outils de plugin peut être cliqué lorsque la fenêtre de jeu est cachée, comme lorsqu'un Script est en cours d'édition dans une autre fenêtre.

Typiquement, cette propriété est bonne pour activer si une action déclenchée par l'événement Click d'un bouton de plugin ne se produit pas dans le monde du jeu (Workspace).Par exemple, un bouton qui ouvre un widget devrait avoir cette propriété être vraie, comme montrer un widget 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 sera grisé et non cliquable, empêchant 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 du plugin ne sera pas souvenu de l'état précédent dans lequel l'utilisateur a quitté le bouton.Au lieu de cela, il sera défini par défaut sur l'état dernier défini par SetActive() ou sur l'état inactif si SetActive() n'a jamais été utilisé.

Les plugins doivent 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 à la sélection ne doit pas être activé lorsque la sélection ne contient pas de parties.Voir les échantillons de code pour plus d'informations.

Voir aussi :

• ClickableWhenViewportHidden , qui détermine si un bouton est cliquable lorsque la vue du 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()

L'icône détermine ce que icon devrait être affiché pour le bouton dans la barre d'outils du plugin.Lorsque cette propriété n'est pas configurer, le bouton utilisera plutôt le texte du bouton donné par PluginToolbar:CreateButton() .

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

Lorsque la propriété Enabled est réactivée, le bouton reviendra à l'état dernier défini par cette méthode ou sera inactif si cette méthode n'a pas été utilisée précédemment.

Paramètres

Retours

Cliquez déclenche des incendies lorsque le bouton PluginToolbar est pressé et libéré par l'utilisateur.

En cliquant sur un bouton PluginToolbar, l'état du bouton activer/désactiver. Appelez SetActive pour définir 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)