PluginToolbarButton

Mostrar obsoleto

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Não criável

Um Botão de Barra de Plugins é um objeto criado pela função PluginToolbar:CreateButton().Permite que o usuário inicie uma ação única e isolada no Roblox Studio através do evento Click.

Quando pressionado, o evento Click é acionado.Um botão também permanecerá no estado pressionado, que pode ser definido manualmente usando SetActive.Após a ativação do plugin ( Plugin:Activate() ), os botões em todos os outros PluginToolbars serão desativados.Se todos os botões em uma barra de ferramentas estiverem desligado, o plugin da barra de ferramentas é desativado ( Plugin:Deactivate() ).

Quando a janela de visualização do jogo não é visível, os botões serão desativados como se sua propriedade Enabled fosse falsa.Botões desativados são desaturados e não respondem a cliques do usuário.Ao definir ClickableWhenViewportHidden para verdadeiro, você pode permitir que os botões de plugin permaneçam clicáveis (como durante a edição de scripts).

Resumo

Propriedades

  • Não replicado
    Ler Parallel

    Determina se o botão pode ser clicado quando o campo de visão do jogo está oculto, como ao editar um script em uma aba diferente do Studio.

  • Não replicado
    Ler Parallel

    Determina se o botão é clicável em geral.

  • Icon:ContentId
    Não replicado
    Ler Parallel

    Determina qual ícone deve representar o botão.

Métodos

  • SetActive(active : boolean):()
    Segurança do plugin

    Define o estado do botão do plugin.

Eventos

  • Segurança do plugin

    Dispara quando o usuário pressiona e libera o cursor no botão.

Propriedades

ClickableWhenViewportHidden

Não replicado
Ler Parallel

ClicávelQuandoViewportHidden determina se um Botão de Barra de Plugins pode ser clicado enquanto o campo de visão do jogo está oculto, como quando um Script está sendo editado em outa aba.

Normalmente, essa propriedade é boa para habilitar se uma ação acionada pelo evento de um botão de plugin não ocorrer no mundo do jogo (Workspacede Trabalho).Por exemplo, um botão que abre um widget deve ter essa propriedade verdadeira, como mostrar um widget é visível para o usuário mesmo se a visualização do jogo não for visível.

Enabled

Não replicado
Ler Parallel

Ativado determina se um botão é clicável em geral.Quando essa propriedade é falsa, o botão será cinza e inacessível, impedindo o usuário de disparar o evento Click.Botões são habilitados por padrão.

Ao reativar essa propriedade, o estado do botão do plugin não será lembrado do estado anterior em que o usuário deixou o botão.Em vez disso, ele padronizará para o último estado definido por SetActive() ou para o estado inativo se SetActive() nunca foi usado.

Plugins devem desativar seus botões quando a ação do botão não for relevante no contexto atual.Por exemplo, um botão de plugin que atribui cores aleatórias aos selecionados não deve ser ativado quando a seleção não contém partes.Veja os exemplos de código para mais informações.

Veja também:

  • ClickableWhenViewportHidden , que determina se um botão é clicável quando a visualização do jogo é oculta (e não apenas em geral)

Amostras 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
Não replicado
Ler Parallel

Ícone determina o que icon deve ser mostrado para o botão na barra de ferramentas do plugin.Quando essa propriedade não é configurar, o botão usará o texto do botão fornecido por PluginToolbar:CreateButton() em vez disso.

Métodos

SetActive

()
Segurança do plugin

Este método pode ser usado para definir manualmente o estado ativo do botão do plugin.

Quando a propriedade Enabled é ativada novamente, o botão retornará ao último estado definido por este método ou padrão inativo se este método não tiver sido usado anteriormente.

Parâmetros

active: boolean
Valor Padrão: ""

Devolução

()

Eventos

Click

Segurança do plugin

Clique dispara quando o PluginToolbarButton é pressionado e liberado pelo usuário.

Clicar em um botão da barra de plugins causa a alternardo estado do botão. Chame SetActive para definir manualmente o estado do botão.


Amostras 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)