PluginGui | Documentação - Central de Criadores Roblox

Classe do mecanismo

PluginGui

Não criável

Não replicado

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

Resumo

Propriedades

Title:string

Métodos

BindToClose(function: function):()

GetRelativeMousePosition():Vector2

Eventos

PluginDragDropped(dragData: Dictionary):RBXScriptSignal

PluginDragEntered(dragData: Dictionary):RBXScriptSignal

PluginDragLeft(dragData: Dictionary):RBXScriptSignal

PluginDragMoved(dragData: Dictionary):RBXScriptSignal

WindowFocused():RBXScriptSignal

WindowFocusReleased():RBXScriptSignal

Membros herdados

4 herdada do LayerCollector

12 herdada do GuiBase2d

57 herdada do Instance

6 herdada do Object

Herdado por

DockWidgetPluginGui, QWidgetPluginGui

Referência API

Propriedades

Title

Ler Parallel

Recursos: UI

PluginGui.Title:string

Métodos

BindToClose

Recursos: UI

PluginGui:BindToClose(function:function):()

Parâmetros

function:function

Valor Padrão: "nil"

Devolução

()

GetRelativeMousePosition

Segurança do plugin

Recursos: UI

PluginGui:GetRelativeMousePosition():Vector2

Devolução

Vector2

Amostras de código

PluginGui:ObterPosiçãoDoMouseRelativa

local RunService = game:GetService("RunService")

local widgetInfo = DockWidgetPluginGuiInfo.new(
	Enum.InitialDockState.Float,
	true,
	false, -- Estado ativado, sobrescrever
	200,
	300, -- Tamanho
	150,
	150 -- Tamanho mínimo
)

local testWidget = plugin:CreateDockWidgetPluginGuiAsync("TestWidget", widgetInfo)

function update()
	local v2 = testWidget:GetRelativeMousePosition()
	testWidget.Title = ("(%d, %d)"):format(v2.x, v2.y)
end

RunService.Stepped:Connect(update)

update()

Eventos

PluginDragDropped

Segurança do plugin

Recursos: UI

PluginGui.PluginDragDropped(dragData:Dictionary):RBXScriptSignal

Parâmetros

dragData:Dictionary

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)

PluginDragEntered

Segurança do plugin

Recursos: UI

PluginGui.PluginDragEntered(dragData:Dictionary):RBXScriptSignal

Parâmetros

dragData:Dictionary

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)

PluginDragLeft

Segurança do plugin

Recursos: UI

PluginGui.PluginDragLeft(dragData:Dictionary):RBXScriptSignal

Parâmetros

dragData:Dictionary

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)

PluginDragMoved

Segurança do plugin

Recursos: UI

PluginGui.PluginDragMoved(dragData:Dictionary):RBXScriptSignal

Parâmetros

dragData:Dictionary

WindowFocused

Segurança do plugin

Recursos: UI

PluginGui.WindowFocused():RBXScriptSignal

Amostras de código

Detectando o Estado de Foco do PluginGui

local info = DockWidgetPluginGuiInfo.new(Enum.InitialDockState.Float, true, true, 200, 50, 1, 1)

local widget = plugin:CreateDockWidgetPluginGuiAsync("TesteWidget", info)

local function onFocusReleased()
	widget.Title = "Não estou em foco :("
end

local function onFocused()
	widget.Title = "Estou em foco :D"
end

widget.WindowFocusReleased:Connect(onFocusReleased)

widget.WindowFocused:Connect(onFocused)

WindowFocusReleased

Segurança do plugin

Recursos: UI

PluginGui.WindowFocusReleased():RBXScriptSignal

Amostras de código

Detectando o Estado de Foco do PluginGui

local info = DockWidgetPluginGuiInfo.new(Enum.InitialDockState.Float, true, true, 200, 50, 1, 1)

local widget = plugin:CreateDockWidgetPluginGuiAsync("TesteWidget", info)

local function onFocusReleased()
	widget.Title = "Não estou em foco :("
end

local function onFocused()
	widget.Title = "Estou em foco :D"
end

widget.WindowFocusReleased:Connect(onFocusReleased)

widget.WindowFocused:Connect(onFocused)

PluginGui

GetRelativeMousePosition()

WindowFocusReleased()