Aprenda
Classe do mecanismo
Plugin
Não criável

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


Resumo
Métodos
Activate(exclusiveMouse: boolean):()
CreateDockWidgetPluginGui(pluginGuiId: string,dockWidgetPluginGuiInfo: DockWidgetPluginGuiInfo):DockWidgetPluginGui
Obsoleto
CreatePluginAction(actionId: string,text: string,statusTip: string,iconName: string,allowBinding: boolean):PluginAction
GetSetting(key: string):Variant
ImportFbxAnimation(rigModel: Instance,isR15: boolean):Instance
Obsoleto
ImportFbxRig(isR15: boolean):Instance
Obsoleto
Intersect(objects: Instances):Instance
Negate(objects: Instances):Instances
OpenScript(script: LuaSourceContainer,lineNumber: number):()
Obsoleto
PromptSaveSelection(suggestedFileName: string):boolean
Obsoleto
Separate(objects: Instances):Instances
SetSetting(key: string,value: Variant):()
StartDrag(dragData: Dictionary):()
Union(objects: Instances):Instance
Membros herdados
Amostras de código
Script - Passe o Global do Plugin para um ModuleScript
assert(plugin, "Este script deve ser executado como um plugin!")
-- O código além deste ponto será executado apenas se o script for executado como um plugin
-- Carregue o módulo e passe a referência do plugin
local pluginModule = require(script.Parent.PluginModule)
pluginModule:Initialize(plugin)
-- Verifique se a referência do plugin foi inicializada
pluginModule:CheckForPluginGlobal()
MóduloScript - Receber e Armazenar o Global do Plugin
local pluginModule = {}
local plugin -- Referência local do plugin
-- Inicializa a referência do plugin se ainda não estiver definida
function pluginModule:Initialize(pluginReference: Plugin)
if plugin ~= pluginReference then
plugin = pluginReference
else
error("O plugin já está inicializado")
end
end
-- Verifica se a referência do plugin está definida e imprime as informações adequadas
function pluginModule:CheckForPluginGlobal()
if plugin ~= nil then
print("A referência do plugin está definida!")
else
warn("A referência do plugin está faltando!")
end
end
return pluginModule

Referência API
Propriedades
CollisionEnabled
Somente leitura
Não replicado
Ler Parallel
Plugin.CollisionEnabled:boolean

DisableUIDragDetectorDrags
Segurança do script Roblox
Ler Parallel
Plugin.DisableUIDragDetectorDrags:boolean

GridSize
Somente leitura
Não replicado
Ler Parallel
Plugin.GridSize:number

IsDebuggable
Segurança do script Roblox
Ler Parallel
Plugin.IsDebuggable:boolean

Métodos
Activate
Segurança do plugin
Plugin:Activate(exclusiveMouse:boolean):()
Parâmetros
exclusiveMouse:boolean
Devolução
()

CreateDockWidgetPluginGui
Obsoleto

CreateDockWidgetPluginGuiAsync
Rendimentos
Segurança do plugin
Plugin:CreateDockWidgetPluginGuiAsync(
pluginGuiId:string, dockWidgetPluginGuiInfo:DockWidgetPluginGuiInfo
Parâmetros
pluginGuiId:string
dockWidgetPluginGuiInfo:DockWidgetPluginGuiInfo
Amostras de código
Botão de Texto do GUI do Widget
-- Crie um novo objeto 'DockWidgetPluginGuiInfo'
local widgetInfo = DockWidgetPluginGuiInfo.new(
Enum.InitialDockState.Float, -- O widget será inicializado em um painel flutuante
true, -- O widget estará inicialmente ativado
false, -- Não sobrescrever o estado ativado anterior
200, -- Largura padrão da janela flutuante
300, -- Altura padrão da janela flutuante
150, -- Largura mínima da janela flutuante (opcional)
150 -- Altura mínima da janela flutuante (opcional)
)
-- Crie uma nova GUI de widget
local testWidget = plugin:CreateDockWidgetPluginGuiAsync("TestWidget", widgetInfo)
local testButton = Instance.new("TextButton")
testButton.BorderSizePixel = 0
testButton.TextSize = 20
testButton.TextColor3 = Color3.new(1, 0.2, 0.4)
testButton.AnchorPoint = Vector2.new(0.5, 0.5)
testButton.Size = UDim2.new(1, 0, 1, 0)
testButton.Position = UDim2.new(0.5, 0, 0.5, 0)
testButton.SizeConstraint = Enum.SizeConstraint.RelativeYY
testButton.Text = "Clique em Mim"
testButton.Parent = testWidget

CreatePluginAction
Segurança do plugin
Plugin:CreatePluginAction(
actionId:string, text:string, statusTip:string, iconName:string, allowBinding:boolean
Parâmetros
actionId:string
text:string
statusTip:string
iconName:string
allowBinding:boolean
Valor Padrão: true
Devolução
Amostras de código
Criando um PluginAction
local pluginAction = plugin:CreatePluginAction(
"HelloWorldAction",
"Hello World",
"Imprime um 'Hello world!'",
"rbxasset://textures/sparkle.png",
true
)
pluginAction.Name = "Teste de Ação"
local function actionTriggered()
print("Hello world!")
end
pluginAction.Triggered:Connect(actionTriggered)

CreatePluginMenu
Segurança do plugin
Plugin:CreatePluginMenu(
id:string, title:string, icon:string
Parâmetros
title:string
icon:string
Devolução
Amostras de código
Criando um PluginMenu e PluginMenuAction
-- Este código pode ser colado na Barra de Comando, mas apenas uma vez
local pluginMenu = plugin:CreatePluginMenu(math.random(), "Menu de Teste")
pluginMenu.Name = "Menu de Teste"
pluginMenu:AddNewAction("AçãoA", "A", "rbxasset://textures/loading/robloxTiltRed.png")
pluginMenu:AddNewAction("AçãoB", "B", "rbxasset://textures/loading/robloxTilt.png")
local subMenu = plugin:CreatePluginMenu(math.random(), "C", "rbxasset://textures/explosion.png")
subMenu.Name = "Sub Menu"
subMenu:AddNewAction("AçãoD", "D", "rbxasset://textures/whiteCircle.png")
subMenu:AddNewAction("AçãoE", "E", "rbxasset://textures/icon_ROBUX.png")
pluginMenu:AddMenu(subMenu)
pluginMenu:AddSeparator()
pluginMenu:AddNewAction("AçãoF", "F", "rbxasset://textures/sparkle.png")
local toggle = Instance.new("BoolValue")
toggle.Name = "TogglePluginMenu"
toggle.Parent = workspace
local function onToggled()
if toggle.Value then
toggle.Value = false
local selectedAction = pluginMenu:ShowAsync()
if selectedAction then
print("Ação Selecionada:", selectedAction.Text, "com ActionId:", selectedAction.ActionId)
else
print("O usuário não selecionou uma ação!")
end
end
end
toggle.Changed:Connect(onToggled)

CreateToolbar
Segurança do plugin
Plugin:CreateToolbar(name:string):PluginToolbar
Parâmetros
name:string
Devolução
Amostras de código
Plugin:CreateToolbar
plugin:CreateToolbar("ExemploBarraDeFerramentas")

Deactivate
Segurança do plugin
Plugin:Deactivate():()
Devolução
()

GetJoinMode
Segurança do plugin
Plugin:GetJoinMode():Enum.JointCreationMode

GetMouse
Segurança do plugin
Plugin:GetMouse():PluginMouse
Devolução
Amostras de código
Plugin:GetMouse
local mouse = plugin:GetMouse()
local function button1Down()
print("Botão 1 pressionado do PluginMouse")
end
mouse.Button1Down:Connect(button1Down)

GetSelectedRibbonTool
Segurança do plugin
Plugin:GetSelectedRibbonTool():Enum.RibbonTool
Devolução
Amostras de código
Plugin:GetSelectedRibbonTool
plugin:SelectRibbonTool(Enum.RibbonTool.Move, UDim2.new())
task.wait() -- espera pelo próximo quadro
local selectedRibbonTool = plugin:GetSelectedRibbonTool()
print("A ferramenta RibbonTool selecionada é", selectedRibbonTool)

GetSetting
Segurança do plugin
Plugin:GetSetting(key:string):Variant
Parâmetros
key:string
Devolução
Variant
Amostras de código
Plugin:GetSetting
local RAN_BEFORE_KEY = "RanBefore"
local didRunBefore = plugin:GetSetting(RAN_BEFORE_KEY)
if didRunBefore then
print("Bem-vindo de volta!")
else
plugin:SetSetting(RAN_BEFORE_KEY, true)
print("Bem-vindo! Obrigado por instalar este plugin!")
end

GetStudioUserId
Obsoleto

ImportFbxAnimation
Obsoleto

ImportFbxAnimationAsync
Rendimentos
Segurança do plugin
Plugin:ImportFbxAnimationAsync(
rigModel:Instance, isR15:boolean
Parâmetros
rigModel:Instance
isR15:boolean
Valor Padrão: true
Devolução

ImportFbxRig
Obsoleto

ImportFbxRigAsync
Rendimentos
Segurança do plugin
Plugin:ImportFbxRigAsync(isR15:boolean):Instance
Parâmetros
isR15:boolean
Valor Padrão: true
Devolução

Intersect
Segurança do plugin
Plugin:Intersect(objects:Instances):Instance
Parâmetros
objects:Instances
Devolução

IsActivated
Segurança do plugin
Plugin:IsActivated():boolean
Devolução

IsActivatedWithExclusiveMouse
Segurança do plugin
Plugin:IsActivatedWithExclusiveMouse():boolean
Devolução

Negate
Segurança do plugin
Plugin:Negate(objects:Instances):Instances
Parâmetros
objects:Instances
Devolução
Instances

OpenScript
Obsoleto

OpenWikiPage
Segurança do plugin
Plugin:OpenWikiPage(url:string):()
Parâmetros
url:string
Devolução
()
Amostras de código
Plugin:OpenWikiPage
plugin:OpenWikiPage("API:Class/BasePart")

PromptForExistingAssetId
Rendimentos
Segurança do plugin
Plugin:PromptForExistingAssetId(assetType:string):number
Parâmetros
assetType:string
Devolução

PromptForExistingAssetIdAsync
Rendimentos
Segurança do plugin
Plugin:PromptForExistingAssetIdAsync(assetType:string):number
Parâmetros
assetType:string
Devolução

PromptSaveSelection
Obsoleto

PromptSaveSelectionAsync
Rendimentos
Segurança do plugin
Plugin:PromptSaveSelectionAsync(suggestedFileName:string):boolean
Parâmetros
suggestedFileName:string
Devolução

SaveSelectedToRoblox
Segurança do plugin
Plugin:SaveSelectedToRoblox():()
Devolução
()

SelectRibbonTool
Segurança do plugin
Plugin:SelectRibbonTool(
tool:Enum.RibbonTool, position:UDim2
):()
Parâmetros
position:UDim2
Devolução
()

Separate
Segurança do plugin
Plugin:Separate(objects:Instances):Instances
Parâmetros
objects:Instances
Devolução
Instances

SetSetting
Segurança do plugin
Plugin:SetSetting(
key:string, value:Variant
):()
Parâmetros
key:string
value:Variant
Devolução
()
Amostras de código
Plugin:GetSetting e Plugin:SetSetting
local RAN_BEFORE_KEY = "ExecutarAntes"
local hasRunBefore = plugin:GetSetting(RAN_BEFORE_KEY)
if hasRunBefore then
print("Bem-vindo de volta!")
else
print("Obrigado por instalar este plugin!")
plugin:SetSetting(RAN_BEFORE_KEY, true)
end

StartDrag
Segurança do plugin
Plugin:StartDrag(dragData:Dictionary):()
Parâmetros
dragData:Dictionary
Devolução
()
Amostras de código
Plugin Arrastar e Soltar
assert(plugin, "Este script deve ser executado como um plugin do Studio")
local widgetInfo = DockWidgetPluginGuiInfo.new(Enum.InitialDockState.Float, true, true, 300, 200)
local dragSourceWidget = plugin:CreateDockWidgetPluginGuiAsync("Fonte de Arraste", widgetInfo)
dragSourceWidget.Title = "Fonte de Arraste"
local textBox = Instance.new("TextBox")
textBox.Parent = dragSourceWidget
textBox.Size = UDim2.new(1, 0, 0, 32)
textBox.Text = "Olá, arrastes de plugin"
local dragButton = Instance.new("TextButton")
dragButton.Size = UDim2.new(1, 0, 1, -32)
dragButton.Position = UDim2.new(0, 0, 0, 32)
dragButton.Text = "Edite o texto acima e, em seguida, comece o arraste aqui"
dragButton.Parent = dragSourceWidget
function onMouseButton1Down()
local dragData = {
Sender = "SomeDragSource",
MimeType = "text/plain",
Data = textBox.Text,
MouseIcon = "",
DragIcon = "",
HotSpot = Vector2.new(0, 0),
}
plugin:StartDrag(dragData)
end
dragButton.MouseButton1Down:Connect(onMouseButton1Down)
-- Este widget receberá drops
local dragTargetWidget = plugin:CreateDockWidgetPluginGuiAsync("Alvo de Drop", widgetInfo)
dragTargetWidget.Title = "Alvo de Drop"
-- Este TextLabel exibirá o que foi solto
local textLabel = Instance.new("TextLabel")
textLabel.Size = UDim2.new(1, 0, 1, 0)
textLabel.Text = "Solte aqui..."
textLabel.Parent = dragTargetWidget
local function onDragDrop(dragData)
if dragData.MimeType == "text/plain" then
textLabel.Text = dragData.Data
else
textLabel.Text = dragData.MimeType
end
end
dragTargetWidget.PluginDragDropped:Connect(onDragDrop)
dragTargetWidget.PluginDragEntered:Connect(function(_dragData)
print("PluginDragEntered")
end)
dragTargetWidget.PluginDragLeft:Connect(function(_dragData)
print("PluginDragLeft")
end)
dragTargetWidget.PluginDragMoved:Connect(function(_dragData)
print("PluginDragMoved")
end)

Union
Segurança do plugin
Plugin:Union(objects:Instances):Instance
Parâmetros
objects:Instances
Devolução

Eventos
Deactivation
Segurança do plugin
Plugin.Deactivation():RBXScriptSignal

Unloading
Segurança do plugin
Plugin.Unloading():RBXScriptSignal

©2026 Roblox Corporation, Roblox, o logotipo Roblox e Powering Imagination estão entre nossas marcas registradas e não registradas nos EUA e em outros países.