PluginToolbarButton

Mostrar obsoleto

*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.

No creable

Un botón de barra de plugins es un objeto creado por la función PluginToolbar:CreateButton().Permite al usuario iniciar una acción única y puntual en Roblox Studio a través del evento Click.

Cuando se presiona, se activa el evento Click.Un botón también permanecerá en el estado presionado, que se puede configurar manualmente usando SetActive .Al activar el plugin ( Plugin:Activate() ), los botones en todos los demás PluginToolbars se desactivarán.Si todos los botones en una barra de herramientas están desactivados, el plugin de la barra de herramientas se desactiva (Plugin:Deactivate()).

Cuando el área de visión del juego no es visible, los botones se desactivarán como si su propiedad Enabled fuera falsa.Los botones deshabilitados están desaturados y no responden a los clics del usuario.Al establecer ClickableWhenViewportHidden en verdad, puedes permitir que los botones de plugin sigan siendo clicables (como durante la edición de scripts).

Resumen

Propiedades

  • No replicado
    Leer paralelo

    Determina si el botón se puede hacer clic cuando el área de visualización del juego está oculta, como mientras se edita un script en una pestaña diferente de Studio.

  • No replicado
    Leer paralelo

    Determina si el botón es clicable en general.

  • Icon:ContentId
    No replicado
    Leer paralelo

    Determina qué icono debe representar el botón.

Métodos

  • SetActive(active : boolean):()
    Seguridad del plugin

    Establece el estado del botón del plugin.

Eventos

  • Seguridad del plugin

    Se activa cuando el usuario presiona y suelta su cursor en el botón.

Propiedades

ClickableWhenViewportHidden

No replicado
Leer paralelo

ClickableWhenViewportHidden determina si se puede hacer clic en un botón de barra de plugins mientras el campo de visión del juego está oculto, como cuando se está editando un Script en una pestaña diferente.

Típicamente, esta propiedad es buena para habilitar si una acción desencadenada por el evento de un botón de plugin no ocurre en el mundo del juego (Espacio de trabajo).Por ejemplo, un botón que abre un widget debe tener esta propiedad como verdadera, ya que mostrar un widget es visible para el usuario incluso si la vista del juego no es visible.

Enabled

No replicado
Leer paralelo

Activado determina si un botón es clicable en general.Cuando esta propiedad es falsa, el botón se desactivará y no se podrá hacer clic, lo que impide que el usuario dispare el evento Click.Los botones se habilitan por defecto.

Al rehabilitar esta propiedad, el estado del botón del plugin no se recordará del estado anterior en el que el usuario dejó el botón.En cambio, se predeterminará el último estado establecido por SetActive() o el estado inactivo si SetActive() nunca se usó.

Los plugins deben desactivar sus botones cuando la acción de botón no es relevante en el contexto actual.Por ejemplo, un botón de plugin que asigna colores aleatorios a los seleccionados no debe habilitarse cuando la selección no contenga partes.Vea los ejemplos de código para obtener más información.

Vea también:

Muestras de código

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
No replicado
Leer paralelo

El icono determina qué icon debe mostrarse para el botón en la barra de herramientas del plugin.Cuando esta propiedad no está establecer, el botón usará el texto del botón dado por PluginToolbar:CreateButton() en su lugar.

Métodos

SetActive

()
Seguridad del plugin

Este método se puede usar para establecer manualmente el estado activo del botón del plugin.

Cuando la propiedad Enabled se alterna de nuevo, el botón se revertirá al último estado establecido por este método o se volverá inactivo si este método no se ha utilizado previamente.

Parámetros

active: boolean
Valor predeterminado: ""

Devuelve

()

Eventos

Click

Seguridad del plugin

Haga clic se enciende cuando el botón PluginToolbar se presiona y se libera por el usuario.

Al hacer clic en un botón de la barra de plugins, se alternar/activarel estado del botón. Llama a SetActive para establecer el estado del botón de forma manual.


Muestras de código

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)