**DockWidgetPluginGui** は `Class.PluginGui` であり、その内容を
ドッキング可能な Roblox Studio ウィンドウ内に表示します。これは、組み込みの **Animation Editor** や **Terrain Tools** と類似のウィジェットを作成するために使用されます。

この GUI は `Class.Plugin:CreateDockWidgetPluginGuiAsync()` を使用して作成できます。

DockWidgetPluginGui

この `Class.DockWidgetPluginGui` の前の状態が作成時に復元されたかどうかを説明します。

DockWidgetPluginGui.HostWidgetWasRestored

この DockWidgetPluginGui の前の状態が作成時に復元されたかどうかを説明します。

ドッカブルでリサイズ可能なRoblox Studioウィンドウに内容を表示する`Class.PluginGui`です。


PluginGui は、さまざまな Roblox Studio ウィジェットで `Class.GuiObject|GuiObjects` を表示できる GUI の抽象クラスです。現時点では、利用可能な PluginGui タイプは `Class.DockWidgetPluginGui` のみですが、将来的にはもっと増える可能性があります！

このコードサンプルは、ドラッグソースとドロップターゲットの2つのプラグインウィジェットウィンドウを作成します。ソースウィンドウでは、スクリプトが`Class.TextBox`と`Class.TextButton`を作成し、ユーザーがプラグインのドラッグアクションを開始できるようにします。ドロップターゲットウィンドウは、そこにドラッグされたもののMIMEタイプを表示します。MIMEタイプが`text/plain`の場合、プレーンテキストデータが表示されます。

このコードサンプルをプラグインとして実行するには、`Class.Script`に貼り付けます。次に、**Explorer**ウィンドウでスクリプトを右クリックし、**ローカルプラグインとして保存**を選択します。


**PluginDragDropped** は、ユーザーが `Class.Plugin:StartDrag()` によって開始されたドラッグ操作の最中に `Class.PluginGui` 上でマウスを離したときに発火します。

参照：

- `Class.PluginGui.PluginDragEntered`
- `Class.PluginGui.PluginDragLeft`
- `Class.PluginGui.PluginDragMoved`

PluginGui.PluginDragDropped

dragData

`Class.Plugin:StartDrag()` に元々渡されたデータのコピーです。

ユーザーが `Class.Plugin:StartDrag()` によって開始されたドラッグ操作の最中に、PluginGui 上でマウスを離したときに発火します。

**PluginDragEntered** は、ユーザーのマウスが `Class.Plugin:StartDrag()` によって開始されたドラッグ操作の最中に `Class.PluginGui` に入ったときに発火します。

このイベントは、ドラッグ操作がドロップできる PluginGuis に "ここにドロップ" UI を表示するのに便利です。このような UI は、`Class.PluginGui.PluginDragLeft|PluginDragLeft` または `Class.PluginGui.PluginDragDropped|PluginDragDropped` が発火した場合に非表示にする必要があります。

参照：

- `Class.PluginGui.PluginDragLeft`
- `Class.PluginGui.PluginDragMoved`
- `Class.PluginGui.PluginDragDropped`

PluginGui.PluginDragEntered

`Class.Plugin:StartDrag()` に最初に渡されたデータのコピーです。

ユーザーのマウスが `Class.Plugin:StartDrag()` によって開始されたドラッグ操作の最中に PluginGui に入ったときに発火します。

**PluginDragLeft** は、ユーザーのマウスが `Class.Plugin:StartDrag()` によって開始されたドラッグ操作の最中に `Class.PluginGui` を離れたときに発火します。

このイベントと `Class.PluginGui.PluginDragDropped|PluginDragDropped` は、ドロップできる PluginGuis において "ここにドロップ" UI を隠すのに便利です。このような UI は、`Class.PluginGui.PluginDragEntered|PluginDragEntered` が発火した場合に表示されるべきです。

参照：

- `Class.PluginGui.PluginDragEntered`
- `Class.PluginGui.PluginDragMoved`
- `Class.PluginGui.PluginDragDropped`

PluginGui.PluginDragLeft

ユーザーのマウスが `Class.Plugin:StartDrag()` によって開始されたドラッグ操作の最中に PluginGui を離れたときに発火します。

**PluginDragMoved** は、ユーザーのマウスが `Class.Plugin:StartDrag()` によって開始されたドラッグ操作の最中に `Class.PluginGui` 内で移動したときに発火します。

参照：

- `Class.PluginGui.PluginDragEntered`
- `Class.PluginGui.PluginDragLeft`
- `Class.PluginGui.PluginDragDropped`

PluginGui.PluginDragMoved

ユーザーのマウスが `Class.Plugin:StartDrag()` によって開始されたドラッグ操作の最中に PluginGui 内で移動したときに発火します。

このコードサンプルは、`PluginGui` のフォーカス状態を
`Class.PluginGui.WindowFocused|WindowFocused()` および
`Class.PluginGui.WindowFocusReleased|WindowFocusReleased()` イベントを使用して追跡する方法を示しています。フォーカス状態が変更されると、
`Class.PluginGui.Title|Title()` が変更されます。

**WindowFocused** は、ユーザーが通常ウィンドウをクリックすることでPluginGuiのウィンドウとの対話を開始したときに即座に発生します。この機能は、名前が似た `Class.UserInputService.WindowFocused` イベントに似ています。これは、マウスボタンに関連する `Class.GuiObject.InputBegan` イベントの前に発生します。

別の `Class.PluginGui` がフォーカスされていて、ユーザーがこのPluginGuiにフォーカスを移すと、他の `Class.PluginGui.WindowFocusReleased|WindowFocusReleased` イベントの後にこのイベントが発生します。ただし、メインゲームウィンドウがフォーカスされていた場合、このイベントは **後に** `Class.UserInputService.WindowFocusReleased` の後に発生します。

PluginGui.WindowFocused

ユーザーがPluginGuiのウィンドウとの対話を開始するときに発生します。

**WindowFocusReleased** は、ユーザーが通常、ウィンドウ外の何かをクリックすることでPluginGuiのウィンドウとの対話を停止したときに即座に発生します。この機能は、名前が似た `Class.UserInputService.WindowFocusReleased` イベントに似ています。

ユーザーがこのPluginGuiにフォーカスを当てている間に別の `Class.PluginGui` にフォーカスが移動する場合、このイベントは他の `Class.PluginGui.WindowFocused|WindowFocused` イベントの前に発生します。ただし、メインゲームウィンドウがフォーカスされる場合、このイベントは **後に** `Class.UserInputService.WindowFocused` の後に発生します。

PluginGui.WindowFocusReleased

ユーザーがPluginGuiのウィンドウとの対話を停止するときに発生します。

このメソッドは、ユーザーが`Class.PluginGui`の閉じるボタンをクリックしたときに実行される関数をバインドします。ウィジェットは閉じ、`Class.LayerCollector.Enabled|Enabled`プロパティは`false`になります。関数がバインドされていても、閉じるのを防いだり遅らせたりすることはできません。ウィジェットが閉じるときに作業を保存するなどのタスクを実行するために使用します。

例えば、以下のコードはユーザーがウィジェットを閉じるときに作業を保存します：

```lua
local function saveWork()
	-- ユーザーの作業をここに保存します。
end

pluginGui:BindToClose(function()
	saveWork()
end)
```
引数なしで`BindToClose()`を呼び出すと、現在の関数のバインドを解除します：

```lua
pluginGui:BindToClose()
```
関連情報：

- `Class.Plugin:CreateDockWidgetPluginGuiAsync()`は、`Class.PluginGui`を作成します。
- `Class.DataModel:BindToClose()`は、ゲームの終了に関数をバインドするために使用でき、この関数と混同しないでください。


PluginGui:BindToClose

function

閉じるボタンにバインドする関数です。関数が指定されていない場合は、以前に指定された関数がバインド解除されます。

`Class.PluginGui`を閉じるときに実行される関数をバインドします。


GetRelativeMousePosition は、`Class.PluginGui` の左上隅に対するマウスの位置を返します。返された値は、PluginGui でマウス入力が始まった場合、またはマウスが現在ウィンドウの上にホバーしている場合にのみ変更されます。

PluginGui:GetRelativeMousePosition

PluginGui に対するマウスの画面上の位置をピクセル単位で返します。

PluginGui に対するマウスの位置を返します。

PluginGui

`Class.PluginGui` の内容の上に表示されるタイトルです。
デフォルトは空の文字列です。

PluginGui.Title

`Class.PluginGui` の内容の上に表示されるタイトルです。

`Class.GuiObject|GuiObjects` を表示する GUI のための抽象基本クラスです。
Roblox Studio ウィジェットで。

**LayerCollector**は、`Class.ScreenGui`のような`Class.GuiObject`の子孫をレンダリングする2D UIコンテナのベースクラスです。

パフォーマンスの改善のために、`Class.LayerCollector`の外観は、次のいずれかのイベントが発生するまでキャッシュされます：

- 子孫が追加または削除される。
- 子孫のプロパティが変更される。
- `Class.LayerCollector`自体のプロパティが変更される。

LayerCollector:GetLayoutNodeTree

LayerCollector

この `Class.LayerCollector` の可視性を切り替えます。`false` の場合、
UIの内容はレンダリングされず、ユーザー入力を処理せず、変更に応じて更新されません。

LayerCollector.Enabled

この `Class.LayerCollector` の可視性を切り替えます。

`false` に設定され、この `Class.LayerCollector` が `Class.StarterGui` の直接の子である場合、各プレイヤーの `Class.PlayerGui` に一度だけクローンされ、プレイヤーのキャラクターが再出現しても削除されません。

`true`（デフォルト）に設定されている場合、またはこの `Class.LayerCollector` が `Class.StarterGui` の**間接**的な子孫である場合、プレイヤーのキャラクターが再出現する際に各プレイヤーの `Class.PlayerGui` にクローンされ、再度プレイヤーのキャラクターが再出現した際に自分自身を削除します。

LayerCollector.ResetOnSpawn

プレイヤーのキャラクターが再出現するたびに、`Class.LayerCollector`がリセット（自分自身を削除して、プレイヤーの `Class.PlayerGui` に再クローン）されるかどうかを決定します。

`Class.GuiObject.ZIndex`がこの`Class.LayerCollector`のすべての子孫でどのように動作するかを制御します。

`Enum.ZIndexBehavior.Sibling`（デフォルト）では、子は常に親の上に描画され、`Class.GuiObject.ZIndex|ZIndex`が単一のUIオブジェクトの子の描画順序を決定するために使用されます。

`Enum.ZIndexBehavior.Global`は、すべての子孫を`Class.GuiObject.ZIndex|ZIndex`に従ってソートし、次に階層順序を使用して同点を解決します。その結果、`Class.GuiObject`の子孫は、親と同じかそれ以上の`Class.GuiObject.ZIndex|ZIndex`値を持っている必要があり、そうでない場合は親の下に描画されます。


LayerCollector.ZIndexBehavior

`Class.GuiObject.ZIndex`がこの`Class.LayerCollector`のすべての子孫でどのように動作するかを制御します。


レイヤーで `Class.GuiObject|GuiObjects` をレンダリングする2D UIコンテナのベースクラス。

`Class.GuiBase2d` は 2D `Class.GuiObject|GuiObjects` に継承される抽象クラスです。


このイベントは、ゲームパッドの選択が接続された `Class.GuiBase2d` またはその子孫の `Class.GuiObject|GuiObjects` に移動、離脱、または変更されたときに発火します。選択ハイライトが `Class.GuiObject` に移動すると、イベントはその `Class.GuiObject` からすべての先祖にバブルし、選択がその子孫ツリー内の `Class.GuiObject` に変更/入った/出たことを通知します。


GuiBase2d.SelectionChanged

amISelected

新しい選択が接続された GuiBase2d と一致する場合は true です。


previousSelection

選択が変更される前に選択されていた `Class.GuiObject`、または何も選択されていない場合は nil です。


newSelection

選択が変更された後に現在選択されている `Class.GuiObject`、または何も選択されていない場合は nil です。


ゲームパッドの選択が接続された `Class.GuiBase2d` またはその子孫の `Class.GuiObject|GuiObjects` に移動、離脱、または変更されたときに発火します。


GuiBase2d

`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` は、`Class.GuiBase2d` 要素の画面位置をピクセル単位で提供する読み取り専用プロパティです。これは、要素がその先祖のサイズと位置の結果としてレンダリングされる実際のピクセル位置を表します。`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` は常に `Class.GuiBase2d` 要素の左上隅を表します。

`Class.GuiBase2d` が `Class.ScreenGui` にある場合、`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` プロパティは `Enum.ScreenInsets|CoreUISafeInsets` ビューポート座標系を使用します。この座標系の原点は、Roblox のトップバーの左下隅に位置しています。この座標系は、`Class.InputObject.Position` プロパティでも使用されます。

<img src="/assets/engine-api/classes/GuiBase2d/AbsolutePositionCoordinateSystem.png" width="840" alt="AbsolutePosition 座標系の原点を示す図。" />

`Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` と `Class.GuiBase2d.AbsoluteSize|AbsoluteSize` も参照してください。


GuiBase2d.AbsolutePosition

`Class.GuiBase2d` 要素の実際の画面位置をピクセル単位で説明します。


`Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` は、`Class.GuiBase2d` 要素の実際の画面回転を度単位で説明する読み取り専用プロパティです。これは境界チェックを行わないため、その値は `0` から `360` の範囲にない場合があります。

`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` と `Class.GuiBase2d.AbsoluteSize|AbsoluteSize` も参照してください。


GuiBase2d.AbsoluteRotation

`Class.GuiBase2d` 要素の実際の画面回転を度単位で説明します。


`Class.GuiBase2d.AbsoluteSize|AbsoluteSize` は、`Class.GuiBase2d` 要素の実際の画面サイズをピクセル単位で説明する読み取り専用プロパティです。

`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` と `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` も参照してください。


GuiBase2d.AbsoluteSize

`Class.GuiBase2d` 要素の実際の画面サイズをピクセル単位で説明します。


`true` に設定すると、この `Class.GuiBase2d` とその子孫にローカリゼーションが適用されます。ローカリゼーションに使用されるエントリは、`Class.LocalizationService:GetTableEntries()` によって返される同じエントリのセットです。`Class.GuiBase2d.AutoLocalize|AutoLocalize` が有効なエントリは、クラウドテーブルがロードされた後に必要に応じて自動的に再翻訳されます。

`Class.GuiBase2d.RootLocalizationTable|RootLocalizationTable` も参照してください。


GuiBase2d.AutoLocalize

`true` に設定すると、この `Class.GuiBase2d` とその子孫にローカリゼーションが適用されます。


このプロパティは、ローカリゼーションテーブルの `Class.LocalizationTable.Root` がこのオブジェクトまたはこのオブジェクトの先祖をターゲットにしている場合、自動的に `true` に設定されます。`Class.LocalizationTable|LocalizationTables` の `Class.LocalizationTable.Root` プロパティがインスタンスを指している場合、ルートインスタンスの子孫であるすべての `Class.TextLabel.TextButton` がローカライズされます。


GuiBase2d.Localize

ローカリゼーションテーブルの `Class.LocalizationTable.Root` がこのオブジェクトまたはこのオブジェクトの先祖をターゲットにしている場合、自動的に `true` に設定されます。


`Class.GuiBase2d` とその子孫に自動ローカリゼーションを適用するために使用される `Class.LocalizationTable` への参照です。
`Class.GuiBase2d.AutoLocalize|AutoLocalize` は、`Class.GuiBase2d` とその先祖に `true` に設定されている必要があります。

これを `Class.DataModel` 内の任意の `Class.LocalizationTable` を参照するように設定できます。`Class.GuiBase2d` オブジェクトとそのすべての子は、その特定の `Class.LocalizationTable` とその先祖を使用して自動テキスト置換を試み、その後、未定義の順序で `Class.LocalizationService` の下のテーブルとクラウドテーブルを使用します。

参照されたテーブルに翻訳がない場合は、そのテーブルの親を探し、もしそれも `Class.LocalizationTable` であれば、さらに上を探します。

自動ローカリゼーションに `Class.GuiBase2d.RootLocalizationTable|RootLocalizationTable` がどのように使用されるかについては、`Class.LocalizationService:GetTableEntries()` も参照してください。


GuiBase2d.RootLocalizationTable

`Class.GuiBase2d` とその子孫に自動ローカリゼーションを適用するために使用される `Class.LocalizationTable` への参照です。


`Class.GuiBase2d.SelectionBehaviorDown|SelectionBehaviorDown` は、選択グループから下方向にゲームパッドの選択がどのように移動するかをカスタマイズします。これは、`Class.GuiBase2d.SelectionGroup|SelectionGroup` が `true` の場合にのみ効果があります；`SelectionGroup` はデフォルトで `false` であり、`false` のままではこのプロパティは効果がありません。

デフォルト値は `Enum.SelectionBehavior.Escape` で、選択グループ内のボタンを優先しますが、適切なボタンが見つからない場合はグループの外にある `Class.GuiObject` に移動することを許可します。代わりに `Enum.SelectionBehavior.Stop` に設定すると、選択はグループに制約され、グループの外に下方向に移動することを防ぎます。

`Class.GuiBase2d.SelectionGroup|SelectionGroup` も参照してください。


GuiBase2d.SelectionBehaviorDown

ゲームパッドの選択動作を下方向にカスタマイズします。


`Class.GuiBase2d.SelectionBehaviorLeft|SelectionBehaviorLeft` は、選択グループから左方向にゲームパッドの選択がどのように移動するかをカスタマイズします。これは、`Class.GuiBase2d.SelectionGroup|SelectionGroup` が `true` の場合にのみ効果があります；`SelectionGroup` はデフォルトで `false` であり、`false` のままではこのプロパティは効果がありません。

デフォルト値は `Enum.SelectionBehavior.Escape` で、選択グループ内のボタンを優先しますが、適切なボタンが見つからない場合はグループの外にある `Class.GuiObject` に移動することを許可します。代わりに `Enum.SelectionBehavior.Stop` に設定すると、選択はグループに制約され、グループの外に左方向に移動することを防ぎます。

`Class.GuiBase2d.SelectionGroup|SelectionGroup` も参照してください。


GuiBase2d.SelectionBehaviorLeft

ゲームパッドの選択動作を左方向にカスタマイズします。


`Class.GuiBase2d.SelectionBehaviorRight|SelectionBehaviorRight` は、選択グループから右方向にゲームパッドの選択がどのように移動するかをカスタマイズします。これは、`Class.GuiBase2d.SelectionGroup|SelectionGroup` が `true` の場合にのみ効果があります；`SelectionGroup` はデフォルトで `false` であり、`false` のままではこのプロパティは効果がありません。

デフォルト値は `Enum.SelectionBehavior.Escape` で、選択グループ内のボタンを優先しますが、適切なボタンが見つからない場合はグループの外にある `Class.GuiObject` に移動することを許可します。代わりに `Enum.SelectionBehavior.Stop` に設定すると、選択はグループに制約され、グループの外に右方向に移動することを防ぎます。

`Class.GuiBase2d.SelectionGroup|SelectionGroup` も参照してください。


GuiBase2d.SelectionBehaviorRight

ゲームパッドの選択動作を右方向にカスタマイズします。


`Class.GuiBase2d.SelectionBehaviorUp|SelectionBehaviorUp` は、選択グループから上方向にゲームパッドの選択がどのように移動するかをカスタマイズします。これは、`Class.GuiBase2d.SelectionGroup|SelectionGroup` が `true` の場合にのみ効果があります；`SelectionGroup` はデフォルトで `false` であり、`false` のままではこのプロパティは効果がありません。

デフォルト値は `Enum.SelectionBehavior.Escape` で、選択グループ内のボタンを優先しますが、適切なボタンが見つからない場合はグループの外にある `Class.GuiObject` に移動することを許可します。代わりに `Enum.SelectionBehavior.Stop` に設定すると、選択はグループに制約され、グループの外に上方向に移動することを防ぎます。

`Class.GuiBase2d.SelectionGroup|SelectionGroup` も参照してください。


GuiBase2d.SelectionBehaviorUp

ゲームパッドの選択動作を上方向にカスタマイズします。


ゲームパッドの選択がボタン間を移動する方法、グループを離れる方法、他のボタンを選択する方法をカスタマイズできます。

`Class.GuiBase2d.SelectionGroup|SelectionGroup` を `true` に設定すると、`Class.GuiBase2d.SelectionBehaviorUp|SelectionBehaviorUp`、`Class.GuiBase2d.SelectionBehaviorDown|SelectionBehaviorDown`、`Class.GuiBase2d.SelectionBehaviorLeft|SelectionBehaviorLeft`、および `Class.GuiBase2d.SelectionBehaviorRight|SelectionBehaviorRight` プロパティが公開されます。これらの選択動作において、`Enum.SelectionBehavior.Escape`（デフォルト）の設定は、ゲームパッドの選択が最初に選択グループ内の選択を見つけようとし、適切なボタンが見つからない場合にのみ外に移動することを意味します。代わりに、`Enum.SelectionBehavior.Stop` の設定は、ゲームパッドの選択が選択グループ内のみを見て、選択動作の方向からグループの外に移動しないことを意味します。


GuiBase2d.SelectionGroup

ゲームパッドの選択移動をカスタマイズできます。


2D `Class.GuiObject|GuiObjects` に継承される抽象クラスです。


GuiBaseは、ほとんどのグラフィカルユーザーインターフェースオブジェクトが
継承する抽象クラスです。

GuiBase

`Instance` は、`Class.DataModel` ツリーの一部となることができる Roblox クラス階層内のすべてのクラスの基本クラスです。

ルート `Instance` オブジェクトを直接作成することはできませんが、特別な `Datatype.Instance.new()` コンストラクタを使用して、クラスの名前をパラメータとして受け取り、作成されたオブジェクトを返します。


インスタンスの系譜に対する変更を検出する方法を示します。
`Class.Instance.AncestryChanged` イベントに接続することで実現します。

ChangingPart の親は時間とともに異なる値に設定されます。パーツの親はパーツの先祖であるため、
`Class.Instance.AncestryChanged` イベントは変更されるたびに発火します。

このインスタンスが再親子化されたとき、またはその祖先のいずれかが再親子化されたときに発火します。

このイベントを使用して、スタジオ内でインスタンスの削除を追跡できます。たとえば、エクスプローラーでの手動削除やプラグインを通じての削除などです。`Class.Instance:Destroy()` を使用してインスタンスが破壊されたときに検出する必要がある場合は、代わりに `Class.Instance.Destroying` イベントを使用してください。


Instance.AncestryChanged

child

`Class.Instance.Parent|Parent` プロパティが変更されたインスタンス。これはこのインスタンスまたはより遠い祖先であり、必ずしもハンドラが接続されているインスタンスではありません。


parent

`child` パラメータの新しい親。


このオブジェクトまたはその祖先の `Class.Instance.Parent` プロパティが変更されたときに発火します。


このイベントは、インスタンスの属性が変更されるたびに発火します。属性が `nil` に設定されるときも含まれます。変更された属性の名前が接続された関数に渡されます。

たとえば、次のコードスニペットは、パーツの属性のいずれかが変更されるたびに `attributeChanged()` 関数を発火させます：

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part

local function attributeChanged(attributeName)
	print(attributeName, "changed")
end

part.AttributeChanged:Connect(attributeChanged)
```

`Class.Instance:GetAttributeChangedSignal()` も参照してください。これは、特定の属性が変更されたときに発火するイベントを返します。


Instance.AttributeChanged

attribute

インスタンスの属性が変更されるたびに発火します。


このスニペットは、オブジェクトがWorkspaceに追加されると、その名前を出力します:

この `Class.Instance` にオブジェクトが親付けされた後に発火します。

クライアントでサーバーによって作成されたオブジェクトを検出するためにこのメソッドを使用する場合、これらのオブジェクトの子孫をインデックスする際に `Class.Instance:WaitForChild()` を使用する必要があります。これは、オブジェクトとその子孫がサーバーからクライアントに同時に複製されることが保証されていないためです。たとえば：

```
local Workspace = game:GetService("Workspace")

Workspace.ChildAdded:Connect(function(child)
	-- 子孫がまだ複製されていない可能性があるため、WaitForChild() を使用します
	local head = child:WaitForChild("Head")
end)
```
このイベントは、`Class.Instance` の直接の子に対してのみ機能します。すべての子孫をキャプチャするイベントには、`Class.Instance.DescendantAdded` を使用してください。

`Class.Instance.ChildRemoved` も参照してください。


Instance.ChildAdded

この `Class.Instance` にオブジェクトが親付けされた後に発火します。


Instance.childAdded

このスニペットは、オブジェクトがワークスペースから削除されるときにその名前を表示します:

この `Class.Instance` から子が削除された後に発火します。

削除とは、オブジェクトの親がこの `Class.Instance` から他の何かに変更されることを指します。このイベントは、子が破壊されたとき（`Class.Instance:Destroy()` を使用）にも発火します。なぜなら、破壊関数はオブジェクトの親を `nil` に設定するからです。

このイベントは、`Class.Instance` の直接の子に対してのみ機能します。すべての子孫をキャプチャするイベントには、`Class.Instance.DescendantRemoving` を使用してください。

`Class.Instance.ChildAdded` も参照してください。


Instance.ChildRemoved

この `Class.Instance` から子が削除された後に発火します。


次の例では、Workspaceに追加されたオブジェクトの名前を印刷します:

このイベントは、子孫が `Class.Instance` に追加された後に発火します。

すべての子孫に対して発火するため、オブジェクトを `Class.Instance` に親付けすると、このオブジェクトとそのすべての子孫に対して個別にイベントが発火します。

`Class.Instance` の **直接の子** のみを気にする場合は、代わりに `Class.Instance.ChildAdded` を使用してください。

`Class.Instance.DescendantRemoving` も参照してください。


Instance.DescendantAdded

descendant

子孫が `Class.Instance` に追加された後に発火します。


次の例は、Workspace から削除されるときに、任意の子孫の名前を印刷します:

このイベントは、親 `Class.Instance` が変更され、**子孫** インスタンスがもはや子孫でなくなる直前に発火します。`Class.Instance:Destroy()|Destroy()` はインスタンスの `Class.Instance.Parent|Parent` を `nil` に変更するため、親の子孫に対してこのメソッドを呼び出すと、このイベントが発火します。

このイベントは、子孫の削除の **前** に発火するため、このイベントが発火する時点では子孫の親は変更されていません。子孫が親の **直接の子** でもある場合、このイベントは `Class.Instance.ChildRemoved` の前に発火します。

子孫が子を持つ場合、このイベントは最初に子孫で発火し、その後にその子孫で発火します。

#### 警告

このイベントは、削除される子孫オブジェクトで発火します。子孫の `Class.Instance.Parent|Parent` を他の何かに設定しようとすると失敗します。以下はこれを示す例です：

```
local Workspace = game:GetService("Workspace")

Workspace.DescendantRemoving:Connect(function(descendant)
	-- この関数内で子孫の親を操作しないでください！
	-- このイベントは親が操作されたために発火し、変更はまだ行われていません
	-- したがって、親をこのように変更することは問題があります：
	descendant.Parent = game
end)

local part = Instance.new("Part")
part.Parent = Workspace
part.Parent = nil
```

`Class.Instance.DescendantAdded|DescendantAdded` も参照してください。


Instance.DescendantRemoving

この `Class.Instance` の子孫が削除される直前に発火します。


このサンプルは、Immediate シグナル動作を使用する際に、
インスタンスが破棄されるまで、接続された関数が yield するまでその位置に留まることを示しています。

このサンプルは、Deferredシグナルの動作を使用する際に、インスタンスがシグナルが発火する前に破棄される方法を示しています。

接続された関数がまだ使用している間、`Class.Instance` はメモリから削除されることはありません。ただし、関数が任意の時点で待機すると、`Class.Instance` とその子孫は `nil` に親付けされます。

`Class.Workspace.SignalBehavior` プロパティが `Enum.SignalBehavior.Immediate` に設定されている場合、このイベントは `Class.Instance` またはその祖先のいずれかが `Class.Instance:Destroy()` で破壊される直前に発火します。

`Class.Workspace.SignalBehavior` プロパティが `Enum.SignalBehavior.Deferred` に設定されている場合、このイベントは次の再開ポイントで発火します。これは、`Class.Instance` またはその祖先のいずれかが `Class.Instance:Destroy()` で破壊された後です。

`Enum.SignalBehavior.Deferred|Deferred` の動作では、スクリプトを自分自身の `Class.Instance.Destroying` イベントに接続することは問題があります。なぜなら、スクリプトはコールバックが呼び出される前に破壊されるため（つまり、実行されません）。

スタジオで `Class.Instance` を削除する場合、たとえば [Explorer](/studio/explorer) を介して手動で削除する場合やプラグインを介して削除する場合、`Class.Instance` は破壊されません。代わりに、親が `nil` に設定され、これを `Class.Instance.AncestryChanged` で追跡できます。


Instance.Destroying

インスタンスが `Class.Instance:Destroy()` を介して破壊される直前に発火します。


 `Class.Instance.StyledPropertiesChanged` を示します。


このイベントは、インスタンスのスタイルプロパティが変更されるたびに発火します。プロパティが `nil` に設定されるときも含まれます。


Instance.StyledPropertiesChanged

インスタンスのスタイルプロパティが変更されるたびに発火します。プロパティが `nil` に設定されるときも含まれます。


このメソッドは、インスタンスにタグを適用します。タグがすでに適用されている場合は効果がありません。タグを正常に追加すると、指定されたタグで `Class.CollectionService:GetInstanceAddedSignal()` によって作成された信号が発火します。

#### 警告

- クライアント側で追加されたインスタンスのタグは、サーバーが後でそのインスタンスにタグを追加または削除すると削除されます。サーバーはすべてのタグを一緒に複製し、以前のタグを上書きします。

- インスタンスにタグを付けるときは、タグの機能を提供するためにいくつかのリソースが使用されることが一般的です。たとえば、イベント接続やテーブルです。メモリリークを防ぐために、タグが不要になったときにこれらをクリーンアップすることをお勧めします（切断、`nil` に設定するなど）。これは、`Class.Instance:RemoveTag()` を呼び出すとき、`Class.Instance:Destroy()` を呼び出すとき、または `Class.CollectionService:GetInstanceRemovedSignal()` によって返された信号に接続された関数内で行います。


Instance:AddTag

インスタンスに適用するタグ。


インスタンスにタグを適用します。


子供関数は、オブジェクトの子供の配列を返します。


Instance:children

子オブジェクト/インスタンスの配列。


オブジェクトの子供の配列を返します。


このメソッドは、インスタンスのすべての子供と子孫を破壊します。

```
local part = Instance.new("Part")

-- いくつかのスパークルを追加
for i = 1, 3 do
	local sparkles = Instance.new("Sparkles")
	sparkles.Parent = part

  local sc = Instance.new("Sparkles")
  sc.Parent = sparkles
end

print("Children:", #part:GetChildren())  --> Children: 3

part:ClearAllChildren()

print("Children:", #part:GetChildren())  --> Children: 0
```
すべての子供と子孫を破壊したくない場合は、`Class.Instance:GetChildren()` または `Class.Instance:GetDescendants()` を使用してそれらの子供/子孫をループし、破壊するものを選択します。たとえば、次のコードサンプルは、`Class.Model` から降りてくるすべての `Class.BasePart|BaseParts` を破壊します：

```
local Workspace = game:GetService("Workspace")

local model = Workspace:FindFirstChild("TestModel")

for _, descendant in model:GetDescendants() do
	if descendant:IsA("BasePart") then
		descendant:Destroy()
	end
end
```


Instance:ClearAllChildren

このメソッドは、インスタンスのすべての子供を破壊します。


`Class.Instance:Clone()`を使用してモデルをクローンすることを示します。

`Clone()` は、インスタンスとそのすべての子孫のコピーを作成し、`Class.Instance.Archivable|Archivable` でないすべてのインスタンスを無視します。ルートインスタンスのコピーはこのメソッドによって返され、その `Class.Instance.Parent|Parent` は `nil` に設定されます。インスタンス自体が `Class.Instance.Archivable|Archivable` を `false` に設定されている場合、このメソッドは `nil` を返します。

`Class.ObjectValue.Value` のような参照プロパティがクローンされたインスタンスに設定されている場合、コピーのプロパティの値は元の値に依存します：

- 参照プロパティが **クローンされた** インスタンスを参照している場合、コピーはそのコピーを参照します。
- 参照プロパティが **クローンされていない** インスタンスを参照している場合、同じ値がコピーに保持されます。


Instance:Clone

インスタンスのコピー、またはインスタンスが `Class.Instance.Archivable|Archivable` でない場合は `nil`。


インスタンスとそのすべての子孫のコピーを作成し、`Class.Instance.Archivable|Archivable` でないインスタンスを無視します。


Instance:clone

このサンプルは、`Class.Instance:Destroy()` 関数を使用してパーツを削除する方法を示します。

この関数は、もはや必要ないオブジェクトを処理する正しい方法です。

`Class.Instance.Parent` プロパティを `nil` に設定し、`Class.Instance.Parent` プロパティをロックし、すべての接続を切断し、すべての子供に対して `Destroy()` を呼び出します。このメソッドは、もはや必要ないオブジェクトを処分する正しい方法です。

不要なオブジェクトを処分することは重要です。なぜなら、場所に不要なオブジェクトや接続があると、メモリを消費し、時間の経過とともに深刻なパフォーマンスの問題を引き起こす可能性があるからです。

`Destroy()` をオブジェクトに呼び出した後のベストプラクティスとして、オブジェクト（またはその子孫）を参照する変数を `nil` に設定します。これにより、コードがオブジェクトに関連するものにアクセスできなくなります。

```lua
local part = Instance.new("Part")
part.Name = "Hello, world"
part:Destroy()
-- これをしないでください：
print(part.Name)  --> "Hello, world"
-- 上記の行が機能しないようにするには、これを行います：
part = nil
```
このメソッドによって `Class.Instance` が破壊されると、それを再利用することはできません。なぜなら、`Class.Instance.Parent` プロパティがロックされるからです。オブジェクトを破壊するのではなく **一時的に** 削除するには、`Class.Instance.Parent|Parent` を `nil` に設定します。たとえば：

```
local Workspace = game:GetService("Workspace")

object.Parent = nil
task.wait(2)
object.Parent = Workspace
```
設定した時間後にオブジェクトを破壊するには、`Class.Debris:AddItem()` を使用します。


Instance:Destroy

`Class.Instance.Parent` プロパティを `nil` に設定し、`Class.Instance.Parent` プロパティをロックし、すべての接続を切断し、すべての子供に対して `Destroy()` を呼び出します。


Instance:destroy

`Class.Instance.Name` が指定された名前と等しい最初の祖先を返します。

このメソッドは上向きに機能し、インスタンスの直近の `Class.Instance.Parent` から始まり、`Class.DataModel` に向かって進みます。一致する祖先が見つからない場合は `nil` を返します。

次のコードスニペットは、`Car` という名前のオブジェクトの最初の祖先を見つけます。

```
local car = object:FindFirstAncestor("Car")
```
特定のクラスの祖先を見つけるこのメソッドのバリアントについては、`Class.Instance:FindFirstAncestorOfClass()` および `Class.Instance:FindFirstAncestorWhichIsA()` を参照してください。


Instance:FindFirstAncestor

name

`Class.Instance.Name` が指定された名前と等しい最初の祖先を返します。


`Class.Object.ClassName` が指定された className と等しい最初の祖先を返します。

このメソッドは上向きに機能し、インスタンスの直近の `Class.Instance.Parent` から始まり、`Class.DataModel` に向かって進みます。一致する祖先が見つからない場合は `nil` を返します。

このメソッドの一般的な使用法は、`Class.BasePart` が属する `Class.Model` を見つけることです。たとえば：

```
local model = part:FindFirstAncestorOfClass("Model")
```
このメソッドは、`Class.Instance:FindFirstAncestor()` のバリアントであり、`Class.Object.ClassName` プロパティをチェックします。`Class.Instance:FindFirstAncestorWhichIsA()` も存在し、`Class.Object:IsA()` メソッドを使用してクラスの継承を尊重します。


Instance:FindFirstAncestorOfClass

className

探すべき `Class.Object.ClassName`。


`Class.Object.ClassName` が指定された className と等しい最初の祖先を返します。


`Class.Instance` の最初の祖先を返します。
`Class.Object:IsA()` が指定された className に対して true を返します。

このメソッドは上向きに機能し、インスタンスの直近の `Class.Instance.Parent` から始まり、`Class.DataModel` に向かって進みます。一致する祖先が見つからない場合は `nil` を返します。

`Class.Instance:FindFirstAncestorOfClass()` とは異なり、このメソッドは `Class.Object:IsA()` を使用してクラスの継承を尊重します。たとえば：

```
print(part:IsA("Part"))  --> true
print(part:IsA("BasePart"))  --> true
print(part:IsA("Instance"))  --> true
```
したがって、次のコードサンプルは、最初の `Class.BasePart` 祖先を返します。`Class.WedgePart`、`Class.MeshPart`、または `Class.Part` であるかどうかにかかわらず。

```
local part = object:FindFirstAncestorWhichIsA("BasePart")
```

`Class.Instance:FindFirstAncestor()` も参照してください。


Instance:FindFirstAncestorWhichIsA

`Class.Instance` の最初の祖先を返します。
`Class.Object:IsA()` が指定された className に対して true を返します。


以下は、Workspace内でオブジェクト名「Brick」を探します。見つかった場合、それ
はオブジェクトの名前を「Foo」に変更します。

指定された名前の `Class.Instance` の最初の子を返します。子が存在しない場合は `nil` を返します。オプションの `recursive` 引数が `true` の場合、このメソッドは `Class.Instance` の直近の子供だけでなく、すべての子孫を検索します。

#### オブジェクトの存在を確認する

`FindFirstChild()` は、続行する前にオブジェクトが存在するかどうかを確認する必要がある場合に必要です。ドット演算子を使用して名前で子をインデックスしようとすると、子が存在しない場合はエラーが発生します。

```lua
local Workspace = game:GetService("Workspace")

-- 次の行は、パートがワークスペースに存在しない場合にエラーが発生します
Workspace.Part.Transparency = 0.5
```
より良いアプローチは、最初に `Part` を確認するために `FindFirstChild()` を使用し、その後に必要なコードを実行するための `if` 文を使用することです。

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace:FindFirstChild("Part")
if part then
	part.Transparency = 0.5
end
```

#### プロパティと一致する名前の子を見つける

時々、オブジェクトの `Class.Instance.Name|Name` がその `Class.Instance.Parent|Parent` のプロパティの名前と同じであることがあります。ドット演算子を使用すると、名前が同じ場合はプロパティが子よりも優先されます。

次の例では、`Class.Part` に `Color` という名前の `Class.Folder` が追加され、`Class.Part` には `Class.Part.Color` プロパティもあります。`part.Color` は子の `Class.Folder` インスタンスではなく、`Datatype.Color3` プロパティ値を参照していることに注意してください。`Class.Instance:FindFirstChild()|FindFirstChild()` を使用する利点は、新しいプロパティの導入がコードにリスクをもたらさないことです。

```lua
local part = Instance.new("Part")
local folder = Instance.new("Folder")
folder.Name = "Color"
folder.Parent = part
local c1 = part.Color  -- プロパティ
local c2 = part:FindFirstChild("Color")  -- 子フォルダ
```

#### パフォーマンスノート

`Class.Instance:FindFirstChild()|FindFirstChild()` は、ドット演算子を使用するよりも約 20% 長くかかり、オブジェクトへの参照を単に保存するよりも約 8 倍長くかかります。したがって、パフォーマンスに依存するコード（例えば、タイトなループや `Class.RunService.Heartbeat` および `Class.RunService.PreRender` に接続された関数）での呼び出しは避けるべきです。代わりに、結果を変数に保存するか、`Class.Instance.ChildAdded|ChildAdded` または `Class.Instance:WaitForChild()|WaitForChild()` を使用して、指定された名前の子が利用可能になるときに検出することを検討してください。


Instance:FindFirstChild

recursive

検索を再帰的に行うかどうか。


指定された名前で見つかった `Class.Instance` の最初の子を返します。


Instance:findFirstChild

`Class.Instance` の最初の子で、`Class.Object.ClassName|ClassName` が指定された `className` と等しいものを返します。`Class.Instance:FindFirstChildWhichIsA()` とは異なり、このメソッドはクラスの継承を無視し、`className` と一致するオブジェクトのみを返します。一致する子が見つからない場合、このメソッドは `nil` を返します。


Instance:FindFirstChildOfClass

検索する `Class.Object.ClassName`。


`Class.Instance` の最初の子で、`Class.Object.ClassName|ClassName` が指定されたクラス名と等しいものを返します。


`Class.Instance` の最初の子で、`Class.Object:IsA()` が指定された className に対して true を返します。

一致する子が見つからない場合、このメソッドは `nil` を返します。オプションの再帰引数が true の場合、このメソッドは `Class.Instance` の直近の子供だけでなく、すべての子孫を検索します。

`Class.Instance:FindFirstChildOfClass()` とは異なり、このメソッドはクラスの継承を尊重する `Class.Object:IsA()` を使用します。たとえば：

```lua
print(part:IsA("Part")) --> true
print(part:IsA("BasePart")) --> true
print(part:IsA("Instance")) --> true
```
したがって、次のコードサンプルは、最初の `Class.BasePart` 子を返します。`Class.WedgePart`、`Class.MeshPart`、または `Class.Part` であるかどうかにかかわらず。

```
local part = object:FindFirstChildWhichIsA("BasePart")
```
名前で子を探している開発者は、代わりに `Class.Instance:FindFirstChild()` を使用するべきです。


Instance:FindFirstChildWhichIsA

`Class.Instance` の最初の子で、`Class.Object:IsA()` が指定された className に対して true を返します。


指定された `Class.Instance.Name` で見つかった最初の子孫を返します。

このメソッドは無効であり、使用できません。インスタンスの最初の子孫を見つけるには、代わりに `Class.Instance:FindFirstChild()` の `recursive` パラメータを使用することを検討してください。


Instance:FindFirstDescendant

指定された `Class.Instance.Name` で見つかった最初の子孫を返します。


インスタンスが `Class.Actor` の場合、`Class.Actor` 自体が返されます。そうでない場合は、その最も近い祖先の `Class.Actor` が返されます。祖先が `Class.Actor` でない場合、結果は `nil` です。


Instance:GetActor

インスタンスに関連付けられた `Class.Actor` を返します。存在する場合。


このメソッドは、指定された属性名に割り当てられた値を返します。属性が割り当てられていない場合は `nil` が返されます。

たとえば、次のコードスニペットは、インスタンスの `InitialPosition` 属性の値を設定し、その後取得します：

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)

local initialPosition = instance:GetAttribute("InitialPosition")
print(initialPosition)
```

#### 参照

- 指定された名前の属性を指定された値に設定する `Class.Instance:SetAttribute()`。
- インスタンスの各属性のキー-値ペアの辞書を返す `Class.Instance:GetAttributes()`。


Instance:GetAttribute

指定された属性名に割り当てられた値。属性が割り当てられていない場合は `nil` が返されます。


指定された属性名に割り当てられた値を返します。


Instance

`Instance` は、`Class.DataModel` ツリーの一部となることができる Roblox クラス階層内のすべてのクラスの基本クラスです。


/reference/engine/classes/DockWidgetPluginGui.yaml

概要