PluginToolbarButton

Pokaż przestarzałe

*Ta zawartość została przetłumaczona przy użyciu narzędzi AI (w wersji beta) i może zawierać błędy. Aby wyświetlić tę stronę w języku angielskim, kliknij tutaj.

Brak możliwości tworzenia

Przycisk paska narzędzi jest obiektem utworzonym przez funkcję PluginToolbar:CreateButton().Umożliwia użytkownikowi uruchomienie pojedynczej, jednorazowej akcji w Roblox Studio za pomocą wydarzenia Click.

Gdy naciśnięty, wydarzenie Click uruchamia się.Przycisk pozostanie również w naciśniętym stanie, który można ustawić ręcznie za pomocą SetActive .Po aktywacji pluginu ( Plugin:Activate() ), przyciski we wszystkich innych PluginToolbars zostaną wyłączone.Jeśli wszystkie przyciski w pasku narzędzi są wyłączone, wtyczka paska narzędzi jest dezaktywowana (Plugin:Deactivate()).

Gdy punkt widzenia gry nie jest widoczny, przyciski zostaną wyłączone, tak jak gdyby ich właściwość Enabled była fałszywa.Wyłączone przyciski są zdezaturowane i nie reagują na kliknięcia użytkownika.Ustawiając ClickableWhenViewportHidden na prawdę, możesz pozwolić, aby przyciski pluginów pozostały klikalne (na przykład podczas edycji skryptów).

Podsumowanie

Właściwości

  • Bez replikacji
    Odczyt równoległy

    Określa, czy przycisk może zostać kliknięty, gdy okno widoku gry jest ukryte, na przykład podczas edytowania skryptu w innym oknie Studio.

  • Bez replikacji
    Odczyt równoległy

    Określa, czy przycisk jest klikalny ogólne.

  • Icon:ContentId
    Bez replikacji
    Odczyt równoległy

    Określa, jaką ikonę powinien reprezentować przycisk.

Metody

  • SetActive(active : boolean):()
    Zabezpieczenia dodatku plug-in

    Ustawia stan przycisku pluginu.

Zdarzenia

  • Zabezpieczenia dodatku plug-in

    Wystrzeliwuje, gdy użytkownik naciśnie i uwolni kursor na przycisku.

Właściwości

ClickableWhenViewportHidden

Bez replikacji
Odczyt równoległy

Można kliknąć, gdy widok okna jest ukryty określa, czy przycisk paska narzędzi może zostać kliknięty, gdy widok gry jest ukryty, na przykład, gdy Script jest edytowany w innym tablicy.

Zazwyczaj właściwość ta jest dobra do włączenia, jeśli akcja uruchomiona przez wydarzenie Click przycisku pluginowego nie wystąpi w świecie gry (Przestrzeni roboczej).Na przykład przycisk otwierający widget powinien mieć tę właściwość prawdziwą, ponieważ wyświetlanie widgetu jest widoczne dla użytkownika, nawet jeśli widok gry nie jest widoczny.

Enabled

Bez replikacji
Odczyt równoległy

Włączone określa, czy przycisk jest klikalny ogólne.Gdy ta właściwość jest fałszywa, przycisk zostanie wyłączony i nieklikalny, uniemożliwiając użytkownikowi uruchomienie wydarzenia Click.Przyciski są włączone domyślnie.

Podczas ponownego włączania tej właściwości stan przycisku plugin nie zostanie zapamiętany z poprzedniego stanu, w którym użytkownik opuścił przycisk.Zamiast tego domyślnie zostanie ustawiony ostatni stan ustawiony przez SetActive() lub nieaktywny stan, jeśli SetActive() nigdy nie został użyty.

Wtyczki powinny wyłączyć swoje przyciski, gdy działanie przycisku nie jest odpowiednie w obecnym kontekście.Na przykład przycisk pluginu, który przypisuje losowe kolory do wybranych, nie powinien być włączony, gdy wybór nie zawiera części.Zobacz przykłady kodu dla więcej informacji.

Zobacz także:

Przykłady kodu

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.

BrickColor Randomizer Plugin

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

ContentId
Bez replikacji
Odczyt równoległy

Ikona określa, co icon powinno być wyświetlone dla przycisku w pasku narzędzi pluginów.Gdy ta właściwość nie jest ustawiać, przycisk zamiast tego użyje tekstu przycisku podanego przez PluginToolbar:CreateButton() .

Metody

SetActive

()
Zabezpieczenia dodatku plug-in

Ta metoda może być użyta do ręcznego ustawienia aktywnego stanu przycisku pluginu.

Gdy właściwość Enabled zostanie ponownie włączona, przycisk zostanie przywrócony do ostatniego stanu ustawionego przez tę metodę lub zostanie ustawiony na nieaktywny, jeśli ta metoda nie została wcześniej użyta.

Parametry

active: boolean
Wartość domyślna: ""

Zwroty

()

Zdarzenia

Click

Zabezpieczenia dodatku plug-in

Kliknij ogień wystrzeliwuje się, gdy PluginToolbarButton jest naciśnięty i uwolniony przez użytkownika.

Kliknięcie przycisku paska narzędzi spowoduje przełączenie stanu przycisku. Zadzwoń SetActive , aby ręcznie ustawić stan przycisku.


Przykłady kodu

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.

PluginToolbarButton.Click

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)