PluginToolbarButton
*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.
Ein PluginToolbarButton ist ein Objekt, das von der PluginToolbar:CreateButton() Funktion erstellt wurde.Es ermöglicht dem Benutzer, eine einzelne, einmalige Aktion in Roblox Studio durch das Click-Ereignis zu starten.
Wenn gedrückt wird, wird das Click-Ereignis ausgelöst.Eine Schaltfläche bleibt auch im gedrückten Zustand, der manuell mit SetActive festgelegt werden kann.Bei der Aktivierung des Plugins ( Plugin:Activate() ), werden die Schaltflächen in allen anderen PluginToolbars deaktiviert.Wenn alle Schaltflächen in einer Schaltflächenleiste deaktiviert sind, wird das Plugin der Schaltflächenleiste deaktiviert ( Plugin:Deactivate() ).
Wenn der Spiel-Ansichtsbereich nicht sichtbar ist, werden Schaltflächen deaktiviert, als wäre ihre Enabled Eigenschaft falsch.Deaktivierte Schaltflächen sind desaturiert und reagieren nicht auf Benutzerklicks.Durch die Festlegung von ClickableWhenViewportHidden auf wahr können Sie Plugin-Buttons erlauben, weiterhin anklickbar zu bleiben (z. B. während der Skriptbearbeitung).
Zusammenfassung
Eigenschaften
Bestimmt, ob die Schaltfläche angeklickt werden kann, wenn der Spiel-Ansichtsbereich versteckt ist, wie zum Beispiel während der Bearbeitung eines Skripts in einem anderen Studio-Tab.
Bestimmt, ob die Schaltfläche im Allgemeinen anklickbar ist.
Bestimmt, welches Symbol die Schaltfläche repräsentieren soll.
Methoden
Legt den Zustand des Plugin-Buttons fest.
Ereignisse
Feuert, wenn der Benutzer seine Maus auf die Schaltfläche drückt und dann loslässt.
Eigenschaften
ClickableWhenViewportHidden
KlickbarWennViewportHidden bestimmt, ob ein PluginToolbarButton angeklickt werden kann, während der Spiel-Viewport versteckt ist, z. B. wenn ein Script in einem anderen Tab bearbeitet wird.
In der Regel ist diese Eigenschaft gut, um zu aktivieren, wenn eine Aktion, die durch das Ereignis eines Plugin-Buttons ausgelöst wird, nicht in der Spielwelt (Arbeitsbereich) auftritt.Zum Beispiel sollte eine Schaltfläche, die ein Widget öffnet, diese Eigenschaft wahr haben, da das Anzeigen eines Widgets für den Benutzer sichtbar ist, auch wenn die Spielansicht nicht sichtbar ist.
Enabled
Aktiviert bestimmt, ob ein Button im Allgemeinen anklickbar ist.Wenn diese Eigenschaft falsch ist, wird die Schaltfläche ausgegraut und nicht anklickbar, was den Benutzer daran hindert, das Ereignis Click zu feuern.Knöpfe sind standardmäßig aktiviert.
Wenn diese Eigenschaftenwieder aktiviert wird, wird der Zustand des Plugin-Buttons nicht aus dem vorherigen Zustand gespeichert, in dem der Benutzer den Button verlassen hat.Stattdessen wird der letzte Zustand, der durch SetActive() festgelegt wurde, oder der inaktive Zustand verwendet, wenn SetActive() nie verwendet wurde.
Plugins sollten ihre Schaltflächen deaktivieren, wenn die Schaltflächenaktion im aktuellen Kontext nicht relevant ist.Zum Beispiel sollte ein Plugin-Button, der zufällige Farben für ausgewählte Teile zuweist, nicht aktiviert werden, wenn die Auswahl keine Teile enthält.Siehe die Codebeispiele für weitere Informationen.
Siehe auch:
- ClickableWhenViewportHidden , das bestimmt, ob eine schaltfläche anklickbar ist, wenn die spielansicht ausgeblendet wird (und nicht nur im allgemeinen)
Code-Beispiele
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
Symbol bestimmt, was icon für die Schaltfläche in der Plugin-Symbolleiste angezeigt werden soll.Wenn diese Eigenschaft nicht festlegenist, verwendet die Schaltfläche stattdessen den Text der Schaltfläche, der von PluginToolbar:CreateButton() gegeben wird.
Methoden
SetActive
Diese Methode kann verwendet werden, um den aktiven Zustand des Plugin-Buttons manuell festzulegen.
Wenn die Enabled-Eigenschaft wieder eingeschaltet wird, kehrt die Schaltfläche entweder in den letzten Zustand zurück, der durch diese Methode festgelegt wurde, oder sie wird standardmäßig inaktiv, wenn diese Methode zuvor nicht verwendet wurde.
Parameter
Rückgaben
Ereignisse
Click
Klicken feuert ab, wenn der PluginToolbarButton vom Benutzer gedrückt und freigelassen wird.
Das Anklicken eines PluginToolbar-Buttons verändert den Zustand des Buttons. Rufe SetActive auf, um den Zustand des Buttons manuell zu setzen.
Code-Beispiele
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)