PluginGui | 文書 - Roblox クリエーターハブ

エンジンクラス

PluginGui

作成できません

複製されていません

*このコンテンツは、ベータ版のAI（人工知能）を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、こちらをクリックしてください。

概要

プロパティ

Title:string

方法

BindToClose(function: function):()

GetRelativeMousePosition():Vector2

イベント

PluginDragDropped(dragData: Dictionary):RBXScriptSignal

PluginDragEntered(dragData: Dictionary):RBXScriptSignal

PluginDragLeft(dragData: Dictionary):RBXScriptSignal

PluginDragMoved(dragData: Dictionary):RBXScriptSignal

WindowFocused():RBXScriptSignal

WindowFocusReleased():RBXScriptSignal

継承されたメンバー

LayerCollectorから継承された4

GuiBase2dから継承された12

Instanceから継承された57

Objectから継承された6

継承者

DockWidgetPluginGui, QWidgetPluginGui

APIリファレンス

プロパティ

Title

並列読み取り

機能： UI

PluginGui.Title:string

方法

BindToClose

機能： UI

PluginGui:BindToClose(function:function):()

パラメータ

function:function

既定値: "nil"

戻り値

()

GetRelativeMousePosition

プラグインのセキュリティ

機能： UI

PluginGui:GetRelativeMousePosition():Vector2

戻り値

Vector2

コードサンプル

PluginGui:相対マウス位置を取得する

local RunService = game:GetService("RunService")

local widgetInfo = DockWidgetPluginGuiInfo.new(
	Enum.InitialDockState.Float,
	true,
	false, -- 有効な状態、オーバーライド
	200,
	300, -- サイズ
	150,
	150 -- 最小サイズ
)

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

イベント

PluginDragDropped

プラグインのセキュリティ

機能： UI

PluginGui.PluginDragDropped(dragData:Dictionary):RBXScriptSignal

パラメータ

dragData:Dictionary

コードサンプル

プラグインのドラッグアンドドロップ

assert(plugin, "このスクリプトはスタジオプラグインとして実行する必要があります")

local widgetInfo = DockWidgetPluginGuiInfo.new(Enum.InitialDockState.Float, true, true, 300, 200)

local dragSourceWidget = plugin:CreateDockWidgetPluginGuiAsync("ドラッグソース", widgetInfo)
dragSourceWidget.Title = "ドラッグソース"

local textBox = Instance.new("TextBox")
textBox.Parent = dragSourceWidget
textBox.Size = UDim2.new(1, 0, 0, 32)
textBox.Text = "こんにちは、プラグインドラッグ"

local dragButton = Instance.new("TextButton")
dragButton.Size = UDim2.new(1, 0, 1, -32)
dragButton.Position = UDim2.new(0, 0, 0, 32)
dragButton.Text = "上のテキストを編集して、ここでドラッグを開始してください"
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)

-- このウィジェットはドロップを受け取ります
local dragTargetWidget = plugin:CreateDockWidgetPluginGuiAsync("ドロップターゲット", widgetInfo)
dragTargetWidget.Title = "ドロップターゲット"

-- このTextLabelはドロップされたものを表示します
local textLabel = Instance.new("TextLabel")
textLabel.Size = UDim2.new(1, 0, 1, 0)
textLabel.Text = "ここにドロップ..."
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

プラグインのセキュリティ

機能： UI

PluginGui.PluginDragEntered(dragData:Dictionary):RBXScriptSignal

パラメータ

dragData:Dictionary

コードサンプル

プラグインのドラッグアンドドロップ

assert(plugin, "このスクリプトはスタジオプラグインとして実行する必要があります")

local widgetInfo = DockWidgetPluginGuiInfo.new(Enum.InitialDockState.Float, true, true, 300, 200)

local dragSourceWidget = plugin:CreateDockWidgetPluginGuiAsync("ドラッグソース", widgetInfo)
dragSourceWidget.Title = "ドラッグソース"

local textBox = Instance.new("TextBox")
textBox.Parent = dragSourceWidget
textBox.Size = UDim2.new(1, 0, 0, 32)
textBox.Text = "こんにちは、プラグインドラッグ"

local dragButton = Instance.new("TextButton")
dragButton.Size = UDim2.new(1, 0, 1, -32)
dragButton.Position = UDim2.new(0, 0, 0, 32)
dragButton.Text = "上のテキストを編集して、ここでドラッグを開始してください"
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)

-- このウィジェットはドロップを受け取ります
local dragTargetWidget = plugin:CreateDockWidgetPluginGuiAsync("ドロップターゲット", widgetInfo)
dragTargetWidget.Title = "ドロップターゲット"

-- このTextLabelはドロップされたものを表示します
local textLabel = Instance.new("TextLabel")
textLabel.Size = UDim2.new(1, 0, 1, 0)
textLabel.Text = "ここにドロップ..."
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

プラグインのセキュリティ

機能： UI

PluginGui.PluginDragLeft(dragData:Dictionary):RBXScriptSignal

パラメータ

dragData:Dictionary

コードサンプル

プラグインのドラッグアンドドロップ

assert(plugin, "このスクリプトはスタジオプラグインとして実行する必要があります")

local widgetInfo = DockWidgetPluginGuiInfo.new(Enum.InitialDockState.Float, true, true, 300, 200)

local dragSourceWidget = plugin:CreateDockWidgetPluginGuiAsync("ドラッグソース", widgetInfo)
dragSourceWidget.Title = "ドラッグソース"

local textBox = Instance.new("TextBox")
textBox.Parent = dragSourceWidget
textBox.Size = UDim2.new(1, 0, 0, 32)
textBox.Text = "こんにちは、プラグインドラッグ"

local dragButton = Instance.new("TextButton")
dragButton.Size = UDim2.new(1, 0, 1, -32)
dragButton.Position = UDim2.new(0, 0, 0, 32)
dragButton.Text = "上のテキストを編集して、ここでドラッグを開始してください"
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)

-- このウィジェットはドロップを受け取ります
local dragTargetWidget = plugin:CreateDockWidgetPluginGuiAsync("ドロップターゲット", widgetInfo)
dragTargetWidget.Title = "ドロップターゲット"

-- このTextLabelはドロップされたものを表示します
local textLabel = Instance.new("TextLabel")
textLabel.Size = UDim2.new(1, 0, 1, 0)
textLabel.Text = "ここにドロップ..."
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

プラグインのセキュリティ

機能： UI

PluginGui.PluginDragMoved(dragData:Dictionary):RBXScriptSignal

パラメータ

dragData:Dictionary

WindowFocused

プラグインのセキュリティ

機能： UI

PluginGui.WindowFocused():RBXScriptSignal

コードサンプル

PluginGuiフォーカス状態の検出

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

local widget = plugin:CreateDockWidgetPluginGuiAsync("テストウィジェット", info)

local function onFocusReleased()
	widget.Title = "フォーカスが外れました :("
end

local function onFocused()
	widget.Title = "フォーカスがあります :D"
end

widget.WindowFocusReleased:Connect(onFocusReleased)

widget.WindowFocused:Connect(onFocused)

WindowFocusReleased

プラグインのセキュリティ

機能： UI

PluginGui.WindowFocusReleased():RBXScriptSignal

コードサンプル

PluginGuiフォーカス状態の検出

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

local widget = plugin:CreateDockWidgetPluginGuiAsync("テストウィジェット", info)

local function onFocusReleased()
	widget.Title = "フォーカスが外れました :("
end

local function onFocused()
	widget.Title = "フォーカスがあります :D"
end

widget.WindowFocusReleased:Connect(onFocusReleased)

widget.WindowFocused:Connect(onFocused)

PluginGui

GetRelativeMousePosition()

WindowFocusReleased()