Plugin

ユーザーが Collisions をスタジオの [モデル] タブで有効にしているかどうかを返します。

スタジオの モデル または アバター タブの下でユーザーが設定したグリッドスナップサイズを返します。このプロパティは、丸いオフィスで 0.0099999997764826 、または 0.4000000059604645

この関数は、コール中のプラグインの状態を「有効化」に設定します。プラグインを「有効化」すると、マウスコントロールを通過する Plugin:GetMouse() メソッドを通じてマウスコントロールをマウスコントロールをマウスコントロールをマウスコントロールをマウスコントロールをマウスコントロールをマウスコントロールをマウスコントロールをマウスコントロールをマウスコントロールをマウスコントロ

指定された時点には、0個または1個の有効なプラグインがあります。プラグインを有効にすると、他のすべてのプラグインが無効になります (Plugin.Deactivation イベントを受信します)。

参照してください:

• Plugin:IsActivatedWithExclusiveMouse() 、このマウス能を介してアクティブになったプラグインがある場合、 true を返します。
• Plugin.Unloading は、プラグインのアンロードまたは再読み込みを通じてインストールされるため、インストールからすぐに前に発動します

パラメータ

戻り値

この関数は、Roblox Studio の Roblox プラグインアクションを表示するオブジェクトを作成します。これは、Roblox Studio の「<a href=\"#Class.PluginAction\">Class.PluginAction</a>」、「<a href=\"#Toolbar\">Class.PluginAction</a>」、「<a href=\"#еньекбункен» Class.PluginAction</a>」

アクションがトリガーされると、PluginAction.Triggered イベントがシグナルされます。

プラグインアクションが期待通りに機能するには、この関数を使用して作成する必要があります。

参照してください:

• PluginMenu、Studio で表示されるコンテキストメニュー、プラグインアクションのリストを表示し、サブメニューをサポートします
• Plugin:CreatePluginMenu() 、プラグインメニューを作成します

パラメータ

戻り値

local pluginAction = plugin:CreatePluginAction(
	"HelloWorldAction",
	"Hello World",
	"Prints a 'Hello world!'",
	"rbxasset://textures/sparkle.png",
	true
)
pluginAction.Name = "Test Action"

local function actionTriggered()
	print("Hello world!")
end

pluginAction.Triggered:Connect(actionTriggered)

この関数は、PluginMenu を作成します。PluginActions のリストを表示し、サブメニューをサポートします。

プラグインメニューが期待通りに機能するには、この関数を使用して作成する必要があります。

参照してください:

• PluginAction、Roblox Studio のジェネリックな実行可能なアクションを表示するオブジェクト、直接関連付けられていない Toolbar または Enum.Button 。
• Plugin:CreatePluginAction() 、プラグインアクションを作成します
• PluginMenu.Title , サブメニューとして使用されるときに表示されるテキスト
• PluginMenu.Icon 、サブメニューとして使用するときに表示されるアイコン
• PluginMenu:AddAction() 、メニューに指定したアクションを追加します
• PluginMenu:AddNewAction() は、Studio のカスタマイズショートカットウィンドウから隠された一時的なアクションを作成します
• PluginMenu:AddMenu() は、与えられたメニューをセパレータとして追加します
• PluginMenu:AddSeparator() 、メニューのアイテム間のセパレータを追加します
• PluginMenu:Clear() 、メニューをクリアします
• PluginMenu:ShowAsync() は、マウスカーソルのメニューを表示します。選択されたアイテムまたはメニューが閉じるまでには、Yields が続きます。選択されたアクションは、トリガーイベントを発動させます

パラメータ

戻り値

-- This code can be pasted into the command bar, but only once
local pluginMenu = plugin:CreatePluginMenu(math.random(), "Test Menu")
pluginMenu.Name = "Test Menu"

pluginMenu:AddNewAction("ActionA", "A", "rbxasset://textures/loading/robloxTiltRed.png")
pluginMenu:AddNewAction("ActionB", "B", "rbxasset://textures/loading/robloxTilt.png")

local subMenu = plugin:CreatePluginMenu(math.random(), "C", "rbxasset://textures/explosion.png")
subMenu.Name = "Sub Menu"

subMenu:AddNewAction("ActionD", "D", "rbxasset://textures/whiteCircle.png")
subMenu:AddNewAction("ActionE", "E", "rbxasset://textures/icon_ROBUX.png")

pluginMenu:AddMenu(subMenu)
pluginMenu:AddSeparator()

pluginMenu:AddNewAction("ActionF", "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("Selected Action:", selectedAction.Text, "with ActionId:", selectedAction.ActionId)
		else
			print("User did not select an action!")
		end
	end
end

toggle.Changed:Connect(onToggled)

ツールバーは、CreateToolbar 関数で、指定された名前で新しい PluginToolbar を作成します。ツールバーは、プラグインボタンを作成するために使用できます。

パラメータ

戻り値

plugin:CreateToolbar("ExampleToolbar")

プラグインを無効にします。これにより、関連する PluginMouse が有効化されなくなります

参照してください:

• Plugin:Activate() は、呼び出しプラグインの状態を「有効化」に設定します
• Plugin.Deactivation 、プラグインが無効になったときに発動します
• Plugin.Unloading は、プラグインのアンロードまたは再読み込みを通じてインストールされるため、インストールからすぐに前に発動します

戻り値

スタジオの [モデル] タブの下でユーザーが設定した Enum.JointCreationMode を返します。

戻り値

GetMouse は、PluginMouse を返し、Plugin:Activate() を通じてプラグインが有効になっている間に使用できます。

戻り値

local mouse = plugin:GetMouse()

local function button1Down()
	print("Button 1 pressed from PluginMouse")
end

mouse.Button1Down:Connect(button1Down)

GetSelectedRibbonTool は、現在選択されている Enum.RibbonTool を返します。 Plugin:SelectRibbonTool() を通じて特定のツールに対応するエニュームを返します。これは、ツールを手動またはプログラムで選択しているかどうかによってツールが選択されたかどうかを返します。

戻り値

plugin:SelectRibbonTool(Enum.RibbonTool.Move, UDim2.new())
task.wait() -- wait for next frame
local selectedRibbonTool = plugin:GetSelectedRibbonTool()
print("The selected RibbonTool is", selectedRibbonTool)

以前に保存された値を指定されたキーで取り戻すか、指定されたキーが存在しない場合は、nil を取り戻します。

同じプラグインの複数のインスタンスが同時に実行されるため、この値が一度に同じである必要はありません (たとえ多くの Studio ウィンドウが開いている場合)。他のプラグインインスタンスは、設定をいつでも更新できます。

この呼び出しは、複数のインスタンスの同じプラグインがアクティブに読み取り書き込みを行っている場合、nil を返すことがあります。プラグインが期待しているように設定を頻繁に書き込む場合は、この呼び出しの後に数秒間、nil から返された値を確認して、設定が一時的に使用不可能であるか、永久に使用不可能

パラメータ

戻り値

local RAN_BEFORE_KEY = "RanBefore"
local didRunBefore = plugin:GetSetting(RAN_BEFORE_KEY)

if didRunBefore then
	print("Welcome back!")
else
	plugin:SetSetting(RAN_BEFORE_KEY, true)
	print("Welcome! Thanks for installing this plugin!")
end

パラメータ

戻り値

この関数は、Plugin:Activate() 関数を通じて有効になった後、このプラグインが現在有効であることにより、返り値として戻ります。

戻り値

この関数は、Plugin:Activate() 関数を通じて有効になった後、このプラグインが現在有効であることを示すように戻ります。これがPluginMouseを取得する方法です。これがPlugin:GetMouse()で取得できます。

参照してください:

• Plugin.Deactivation 、プラグインが無効になったときに発動します
• Plugin.Unloading は、プラグインのアンロードまたは再読み込みを通じてインストールされるため、インストールからすぐに前に発動します

戻り値

与えられたパーツを否定し、結果として NegateOperations を返します。

パラメータ

戻り値

Roblox Studio の編集モードのスクリプトインスタンスを開くために使用されます。引数が与えられていない場合は、デフォルトで 1 が返されます。

パラメータ

戻り値

local newScript = Instance.new("Script")
newScript.Parent = workspace
plugin:OpenScript(newScript)

コンテキストヘルプウィンドウを開き、url にリンクされているウィキペディアページを開きます。

パラメータ

戻り値

plugin:OpenWikiPage("API:Class/BasePart")

ユーザーの現在の選択についてのアップロードウィンドウを開きます。

戻り値

指定した Roblox Studio ツールを有効にします。ツールがウィンドウを開くと、ポジションパラメータは、画面に表示する場所を指定します。

注:

• これが正しく機能するには、オブジェクトを選択する必要があります。
• position プロパティのスケールフィールドを変更すると、ダイアログポップアップに影響しません。

パラメータ

戻り値

ユニオンオペレーションを与え、結果となるパーツを返します。

パラメータ

戻り値

指定されたキーの下で、後で使用するために指定された値を保存します。この値は Roblox Studio が閉じている後でも持続します。これらの設定は、最初に数値を文字列に変換してマップとして保存されます。配列は、最初に数字のキーを文字列に変換してマップに変換されます。

JSON 形式は、次のキャラクターを含む追加の制限を強制します。これらのキャラクターは、設定ファイルを破損する可能性があります：

• キーまたは値の後ろにスラッシュ ( \ ) 、特に脱出した引用文 ( \" ) があります。
• 新行 ( \n ) をキーに。
• キーに Quotes ( " ) を含める。
• 期間 ( ) をキーに含める。

同じプラグインのインスタンスがアクティブに読み取って書き込んでいる場合、この呼び出しは失敗することがあります。プラグインが頻繁に設定に書き込むことを期待している場合は、Plugin:GetSetting() を呼び出してデータが適切に書き込まれているかどうかを確認します。

パラメータ

戻り値

local RAN_BEFORE_KEY = "RunBefore"
local hasRunBefore = plugin:GetSetting(RAN_BEFORE_KEY)

if hasRunBefore then
	print("Welcome back!")
else
	print("Thanks for installing this plugin!")
	plugin:SetSetting(RAN_BEFORE_KEY, true)
end

ドラッグを開始ドラッグ は、パラメータのダイクトリを使用してドラッグアクションを開始します。パラメータは次のとおりです:

<tbody>
  <tr>
    <td><b>送信者</b></td>
    <td>文字列</td>
    <td><code>""</code></td>

    <td>
      ドラッグアクションのソースをドロップターゲットに識別します
    </td>
  </tr>

  <tr>
    <td><b>MimeType</b></td>
    <td>文字列</td>
    <td><code>""</code></td>

    <td>
      データのタイプ <b>MINE</b>。
    </td>
  </tr>

  <tr>
    <td><b>データ</b></td>
    <td>文字列</td>
    <td><code>""</code></td>

    <td>
      ドラッグアクションに関する情報、例えば何がドラッグされているか。ドロップターゲットによって使用されるべきです。
    </td>
  </tr>

  <tr>
    <td><b>マウスアイコン</b></td>
    <td><code>Datatype.Content</code></td>
    <td><code>""</code></td>

    <td>
      マウスカーソルの使用中に使用するアイコン。空の場合は、デフォルトのカーソルを使用します。
    </td>
  </tr>

  <tr>
    <td><b>ドラッグアイコン</b></td>
    <td><code>Datatype.Content</code></td>
    <td><code>""</code></td>

    <td>
      ドラッグ中のマウスカーソルの下でレンダリングする画像。これは、ドラッグされているアイテムを表示する必要があります。
    </td>
  </tr>

  <tr>
    <td><b>ホットスポット</b></td>
    <td><code>Datatype.Vector2</code></td>
    <td><code>Datatype.Vector2.new(0, 0)</code></td>

    <td>
      カーソルが <b>ドラッグアイコン</b> を「持って」いるところのピクセルオフセット。
    </td>
  </tr>
</tbody>

参照してください:

• PluginGui.PluginDragEntered
• PluginGui.PluginDragMoved
• PluginGui.PluginDragDropped
• PluginGui.PluginDragLeft

パラメータ

戻り値

assert(plugin, "This script must be run as a Studio plugin")

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

local dragSourceWidget = plugin:CreateDockWidgetPluginGui("Drag Source", widgetInfo)
dragSourceWidget.Title = "Drag Source"

local textBox = Instance.new("TextBox")
textBox.Parent = dragSourceWidget
textBox.Size = UDim2.new(1, 0, 0, 32)
textBox.Text = "Hello, plugin drags"

local dragButton = Instance.new("TextButton")
dragButton.Size = UDim2.new(1, 0, 1, -32)
dragButton.Position = UDim2.new(0, 0, 0, 32)
dragButton.Text = "Edit the text above, then start drag here"
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)

-- This widget will receive drops
local dragTargetWidget = plugin:CreateDockWidgetPluginGui("Drop Target", widgetInfo)
dragTargetWidget.Title = "Drop Target"

-- This TextLabel will display what was dropped
local textLabel = Instance.new("TextLabel")
textLabel.Size = UDim2.new(1, 0, 1, 0)
textLabel.Text = "Drop here..."
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)

与えられたパーツを結合し、結果として UnionOperation を返します。

パラメータ

戻り値

CreateDockWidgetPluginGui は、DockWidgetPluginGui を作成します。DockWidgetPluginGuiInfo から、最初のパラメーター、 0> uginGuiId0> 、がユニークで一貫した文字列です。これは、ウィジェットのドック状態の状態とその他の内部詳

パラメータ

戻り値

-- Create new 'DockWidgetPluginGuiInfo' object
local widgetInfo = DockWidgetPluginGuiInfo.new(
	Enum.InitialDockState.Float, -- Widget will be initialized in floating panel
	true, -- Widget will be initially enabled
	false, -- Don't override the previous enabled state
	200, -- Default width of the floating window
	300, -- Default height of the floating window
	150, -- Minimum width of the floating window (optional)
	150 -- Minimum height of the floating window (optional)
)

-- Create new widget GUI
local testWidget = plugin:CreateDockWidgetPluginGui("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 = "Click Me"
testButton.Parent = testWidget

この機能は、ユーザーが rigModel にロードできる .fbx アニメーションファイルを開くように促し、その後、アニメーションを KeyframeSequence として Workspace に挿入します。

パラメータ

戻り値

ユーザーに .fbx ファイルを開くように促し、モデルの個々のコンポーネントをメッシュとしてアップロードし、アニメーションで使用するためのキャラクターリグを生成します。これは Workspace にロードされます。

パラメータ

戻り値

Roblox Studio のウィンドウを開き、ユーザーが指定した assetType に基づいてアセットを選択します。返したアセットId は、ウィンドウが閉じると -1 または返します。

パラメータ

戻り値

ユーザーに現在の選択を指定されたファイル名で保存するよう促します。ユーザーがファイルを保存した場合、戻り値は true です。

パラメータ

戻り値

Class.Plugin が無効になると、これはプラグインコードが Plugin:Deactivate() を呼び出すか、または他のプラグインが Plugin:Activate() を呼び出すため、すべての他のプラグインがアクティブ状態を失います。

参照してください:

• Plugin.Unloading は、プラグインのアンロードまたは再読み込みを通じてインストールされるため、インストールからすぐに前に発動します

このイベントは、Plugin の実行を即座に中止するために発動します。プラグインは、無効になった、Plugin を再読み込み、または場所を閉じるときに解読されます。

スクリプトが実行されなくなる前にプラグインが自分自身を清掃するようになります。たとえスクリプトが正常に実行されていても、DataModel の不要なインスタンスを削除する必要があります。プラグインが適切に清掃されない場合は、古いコピーが残ります。これが発生すると、ユーザーは悪いユーーザーエ

プラグイン関連インスタンスの例、PluginToolbarButtons、DockWidgetPluginGuis、およびPluginGuis は、プラグインがアンロードされると自動的にクリーンアップされるため、削除する必要はありません。