PluginToolbarButton

非推奨を表示

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

作成できません

プラグインツールバタンは、PluginToolbar:CreateButton() 関数によって作成されたオブジェクトです。ユーザーは、Click イベントを通じて Roblox Studio で単一の一回限りのアクションを開始できます。

押すと、Click イベントが発動します。ボタンも押された状態で残り、SetActive を使用して手動で設定できます。プラグインのアクティベーション後 ( Plugin:Activate() )、すべての他の PluginToolbars のボタンが切り替わります。ツールバーのすべてのボタンがオフである場合、ツールバーのプラグインは無効になります (Plugin:Deactivate() )。

ゲームビューポートが表示されないと、ボタンが無効になり、Enabled プロパティが偽のようになります。無効なボタンは飽和が低下し、ユーザーのクリックに応答しません。ClickableWhenViewportHidden を真に設定すると、プラグインのボタンがクリック可能なままになる (スクリプト編集中など) ことができます。

概要

プロパティ

  • 複製されていません
    並列読み取り

    ゲームビューポートが隠れているときにボタンをクリックできるかどうかを決定します。たとえば、異なるスタジオタブでスクリプトを編集している間などです。

  • 複製されていません
    並列読み取り

    ボタンが一全般的にクリック可能かどうかを決定します。

  • Icon:ContentId
    複製されていません
    並列読み取り

    どのアイコンがボタンを表示すべきかを決定します。

方法

  • SetActive(active : boolean):()
    プラグインのセキュリティ

    プラグインボタンの状態を設定します。

イベント

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

    ユーザーがボタンにカーソルを押してリリースすると、発火します。

プロパティ

ClickableWhenViewportHidden

複製されていません
並列読み取り

ClickableWhenViewportHidden は、ゲームビューポートが隠されているときにプラグインツールバーボタンをクリックできるかどうかを決定します。例えば、別のタブで Script が編集されているとき、ビューポートが隠されています。

通常、プラグインボタンの Click イベントによってトリガーされたアクションがゲームワールド (ワークスペース) で発生しない場合、このプロパティを有効にすることが好ましいです。たとえば、ウィジェットを開くボタンは、ゲームビューが表示されない場合でもユーザーにウィジェットが表示されているように見えるため、このプロパティが真実である必要があります。

Enabled

複製されていません
並列読み取り

有効 は、一全般的にボタンがクリック可能かどうかを決定します。このプロパティが false の場合、ボタンがグレー表示され、クリックできなくなり、ユーザーが Click イベントを発射できないようになります。デフォルトでボタンが有効になっています。

このプロパティを再び有効にすると、プラグインボタンの状態は、ユーザーがボタンを残した前の状態から記憶されません。代わりに、SetActive() または SetActive() が使用されたことがない場合、最後の状態または非アクティブ状態にデフォルトします。

プラグインは、ボタンアクションが現在のコンテキストで関連していない場合、ボタンを無効にする必要があります。たとえば、選択したパーツにランダムな色を割り当てるプラグインボタンは、選択にパーツがない場合は有効にしないでください。詳細については、コードサンプルを参照してください。

参照してください:

  • ClickableWhenViewportHidden , ゲームビューが非表示になったときにボタンがクリック可能かどうかを決定する (一全般的にだけではない)

コードサンプル

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
複製されていません
並列読み取り

アイコン は、プラグインツールバーのボタンに何が表示されるべきかを決定します。このプロパティが設設定するされていない場合、ボタンは代わりに PluginToolbar:CreateButton() によってボタンのテキストを使用します。

方法

SetActive

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

このメソッドは、プラグインボタンのアクティブ状態を手動で設定するのに使用できます。

Enabled プロパティが切り替えられると、ボタンはこのメソッドによって設定された最後の状態に戻るか、以前に使用されていない場合は無効に戻ります。

パラメータ

active: boolean
既定値: ""

戻り値

()

イベント

Click

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

クリック は、ユーザーがプラグインツールバタンボタンを押してリリースすると発動します。

プラグインツールバタンボタンをクリックすると、ボタンの状態が切り替わります。状態を手動で設定するには、SetActive を呼び出します。


コードサンプル

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)