`Class.GlobalDataStore:SetAsync()` 呼び出しのための追加パラメータを指定するオブジェクトです。

参照:

- [データストア](/cloud-services/data-stores)、データ構造、管理、エラーハンドリングなどに関する詳細なガイド。

この `Class.DataStoreSetOptions` インスタンスに関連付けられたカスタムメタデータを取得します。

DataStoreSetOptions:GetMetadata

この `Class.DataStoreSetOptions` インスタンスに関連付けられたメタデータです。

この `Class.DataStoreSetOptions` インスタンスに設定されたカスタムメタデータを取得します。

この関数は、キーにメタデータを関連付けるために `Class.GlobalDataStore:SetAsync()` で使用されるカスタムメタデータを設定します。
メタデータはキーと値のペア形式で指定する必要があります。

DataStoreSetOptions:SetMetadata

attributes

キーのために設定するメタデータの値。

キーに関連付けるカスタムメタデータを設定します。

DataStoreSetOptions

`Class.GlobalDataStore:SetAsync()` 呼び出しのための追加パラメータを指定します。

`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` が返されます。


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


このメソッドは、`Class.Object.Changed|Changed` イベントとまったく同じように動作するイベントを返しますが、特定の指定された属性が変更されたときにのみ発火します。一般的には、属性名をチェックする関数を持つ `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("Attribute changed")
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` の `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 .. " is child number " .. i)
end
```

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

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

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


Instance:GetChildren

インスタンスの子供を含む配列。


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


Instance:getChildren

Roblox によって内部的に使用されるデバッグ ID のコーディングされた文字列を返します。注意点：

- このアイテムは保護されています。`Class.Script` または `Class.LocalScript` で使用しようとするとエラーが発生します。
- デバッグ ID は、デバッグプロセスで使用される ID です。デバッガがアプリケーションが処理する前に各命令を読み取ることを可能にします。Roblox のすべてのオブジェクトはプロセスのように動作し、必要に応じてデバッグ可能な命令（または「コード」）を実行します。
- これは、同様のオブジェクトを区別する必要があるプラグインに役立ちます（たとえば、同じ名前を共有するオブジェクトなど）。


Instance:GetDebugId

scopeLength

Roblox によって内部的に使用されるデバッグ ID のコーディングされた文字列を返します。


GetDescendants は、特定のタイプのオブジェクトのすべての子孫に対して何かを行うためにしばしば使用されます。この例のコードは GetDescendants と `Class.Instance:IsA()` を使用してワークスペース内のすべての部品を見つけ、それらを緑色に変更します。

このオブジェクトメソッドは、そのオブジェクトのすべての子孫を含む配列を返します。`Class.Instance:GetChildren()` とは異なり、このメソッドはオブジェクトのすべての子供、その子供のすべての子供、などを見つけます。

返される配列は特定の順序で **ソートされていない** ため、このメソッドによって返された子孫をソートするには手動でソートすることをお勧めします。また、セレクタとコンビネータの組み合わせで子孫をクエリするために `Class.Instance:QueryDescendants()|QueryDescendants()` メソッドを検討してください。


Instance:GetDescendants

インスタンスの子孫を含む配列。


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


このコードサンプルは、`Class.Instance:GetFullName()` の動作を示します。
`DataModel` 階層にないオブジェクトで呼び出したときの関数の動作を示し、
戻り値が特殊文字をエスケープしないことも示します。

このコードサンプルは、`Class.Instance:GetFullName()` 関数を Lua で再実装します。


インスタンスの系譜を説明する文字列を返します。この文字列は、オブジェクトの `Class.Instance.Name|Name` とその祖先をピリオドで区切って連結したものです。`Class.DataModel`（`game`）は考慮されません。たとえば、`Class.Workspace` の `Class.Part` は `Class.Workspace.Part` を返す可能性があります。

`Class.DataModel` の子孫でない `Class.Instance` に対して呼び出された場合、このメソッドは `Class.Instance.Parent|Parent` がない最上位の祖先までのすべての祖先を考慮します。

このメソッドは、ログ記録やデバッグに役立ちます。返された文字列を有用な操作のために解析しようとしないでください。このメソッドはオブジェクト名のピリオド（または他のシンボル）をエスケープしません。言い換えれば、その出力は有効な Luau 識別子のように見えることが多いですが、保証されていません。


Instance:GetFullName

インスタンスの系譜を説明する文字列を返します。


`Class.Instance:GetStyled()`を示します。


このメソッドは、指定されたプロパティのスタイルまたは明示的に変更された値を返します。スタイル/変更されていない場合はデフォルトのプロパティ値を返します。これは、`[GuiObject].Rotation` のようにプロパティ値に直接アクセスすることとはわずかに異なります。これは、プロパティのデフォルトまたは変更された値を返します。


Instance:GetStyled

クエリするプロパティの名前。


selector

インスタンス上でターゲットにしている擬似インスタンスのオプションのセレクタ。


指定されたプロパティのスタイルまたは明示的に変更された値、またはスタイル/変更されていない場合はデフォルトのプロパティ値。


指定されたプロパティのスタイルまたは明示的に変更された値を返します。スタイル/変更されていない場合はデフォルトのプロパティ値を返します。


この例は `Class.Instance:GetStyledPropertyChangedSignal()` を示しています。


このメソッドは、`Class.Instance.StyledPropertiesChanged|StyledPropertiesChanged` イベントとまったく同じように動作するイベントを返しますが、指定されたスタイルプロパティが変更されたときにのみ発火します。このメソッドを使用することをお勧めします。プロパティ名をチェックする関数を持つ `Class.Instance.StyledPropertiesChanged|StyledPropertiesChanged` への接続の代わりに。このメソッドを同じオブジェクトに対して同じプロパティ名で後で呼び出すと、同じイベントが返されます。

このイベントは、接続された関数に引数を渡さないため、変更されたプロパティの値はスクリプト内で直接読み取る必要があります。


Instance:GetStyledPropertyChangedSignal

property

変更をリッスンするスタイルプロパティの名前。


指定されたスタイルプロパティが変更されたときに発火するイベント。


インスタンス上で指定されたスタイルプロパティが変更されたときに発火するイベントを返します。


このメソッドは、指定されたインスタンスに適用されたタグの配列を文字列として返します。Studio の [プロパティ](/studio/properties) ウィンドウで、または実行時に `Class.Instance:AddTag()|AddTag()` でタグを追加できます。

このメソッドは、インスタンスの複数のタグで何かを行いたいときに便利です。ただし、単一のタグの存在を確認するためにこのメソッドを使用するのは非効率的です。代わりに、特定のタグを確認するには `Class.Instance:HasTag()|HasTag()` を使用してください。


Instance:GetTags

インスタンスに適用されたタグを表す文字列の配列。


インスタンスに適用されたすべてのタグの配列を取得します。


このメソッドは、提供されたタグがオブジェクトに追加されている場合は `true` を返します。Studio の [プロパティ](/studio/properties) ウィンドウで、または実行時に `Class.Instance:AddTag()|AddTag()` でタグを追加できます。


Instance:HasTag

インスタンスで確認するタグ。


インスタンスが指定されたタグを持っている場合は `true`、そうでない場合は `false`。


インスタンスに指定されたタグがあるかどうかを確認します。


あるインスタンスが別のインスタンスの祖先であるかどうかを判断する方法を示します
`Class.Instance:IsAncestorOf()`

WorkspaceとSpawnLocationは、SpawnLocationのデカールの祖先です。
WorkspaceはSpawnLocationの祖先です。

SpawnLocationとそのデカールはWorkspaceの子孫であり、祖先ではありません。
デカールはSpawnLocationの子孫であり、祖先ではありません。


`Class.Instance` が指定された子孫の祖先である場合は `true` を返します。

`Class.Instance` は、オブジェクトの `Class.Instance.Parent` またはその親のいずれかの `Class.Instance.Parent` が `Class.Instance` に設定されている場合、オブジェクトの祖先と見なされます。

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


Instance:IsAncestorOf

指定された子孫の祖先が `Class.Instance` である場合は true。


`Class.Instance` が指定された子孫の祖先である場合は `true` を返します。


`Class.Instance` が指定された祖先の子孫である場合は `true` を返します。

`nil` のパラメータで `IsDescendantOf()` を使用してオブジェクトが削除されたかどうかを確認することはできません。

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


Instance:IsDescendantOf

ancestor

指定された祖先の子孫が `Class.Instance` である場合は true。


`Class.Instance` が指定された祖先の子孫である場合は `true` を返します。


Instance:isDescendantOf

このメソッドは、特定のプロパティがコードで生成されたデフォルトから変更されているかどうかを示します。`Datatype.Instance.new()` を介して新しく作成されたインスタンスで呼び出すと、このメソッドは `false` を返します。Studio ワークフロー（たとえば、[Explorer](/studio/explorer) ウィンドウの挿入）によって新しく作成されたオブジェクトで呼び出すと、結果が異なる場合があります。

たとえば、[Explorer](/studio/explorer) を介して挿入された `Class.TextLabel` の `BackgroundColor3|BackgroundColor3` プロパティをクエリすると `true` が返されますが、`Datatype.Instance.new()` を介して作成された `Class.TextLabel` の同じプロパティをクエリすると、他に変更がない限り `false` が返されます。

このメソッドは、サービスおよびユーザーが作成できるインスタンスに対してのみ有用な結果を返します。`Class.PackageLink` のようなインスタンスのシステムによってポピュレートされたプロパティの戻り値は未定義の動作です。

このメソッドが `true` を返す場合、スタイリングは **プロパティに影響を与えません**。なぜなら、プロパティを明示的に変更することがスタイリングよりも優先されるからです。プロパティをコードで生成されたデフォルトにリセットし、スタイリングを許可するには、`Class.Instance:ResetPropertyToDefault()|ResetPropertyToDefault()` を使用します。


Instance:IsPropertyModified

プロパティがコードで生成されたデフォルトから変更されているかどうかを示すブール値。


指定されたプロパティに格納されている値がコードで生成されたデフォルトと等しくない場合は `true` を返します。


このオブジェクトメソッドは、提供された `selector` 文字列に一致するオブジェクトのすべての子孫を含む配列を返します。 `selector` には、クラス名、インスタンス名、階層関係、インスタンスプロパティや属性の特定の値などの特性に一致させるために、複数のセレクタやコンビネータを含めることができます。 `selector` の文法は `Class.StyleRule` で使用されるものに似ていますが、サポートされる文法の部分に関してはわずかに異なります。

#### セレクタ

- `ClassName` — 指定されたクラスのインスタンスに一致します。
- `.Tag` — `Class.CollectionService` タグでタグ付けされたインスタンスに一致します。
- `#Name` — 特定の `Class.Instance.Name` のインスタンスに一致します。
- `[property = value]` — 指定されたプロパティを持ち、そのプロパティが指定された値を持つインスタンスに一致します。ブール値、数値、文字列の値がサポートされています。文字、数字、`_`、および `-` は、値を引用符で囲まずに使用できます。
- `[$attribute]` — 指定された [attribute](/studio/properties#instance-attributes) が設定されているインスタンスに一致します。
- `[$attribute = value]` — 指定された属性を持ち、その属性が指定された値を持つインスタンスに一致します。プロパティセレクタと同じ制限が適用されます。属性の存在を確認したい場合は、`nil` としてクエリしないでください。代わりに `:not` 擬似クラスを使用して `:not([$attribute])` のようにします。

セレクタは組み合わせることもできます。たとえば、`Model.Apple[$Variety = Fuji][$Flavor = 4]` は、`Apple` とタグ付けされた `Class.Model` のインスタンスで、`Variety` 属性が `Fuji` に等しく、`Flavor` 属性が `4` に等しいインスタンスに一致します。

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

-- すべての MeshPart 子孫を取得
print(Workspace:QueryDescendants("MeshPart"))

-- タグが "Fruit" のすべての子孫を取得
print(Workspace:QueryDescendants(".Fruit"))

-- 名前が "RedTree" のすべての子孫を取得
print(Workspace:QueryDescendants("#RedTree"))

-- CanCollide プロパティが false に設定されているすべての子孫を取得
print(Workspace:QueryDescendants("[CanCollide = false]"))

-- "FuelCapacity" 属性が割り当てられているすべての子孫を取得
print(Workspace:QueryDescendants("[$FuelCapacity]"))
-- "FuelCapacity" 属性が 75 に設定されているすべての子孫を取得
print(Workspace:QueryDescendants("[$FuelCapacity = 75]"))
```

#### コンビネータ

コンビネータを使用すると、基本的なセレクタを組み合わせて、より深い階層関係に一致させることができます。

- `>` — 前のフィルターマッチの **直接の子** に一致します。

- `>>` — 前のフィルターマッチの **子孫** に一致します。これはデフォルトの最初のフィルターであり、`SpotLight.Red` は `>> SpotLight.Red` と同じです。

- `,` — 子孫クエリのための複数の独立したセレクタのリストを指定します。フィルターに一致する要素のみが返される配列に配置され、クエリリスト内の非一致に対して `nil` は含まれません。

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

-- タグが "SwordPart" の任意の Model の直接の子を取得
print(Workspace:QueryDescendants("Model > .SwordPart"))

-- Part であり、タグが "Apple" の直接の子を取得
print(Workspace:QueryDescendants("> Part.Apple"))

-- 属性 "OnFire" が true に設定されている任意の Model の子孫を取得
print(Workspace:QueryDescendants("Model >> [$OnFire = true]"))

-- タグが "SwordPart" の MeshPart 子孫 OR 属性 "OnFire" が true に設定されている子孫を取得
print(Workspace:QueryDescendants("MeshPart.SwordPart, MeshPart[$OnFire = true]"))
```

#### 擬似クラスセレクタ

- `:not(complex-selector-list)` — 内部のセレクタのいずれにも **一致しない** インスタンスを選択できます。これは、セレクタの否定を実行します。内部の式は複雑なセレクタのリストであるため、複数の条件に基づいてフィルタリングすることが可能です。

- `:has(relative-selector-list)` — 含まれているインスタンスに基づいてインスタンスを選択できます。セレクタリストは各インスタンスに対して評価されます。

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

-- クラス SpotLight ではないすべての子孫を取得
print(Workspace:QueryDescendants(":not(SpotLight)"))
-- クラス SpotLight または PointLight ではないすべての子孫を取得
print(Workspace:QueryDescendants(":not(SpotLight, PointLight)"))
-- 属性 "OnFire" を持たないすべての子孫を取得
print(Workspace:QueryDescendants(":not([$OnFire])"))
-- タグが "SwordPart" の Model の子を除くすべての子孫を取得
print(Workspace:QueryDescendants(":not(Model > .SwordPart)"))

-- Tool インスタンスを自身の子孫として含む子孫を取得
print(Workspace:QueryDescendants(":has(Tool)"))
-- タグが "SwordPart" の直接の子を含む MeshPart 子孫を取得
print(Workspace:QueryDescendants("MeshPart:has(> .SwordPart)"))

-- SurfaceAppearance または Texture クラスではない直接の子を持つ MeshPart 子孫を取得
print(Workspace:QueryDescendants("MeshPart:has(> :not(SurfaceAppearance, Texture))"))
```


Instance:QueryDescendants

要素をフィルタリングするために使用されるセレクタ文字列。


インスタンスの配列（セレクタに一致するものがない場合は空）。


指定された `selector` 文字列に一致するインスタンスのすべての子孫を含む配列を返します。


以下のコードは、パーツが削除された後にDataModelに再追加される方法を示しています:


このメソッドは、オブジェクトの `Class.Instance.Parent` を `nil` に設定し、すべての子孫にも同様の操作を行います。

オブジェクトが削除される前に参照されている場合、後でオブジェクトを取得することが可能です。


Instance:Remove

オブジェクトの `Parent` を `nil` に設定し、すべての子孫にも同様の操作を行います。


Instance:remove

このメソッドは、インスタンスからタグを削除します。オブジェクトにタグがない場合はエラーをスローしません。タグを正常に削除すると、指定されたタグで `Class.CollectionService:GetInstanceRemovedSignal()` によって作成された信号が発火します。

インスタンスにタグを付ける際には、タグの機能を提供するためにいくつかのリソースが使用されることが一般的です。たとえば、イベント接続やテーブルなどです。メモリリークを防ぐために、タグが不要になったときにこれらをクリーンアップする（切断、`nil` に設定するなど）ことが良いアイデアです。


Instance:RemoveTag

インスタンスから削除するタグ。


インスタンスからタグを削除します。


プロパティをデフォルト値にリセットします。たとえば、`Class.TextLabel` の `ResetPropertyToDefault("Rotation")` を呼び出すことは、その `Class.TextLabel.Rotation|Rotation` を `0`（プロパティのデフォルト値）に設定することと同じです。このメソッドは、スタイリングがこのプロパティのデフォルト値を上書きすることを保証するために使用できます。


Instance:ResetPropertyToDefault

リセットするプロパティの名前。


プロパティをデフォルト値にリセットします。


このメソッドは、指定された名前の属性を指定された値に設定します。指定された値が `nil` の場合、属性は削除されます。なぜなら、デフォルトで `nil` が返されるからです。

たとえば、次のコードスニペットは、インスタンスの `InitialPosition` 属性を `Datatype.Vector3|Vector3.new(0, 10, 0)` に設定します：

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

local part = Workspace.Part
part:SetAttribute("InitialPosition", Vector3.new(0, 10, 0))
```

#### 制限

命名要件と制限：

- 名前は英数字のみを使用する必要があります。
  - ピリオド、ハイフン、スラッシュ、アンダースコアも含めることができます。
- スペースやユニークな記号（@、~、! など）は許可されていません。
- 文字列は 100 文字以下でなければなりません。
- 名前は **RBX** で始まることは許可されていません。呼び出し元が Roblox コアスクリプトである場合を除きます（Roblox 用に予約されています）。

サポートされていない型に属性を設定しようとすると、エラーがスローされます。

#### 参照

- `Class.Instance:GetAttribute()` は、指定された属性名に割り当てられた値を返します。
- `Class.Instance:GetAttributes()` は、インスタンスの各属性のキーと値のペアの辞書を返します。


Instance:SetAttribute

value

指定された属性に設定する値。


指定された名前の属性を指定された値に設定します。


Instance

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


/reference/engine/classes/DataStoreSetOptions.yaml

概要