`Class.SurfaceGui`は、3D空間のパーツの表面にUIオブジェクトを描画できるようにし、基本的なユーザーインタラクションも可能にします。 `Class.Decal|Decals`や`Class.Texture|Textures`と同様に、`Class.SurfaceGui`に親付けされた`Class.TextLabel|TextLabels`や`Class.ImageLabel|ImageLabels`などのUIオブジェクトは、対象の表面の向きを持ち、`Class.SurfaceGui.Face|Face`プロパティを通じて編集が可能です。

<img src="/assets/ui/in-experience/SurfaceGui-Diagram.jpg" width="800" alt="ImageLabelの子を持つ3Dパーツ上のSurfaceGuiを描写した画面コンソールを示す。" />

`Class.SurfaceGui`内の`Class.ImageButton|ImageButtons`や`Class.TextButton|TextButtons`のようなインタラクティブUI要素は、`Class.PlayerGui`に親付けされている場合にのみ、ユーザー入力を受け取ります。通常、`Class.SurfaceGui`は`Class.StarterGui`内に配置されます（`Class.SurfaceGui.Adornee|Adornee`プロパティを使用して3D空間のパーツをターゲットにすることができ、`Class.SurfaceGui`自体は`Class.PlayerGui`内に残ります）。さらに、パーツの`Class.BasePart.CanQuery|CanQuery`プロパティが`true`でないと、インタラクティブUI要素は入力を受け取ることができません。

`Class.SurfaceGui`コンテナでの作業方法については[In-Experience UI](/ui/in-experience-containers#surface-ui)のガイドを参照してください。

##### キャッシュ動作

パフォーマンスを改善するために、`Class.SurfaceGui`の外観は次のいずれかのことが発生するまでキャッシュされ、その後、外観は次の描画フレームで再計算されます。

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

SurfaceGui

このプロパティは、`Class.SurfaceGui`が他の3Dオブジェクトの上に常に描画されるかどうかを決定します。

`false`（デフォルト）に設定された場合、`Class.SurfaceGui`は他の3Dコンテンツのように描画され、他の3Dオブジェクトに隠されます。`true`に設定すると、`Class.SurfaceGui`は常に3Dコンテンツの上に描画され、外観が大きく変わります。

- 色は、`Class.ScreenGui`内での表示方法と一致します。
- テキストは、高DPIデバイスでシャープに表示される場合があります。
- `Class.SurfaceGui.LightInfluence|LightInfluence`は`0`であるかのように扱われます。
- `Class.SurfaceGui.Brightness|Brightness`は効果がありません。

SurfaceGui.AlwaysOnTop

`Class.SurfaceGui`が他の3Dオブジェクトの上に常に描画されるかどうかを決定します。

このプロパティは、`Class.SurfaceGui`コンテナの光が`Class.SurfaceGui.LightInfluence|LightInfluence`が`0`のときにスケールされるファクターを決定します。デフォルトでは、このプロパティは`1`であり、`0`から`1000`の間の任意の数値に設定できます。このプロパティを変更することで、`Class.SurfaceGui`の見かけの明るさを環境によりよく合わせることができます。たとえば、暗い部屋内のビデオビルボードは、`Class.SurfaceGui.Brightness|Brightness`を`10`に増加させることで明るくできます。

`Class.SurfaceGui.Brightness|Brightness`はStudioでは無効で、`Class.SurfaceGui.LightInfluence|LightInfluence`が`1`または`Class.SurfaceGui.AlwaysOnTop|AlwaysOnTop`が`true`のときは効果がありません。

SurfaceGui.Brightness

`Class.SurfaceGui.LightInfluence|LightInfluence`が`0`のとき、`Class.SurfaceGui`コンテナの光のスケールファクターを決定します。

`Class.SurfaceGui|SurfaceGuis`を`Class.ScreenGui|ScreenGuis`とピクセル単位で互換性を持たせるための「仮想ピクセル」の「仮想画面」のサイズ。

SurfaceGui.CanvasSize

`true`に設定された場合（デフォルト）、`Class.SurfaceGui`キャンバスの境界を超えた`Class.GuiObject|GuiObjects`の部分は描画されません。

このプロパティが`false`でも、キャンバスの外に**完全に**存在する`Class.GuiObject|GuiObjects`は描画されません。

SurfaceGui.ClipsDescendants

`Class.SurfaceGui`キャンバスの境界を超えた`Class.GuiObject|GuiObjects`の部分が描画されるかどうかを決定します。

`Class.SurfaceGui`が環境光によって影響を受ける程度を、`0`から`1`の範囲で制御します。`1`に設定すると、周囲の光が外観を完全に制御し、`0`に設定すると光が全く影響しなくなります。

SurfaceGui.LightInfluence

環境光によって`Class.SurfaceGui`が影響を受ける程度を制御します。

このプロパティは、カメラから`Class.SurfaceGui`が描画される距離を制御します。`0`の値は制限がなく、無限に遠く描画されます。デフォルト値の`1000`はほとんどのケースで問題ありません。

屋外に表示される`Class.SurfaceGui|SurfaceGuis`の場合、コンテナのUIが画面上で表示または非表示になる際に、十分に小さく見えるように`Class.SurfaceGui.MaxDistance|MaxDistance`を高く設定することをお勧めします。突然のポップイン/アウト効果を最小限に抑えます。

SurfaceGui.MaxDistance

`Class.SurfaceGui`が描画される前に表示される距離を制御します。

このプロパティは、ワールドスペーススタッドごとに`Class.SurfaceGui`の内容を描画するために使用されるピクセルの密度を決定します。高い値は、中のさまざまな`Class.GuiObject|GuiObjects`が同じサイズで保持されている場合、より小さく表示されることを引き起こします。逆に、低い値はオブジェクトが大きく見える原因となります。ただし、`Class.GuiObject|GuiObjects`が`Class.UIScale`、`Class.GuiObject.Size`、`Class.TextLabel.TextSize`、または類似のもので比例的にスケーリングされる場合、このプロパティにより高解像度が使用できます。

プレイヤーが`Class.SurfaceGui`を視認する距離に基づいて値を選択することが重要です。また、大きなピクセル密度が、装飾されたパーツの面が十分に大きい場合にパフォーマンスに悪影響を与える可能性があることに留意してください。

SurfaceGui.PixelsPerStud

`Class.SurfaceGui`の内容を描画するために、ワールドスペーススタッドごとに使用されるピクセルの密度を決定します。

`Enum.SurfaceGuiSizingMode.PixelsPerStud`（デフォルト）に設定された場合、`Class.SurfaceGui`は`Class.SurfaceGui.PixelsPerStud|PixelsPerStud`と表面のサイズに基づいて可変サイズで描画されます。

`Enum.SurfaceGuiSizingMode.FixedSize`に設定された場合、`Class.SurfaceGui`は`Class.SurfaceGui.CanvasSize|CanvasSize`を通じて設定された固定サイズで描画されます。

SurfaceGui.SizingMode

`Class.SurfaceGui`が固定サイズで描画されるか、スタッドのサイズに応じてスケールされるかを決定します。

左クリックが`Class.Tool`でなく`Class.SurfaceGui`に作用し始める距離を設定します。この距離内にキャラクターが`Class.SurfaceGui`にいる場合、クリックで`Class.Tool`はアクティブになりません。

SurfaceGui.ToolPunchThroughDistance

左クリックが`Class.Tool`でなく`Class.SurfaceGui`に作用し始める距離を設定します。

同じ面の他のオブジェクトに対してこの`Class.SurfaceGui`のレイヤーを設定します（これを変更しても`Class.SurfaceGui`が視覚的に「持ち上がる」ことや「沈む」ことはありません）。

SurfaceGui.ZOffset

同じ面の他の`Class.SurfaceGui|SurfaceGuis`に対するこの`Class.SurfaceGui`のレイヤーを設定します。

パーツの表面に描画されるGuiObjectのコンテナ。

SurfaceGuiBase

このプロパティは、`Class.SurfaceGui`が入力を無視するかどうかを決定します。例えば、親または`Class.SurfaceGuiBase.Adornee|Adornee`パートが`Class.DragDetector`のような`Class.ClickDetector`クラスを含む場合です。

インタラクティブなUI要素、例えば`Class.ImageButton|ImageButtons`や`Class.TextButton|TextButtons`が`Class.SurfaceGui`内にある場合、これらは`Class.PlayerGui`に親が付けられている場合にのみユーザー入力を受け取ります（`Class.SurfaceGui.Adornee`プロパティは、`Class.SurfaceGui`自身が`Class.PlayerGui`にある間に3D空間内のパートをターゲットにするために使用できます）。さらに、パートの`Class.BasePart.CanQuery|CanQuery`プロパティが`true`である必要があります。

SurfaceGuiBase.Active

`Class.BasePart`に`Class.SurfaceGui`を適用し、デフォルトの親の関連付けをオーバーライドします。

SurfaceGuiBase.Adornee

`Class.SurfaceGui`親（またはその`Class.SurfaceGuiBase.Adornee|Adornee`）に適用する`Enum.NormalId`面です。

SurfaceGuiBase.Face

`Enum.NormalId`面に`Class.SurfaceGui`を適用します。

**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

newSelection

ゲームパッドの選択が接続された `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` への参照。

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

GuiBase2d.SelectionBehaviorDown

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

GuiBase2d.SelectionBehaviorLeft

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

GuiBase2d.SelectionBehaviorRight

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

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` はRobloxクラス階層のすべてのクラスの基本クラスであり、`Class.DataModel` ツリーの一部であることができます。

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

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

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


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

このイベントを使用して、スタジオ内のインスタンスの削除を追跡できます。例えば、Explorer での手動削除やプラグインを通じての削除です。`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

`Class.Instance` の属性が変更されるたびに発火します。

このスニペットは、オブジェクトが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` 以外の何かに変更されることを指します。このイベントは、子が破壊されたとき（`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` は決してメモリから削除されることはありません。ただし、関数が途中でyieldする場合、`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 を通じて手動で削除する場合やプラグインを通じて削除する場合には、`Class.Instance` は破壊されず、代わりに親が `nil` に設定されます。これを `Class.Instance.AncestryChanged` で追跡できます。

Instance.Destroying

`Class.Instance:Destroy()` を通じてインスタンスが破壊される直前（または後に遅延される）に発火します。

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

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

local player = Players.LocalPlayer
local playerGui = player.PlayerGui
local HUDContainer = playerGui:WaitForChild("HUDContainer")
local meterBar = HUDContainer.MeterBar

local function stylePropertyChanged()
	print("Styled properties changed")
end

meterBar:StyledPropertiesChanged():Connect(stylePropertyChanged)
```

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` でないインスタンスを無視します。

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` の最初の祖先を返します。

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

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

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

Instance:FindFirstAncestor

name

見つかった `Class.Instance` です。

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

指定された className に等しい `Class.Object.ClassName` を持つ `Class.Instance` への最初の祖先を返します。

このメソッドは上方向に機能します、つまり、インスタンスの直接の `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` です。

指定された className に等しい `Class.Object.ClassName` を持つ `Class.Instance` への最初の祖先を返します。

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

このメソッドは上方向に機能します、つまり、インスタンスの直接の `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

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

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

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

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

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

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

-- 次の行はパートがワークスペースに存在しない場合にエラーを発生します
Workspace.Part.Transparency = 0.5
```
より良いアプローチは、最初に `FindFirstChild()` を使用して `Part` が存在するかを確認し、その後 `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.Color` プロパティも持っています。注意が必要なのは、`part.Color` は子供の `Class.Folder` インスタンスではなく、プロパティへの参照です。 `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

検索する `Class.Instance.Name` です。

recursive

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

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

Instance:findFirstChild

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

Instance:FindFirstChildOfClass

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

指定されたクラス名に等しい `Class.Object.ClassName|ClassName` を持つ `Class.Instance` の最初の子を返します。

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

一致する子が見つからない場合、このメソッドは `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

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

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

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

Instance:FindFirstDescendant

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

`Class.Instance` が `Class.Actor` の場合は、自身の `Class.Actor` を返します。そうでない場合は、最も近い祖先の `Class.Actor` が返されます。祖先が `Class.Actor` でない場合、結果は `nil` です。

Instance:GetActor

`Instance` に関連付けられている `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` が返されます。

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

このメソッドは、指定された属性が変更されたときにのみ発生するイベントを返します。基本的には `Class.Object.Changed|Changed` イベントに非常に似た動作をしますが、特定の指定された属性が変更されたときだけ発生します。

一般的に、このメソッドを使用して特定の属性名を確認する関数に接続するよりも、これを使用することが良いアイデアです。同じオブジェクトに対して同じ属性名でこのメソッドを呼び出すと、同じイベントが返されます。

次のコード例では、部分の `InitialPosition` 属性が変更されると、`attributeChanged()` 関数が発生する信号を返します：

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

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

local function attributeChanged()
	print("属性が変更されました")
end

part:GetAttributeChangedSignal("InitialPosition"):Connect(attributeChanged)
```
また、インスタンス上の任意の属性が変更されたときに発生する `Class.Instance.AttributeChanged` も参照してください。

Instance:GetAttributeChangedSignal

変更信号が返される指定された属性の名前です。

指定された属性が変更されたときに発生するイベントです。

指定された属性が変更されたときに発生するイベントを返します。

このメソッドは、各属性の名前がキーで関連付けられ、値が非-`nil` の値を持つキー-バリューペアの辞書を返します。

たとえば、次のコードスニペットはインスタンスの属性と値を出力します：

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

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

for name, value in part:GetAttributes() do
	print(name .. " = " .. value)
end
```
また、指定された属性名に割り当てられた値を返す `Class.Instance:GetAttribute()` も参照してください。

Instance:GetAttributes

属性の名前をキー、非-`nil` の値を持つ各属性のキー-バリューペアの辞書です。

インスタンスの属性の辞書を返します。

下記は、実行時にWorkspace内のすべてのオブジェクトの名前を印刷します。

すべてのインスタンスの直接の子供を含む配列（数値インデックスのテーブル）を返します。オブジェクトの `Class.Instance.Parent|Parent` が等しいすべての `Class.Instance` です。配列は数値または一般的な `for` ループを使用して繰り返すことができます：

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

-- 数値ループの例
local children = Workspace:GetChildren()
for i = 1, #children do
	local child = children[i]
	print(child.Name .. " は子供の番号 " .. i .. " です")
end
```

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

-- 一般的なループの例
local children = Workspace:GetChildren()
for i, child in children do
	print(child.Name .. " は子供の番号 " .. i .. " です")
end
```
返された配列は **特定の順序で** ソートされていないので、手動でソートすること（たとえば、`Library.table.sort()` を使って）を推奨します、このメソッドによって返された子供をソートするために。

また、`Class.Instance:GetDescendants()|GetDescendants()` メソッドも参照してください。

Instance:GetChildren

インスタンスの子供のすべてを含む配列を返します。

Instance

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

/reference/engine/classes/SurfaceGui.yaml