PluginToolbarButton
*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.
Un pulsante PluginToolbar è un oggetto creato dalla funzione PluginToolbar:CreateButton().Consente all'utente di avviare un'azione singola e unica in Roblox Studio attraverso l'evento Click.
Quando viene premuto, l'evento Click viene attivato.Un pulsante rimarrà anche nello stato premuto, che può essere impostato manualmente usando SetActive .Dopo l'attivazione del plugin ( Plugin:Activate() ), i pulsanti in tutti gli altri PluginToolbars saranno disattivati.Se tutti i pulsanti in una barra degli strumenti sono disattivati, il plugin della barra degli strumenti è disattivato ( Plugin:Deactivate() ).
Quando la vista del gioco non è visibile, i pulsanti verranno disabilitati come se la loro proprietà Enabled fosse falsa.I pulsanti disabilitati sono desaturati e non rispondono ai clic dell'utente.Impostando ClickableWhenViewportHidden a vero, puoi consentire ai pulsanti dei plugin di rimanere cliccabili (ad esempio durante l'editing dello script).
Sommario
Proprietà
Determina se il pulsante può essere cliccato quando la vista del gioco è nascosta, come durante l'editing di uno script in una scheda diversa di Studio.
Determina se il pulsante è cliccabile in Generale.
Determina quale icona dovrebbe rappresentare il pulsante.
Metodi
Imposta lo stato del pulsante del plugin.
Eventi
Si attiva quando l'utente premere e rilascia il cursore sul pulsante.
Proprietà
ClickableWhenViewportHidden
ClickableWhenViewportHidden determina se un pulsante della barra degli strumenti del plugin può essere cliccato mentre la vista del gioco è nascosta, come quando un Script viene modificato in un'altra scheda.
Tipicamente, questa proprietà è buona per abilitare se un'azione attivata dall'evento di un pulsante di plugin non si verifica nel mondo di gioco (Area di lavoro).Ad esempio, un pulsante che apre un widget dovrebbe avere questa proprietà vera, come mostrare un widget è visibile all'utente anche se la vista del gioco non è visibile.
Enabled
Abilitato determina se un pulsante è cliccabile in Generale.Quando questa proprietà è falsa, il pulsante verrà disattivato e non cliccabile, impedendo all'utente di attivare l'evento Click.I pulsanti sono abilitati per impostazione predefinita.
Quando si riabilita questa Proprietà, lo stato del pulsante del plugin non verrà ricordato dallo stato precedente in cui l'utente ha lasciato il pulsante.Invece, prenderà per impostazione predefinita l'ultimo stato impostato da SetActive() o lo stato inattivo se SetActive() non è mai stato utilizzato.
I plugin dovrebbero disabilitare i loro pulsanti quando l'azione del pulsante non è rilevante nel contesto attuale.Ad esempio, un pulsante di plugin che assegna colori casuali a quelli selezionati non deve essere abilitato quando la selezione non contiene parti.Vedi gli esempi di codice per ulteriori informazioni.
Vedi anche:
- ClickableWhenViewportHidden , che determina se un pulsante è cliccabile quando la vista del gioco è nascosta (e non solo in generale)
Campioni di codice
This code sample is for a studio Plugin. The plugin creates a PluginToolbarButton which randomizes the BrickColor() of each selected part using BrickColor.random(). Furthermore, the button is only enabled if at least one part is selected. It does this by detecting changes in the Selection using Selection.SelectionChanged.
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
L'icona determina ciò che icon dovrebbe essere mostrato per il pulsante nella barra degli strumenti del plugin.Quando questa proprietà non è Impostare, il pulsante userà invece il testo del pulsante fornito da PluginToolbar:CreateButton() .
Metodi
SetActive
Questo metodo può essere utilizzato per impostare manualmente lo stato attivo del pulsante del plugin.
Quando la proprietà Enabled viene riattivata, il pulsante ripristinerà l'ultimo stato impostato da questo metodo o passa inattivo se questo metodo non è stato utilizzato in precedenza.
Parametri
Restituzioni
Eventi
Click
Fai clic scoppia quando il pulsante PluginToolbarButton viene premuto e rilasciato dall'utente.
Fare clic su un pulsante PluginToolbarButton fa attivare/disattivarelo stato del pulsante. Chiama SetActive per impostare manualmente lo stato del pulsante.
Campioni di codice
This code sample demonstrates creating a PluginToolbar and a PluginToolbarButton on it, then connecting a function onClick to the PluginToolbarButton.Click event. When pressed, the button will print "Hello, world" to the output.
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)