以下のコードは、PluginMouse オブジェクトを取得し、プラグイン内で使用する方法を示しています。このコードを使用するには、`Script` に貼り付けて、そのスクリプトを右クリックしてローカル Plugins フォルダーに保存します。プラグインフォルダーは、Roblox Studio のツールバーの Plugins タブにあります。

PluginMouseオブジェクトは、`Class.Plugin|Plugins`にマウスへのアクセスを提供します。それは
`Class.Mouse`オブジェクトのように機能し、プラグインの
`Class.Plugin:GetMouse()`メソッドを使用して取得できます。

PluginMouseはプラグインが`Class.Plugin:Activate()`を使用してアクティベートされている場合にのみ使用できます。

`Class.Mouse`オブジェクトの関数に加えて、PluginMouseにはマウスがドラッグ中に選択されているアイテムを追跡する
`Class.PluginMouse.DragEnter`関数が含まれています。

マウスオブジェクトの使い方についての詳細は、`Class.Mouse`ページを参照してください。

マウスがドラッグ中にインスタンスが選択されるときに発火します。

PluginMouse.DragEnter

instances

PluginMouse

PluginMouseオブジェクトは、`Class.Plugin|Plugins`にマウスへのアクセスを提供します。それは
`Class.Mouse`オブジェクトのように機能し、プラグインの
`Class.Plugin:GetMouse()`メソッドを使用して取得できます。

**Mouse** は `Class.UserInputService` と `Class.ContextActionService` に取って代わられました。これらはより広範囲をカバーし、より多機能で、**クロスプラットフォーム** パターンをより良くサポートします。広く使用されているためサポートは続きますが、これらの代替品を使用することを強くお勧めします。

**Mouse** オブジェクトは、主にボタンとレイキャスティングのためのポインター向けのさまざまな API を提供します。これは、`Class.LocalScript` 内の `Class.Players.LocalPlayer` に対して呼び出すことにより、 `Class.Player:GetMouse()` からアクセスできます。また、`Class.Tool.Equipped` イベントによっても渡されます。

- 最も注目すべきは、カーソルの外観を変更する `Class.Mouse.Icon|Icon` プロパティです。
- これは `Class.Mouse.TargetFilter|TargetFilter` プロパティを使用して画面のマウス位置を 3D ワールドに連続的にレイキャストし、レイキャストの結果を `Class.Mouse.Hit|Hit`、`Class.Mouse.Target|Target`、および `Class.Mouse.TargetSurface|TargetSurface` プロパティに保存します。これらは単純なケースには役立ちますが、より複雑な [レイキャスティング](/workspace/raycasting) シナリオでは `Class.WorldRoot:Raycast()` を使用するべきです。
- `Class.Plugin|Plugins` は `Class.Plugin:GetMouse()` を使用して `Class.PluginMouse` を取得し、同様に動作します。

```lua
-- LocalScript 内から:
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
-- マウスカーソルのアイコンを設定
mouse.Icon = "rbxasset://SystemCursors/Wait"
```
注意:

- このオブジェクトはポインターの動きを制御/制限しません。これについては、`Class.UserInputService.MouseBehavior` および `Class.UserInputService.MouseDeltaSensitivity` を参照してください。
- もし二つの関数が同じ入力イベントに接続されている場合（例えば、`Class.Mouse.Button1Down|Button1Down`）、イベントが発火すると**両方**の関数が実行されます。入力を沈めたり渡したりする概念はなく、イベントはこれをサポートしません。ただし、 `Class.ContextActionService` は `Class.ContextActionService:BindAction()|BindAction` を介してこの動作を持っています。
- マウスがすべてのプラットフォームで利用可能ではない場合でも、Mouse はモバイル（タッチ）やコンソール（ゲームパッド）で機能します。これらは通常マウスやポインターハードウェアを持っていません。明示的なクロスプラットフォームの動作には、 `Class.UserInputService` および `Class.ContextActionService` を使用してください。

経験の中での入力のカスタマイズについての詳細は、[Input and Camera](/input)を参照してください。

このイベントは、プレイヤーが左マウスボタンを押したときに発生します。このイベントは `Class.Tool` からアクセスできます。たとえば、`Class.LocalScript` に配置された場合、以下のコードは左マウスボタンが押されるたびに `Button1Down` を出力します。

```lua
local tool = script.Parent  -- これがToolオブジェクトであることを確認してください

tool.Equipped:Connect(function(mouse)
	mouse.Button1Down:Connect(function()
		print("Button1Down")
	end)
end)
```
ワールド空間におけるマウスの位置や、`Class.BasePart` を指しているかどうかを `Class.Mouse.Hit|Hit` および `Class.Mouse.Target|Target` プロパティを使用して確認できます。

Mouse.Button1Down

左マウスボタンが押されたときに発生します。

このイベントは、プレイヤーが左マウスボタンを放 releasedしたときに発生します。このイベントは `Class.Tool` からアクセスできます。たとえば、`Class.LocalScript` に配置された場合、以下のコードは左マウスボタンが放 releasedされるたびに `Button1Up` を出力します。

```lua
local tool = script.Parent  -- これがToolオブジェクトであることを確認してください

tool.Equipped:Connect(function(mouse)
	mouse.Button1Up:Connect(function()
		print("Button1Up")
	end)
end)
```
ワールド空間におけるマウスの位置や、`Class.BasePart` を指しているかどうかを `Class.Mouse.Hit|Hit` および `Class.Mouse.Target|Target` プロパティを使用して確認できます。

Mouse.Button1Up

左マウスボタンが放 releasedされたときに発生します。

このイベントは、プレイヤーが右マウスボタンを押したときに発生します。このイベントは `Class.Tool` からアクセスできます。たとえば、`Class.LocalScript` に配置された場合、以下のコードは右マウスボタンが押されるたびに `Button2Down` を出力します。

```lua
local tool = script.Parent  -- これがToolオブジェクトであることを確認してください

tool.Equipped:Connect(function(mouse)
	mouse.Button2Down:Connect(function()
		print("Button2Down")
	end)
end)
```
ワールド空間におけるマウスの位置や、`Class.BasePart` を指しているかどうかを `Class.Mouse.Hit|Hit` および `Class.Mouse.Target|Target` プロパティを使用して確認できます。

Mouse.Button2Down

右マウスボタンが押されたときに発生します。

このイベントはプレイヤーが右マウスボタンを放したときに発火します。注意してください。このイベントは `Class.Tool` からアクセス可能です。例えば、`Class.LocalScript` に配置した場合、以下のコードは右マウスボタンが放たれるたびに `Button2Up` を印刷します。

```lua
local tool = script.Parent  -- これは Tool オブジェクトであることを確認してください

tool.Equipped:Connect(function(mouse)
	mouse.Button2Up:Connect(function()
		print("Button2Up")
	end)
end)
```
マウスの位置をワールド空間で調べたり、任意の `Class.BasePart` を指しているかどうかは、`Class.Mouse.Hit|Hit` および `Class.Mouse.Target|Target` プロパティを使用して確認できます。

Mouse.Button2Up

右マウスボタンが放 releasedされたときに発生します。

この例は、各フレーム中にマウスイベントがどのように渡されるかを示しています


マウスが他のマウスイベントに渡されていない間の毎フレームで発火します。

注意: このイベントはマウスが静止しているかどうかを判断するために使用すべきではありません。これは毎フレーム発火するため、`Class.Mouse.Move` イベントの間にも発火します。

`Class.Mouse` オブジェクトを取得する方法については、`Class.Mouse` ページを参照してください。

開発者は、マウスの位置をワールド空間で調べたり、任意の `Class.BasePart` を指しているかどうかは、`Class.Mouse.Hit` および `Class.Mouse.Target` プロパティを使用して確認できます。

注意: 開発者は新しい作業では `Class.UserInputService` を使用することを推奨されます。

Mouse.Idle

マウスが他のマウスイベントに渡されていない間の毎フレームで発火します。

以下の例は、'mouse'が定義されていると仮定すると、押されたキー（例えば、"q"）とそのキーのascii値（例えば、113）を印刷します。

このイベントはキーが押されたときに発火し、渡される引数は押されたキーです。

注意:

- すべてのキーがこのイベントを生成するわけではありません。ただし、`Class.Mouse.KeyUp` イベントを使用することで、いくつかのキーで回避できます。例えば、"/" などです。
- 一部のキーは他のキーと同じ文字列を生成します。
- 文字列が空である可能性もあります（"\0" キーコードによる可能性があります）。

Mouse.KeyDown

キーが押されたときに発火します。

Mouse.keyDown

以下の例では、'mouse' が定義されていると仮定すると、リリースされたキー（例："q"）とそのキーの ASCII 値（例：113）が印刷されます。

キーが放されたときに発火するイベントであり、渡された引数は放されたキーです。

注意：

- すべてのキーがこのイベントを生成するわけではありません。たとえば、"/" のような一部のキーは、[[API:Class/Mouse/KeyUp|KeyUp]] イベントを使用することで回避可能です。
- 一部のキーは他のキーと同じ文字列を生成します。
- 文字列が空である可能性があります（「\\0」キーコードによる可能性があります）。


Mouse.KeyUp

キーが放されたときに発火します。


以下の例では、`Class.Players.LocalPlayer|ローカルプレイヤー`がマウスでパーツを移動できるようになります。

プレイヤーがパーツの上で左マウスボタンを押すと、そのパーツが`Class.Mouse.Target|マウスのターゲット`となり、_ポイント_になります。プレイヤーが左マウスボタンを放すまで、そのパーツはプレイヤーがマウスを動かすときにマウスのワールド位置に移動します。

`Class.Mouse.TargetFilter`プロパティにより、マウスのワールド位置を決定する際に移動されるパーツを無視することができます。

このコードは`LocalScript`に配置すると期待通りに動作するはずです。

マウスが移動したときに発火します。

このイベントは、マウスの位置が更新されたときに発火するため、移動中は繰り返し発火します。

`Class.Mouse` オブジェクトの取得方法については、`Class.Mouse` ページを参照してください。

開発者は、マウスがワールド空間でどの位置にあるかを知ることができ、また `Class.BasePart` を指しているかどうかを `Class.Mouse.Hit` および `Class.Mouse.Target` プロパティを使用して調べることができます。

```
mouse.Move:Connect(function()
	local position = mouse.Hit.p
	local target = mouse.Target
	print(target, position)
end)
```
開発者は、新しい作業では `Class.Mouse` オブジェクトの代わりに `Class.UserInputService` を使用することをお勧めします。


Mouse.Move

マウスが移動したときに発火します。


以下の例は、プレイヤーのマウスをすでに取得して（変数名を 'mouse' に設定している）ことを前提としています。これは `Class.Tool`、`Class.HopperBin` または `Class.Player:GetMouse()` メソッドを使用して取得できます。プレイヤーが後方にスクロールすると "ホイールが後方に移動しました！" と表示します。

WheelBackward イベントは、マウスホイールが後方にスクロールしたときに発火します。このイベントの可能な使用法には、FPSにおける武器のスコープの切り替えやプレイヤーのカメラのズームが含まれます。

これはスクロール前方のイベント `Class.Mouse.WheelForward` とともに使用できます。

`Class.Mouse` オブジェクトの取得方法については、`Class.Mouse` ページを参照してください。

開発者は、新しい作業では `Class.Mouse` オブジェクトの代わりに `Class.UserInputService` を使用することをお勧めします。


Mouse.WheelBackward

マウスホイールが後方にスクロールしたときに発火します。


下の例は、プレイヤーのマウスをすでに取得していて（変数名を 'mouse' として設定している場合）、`Tool`、`HopperBin` または `Class.Player:GetMouse()` メソッドを使用したことを前提としています。プレイヤーが前方にスクロールすると、"Wheel went forward!"と表示されます。

WheelForward イベントは、マウスホイールが前方にスクロールしたときに発火します。このイベントの可能な使用法には、FPSにおける武器のスコープの切り替えやプレイヤーのカメラのズームが含まれます。

これはスクロール後方のイベント `Class.Mouse.WheelBackward` とともに使用できます。

`Class.Mouse` オブジェクトの取得方法については、`Class.Mouse` ページを参照してください。

開発者は、新しい作業では `Class.Mouse` オブジェクトの代わりに `Class.UserInputService` を使用することをお勧めします。


Mouse.WheelForward

マウスホイールが前方にスクロールしたときに発火します。


Mouse

このサンプルのコードは、`StarterPlayerScripts`内の`LocalScript`に置くと、キャラクターの頭と`Class.Mouse.Hit`の間に常に赤いレーザービームを描画します。

このビームは、`Mouse`のレイキャスティングが頭ではなく、`Class.Workspace.CurrentCamera`から行われるため、三人称視点で障害物を直接通過します。

以下のコードは、`Class.Mouse.Hit`と`Class.Mouse.Origin`の違いを視覚化します。
これを実現するために、コードはヒットとオリジンの`Datatype.CFrame`値の
`Datatype.Vector3`の位置を使用し、`.p`を使います。

違いは、オリジンが「マウスの出所」（そのオリジン）であり、
ヒットはマウスが当たる位置（プレイヤーがマウスを押す時の位置）です。

この例は、マウスのオリジンが`CurrentCamera`の位置と非常に似ていることを
その2つの位置の間の大きさ（距離）を印刷することで視覚化します。

このプロパティは、3D空間におけるマウスの位置の `Datatype.CFrame` を示します。`Class.Mouse.TargetFilter` およびその子孫は無視されます。

開発者は、以下のように Hit の位置を取得できます:

```
local position = mouse.Hit.Position
```
Hit は、第三者視点で武器をマウスに向けて発射するために `Class.Tool|Tools` によく使用されます。

マウスが指し示している `Class.BasePart` を探している開発者は、`Class.Mouse.Target` を使用するべきです。

#### Mouse.Hit はどのように計算されますか？

Hit CFrame の位置は、マウスの内部 `Datatype.Ray`（`Class.Mouse.UnitRay` の拡張バージョン）と 3D空間内のオブジェクト（あるいはパーツ）の交差点として計算されます。

Hit CFrame の方向は `Class.Mouse.UnitRay` の方向に対応します。

```
local unitRayDirection = mouse.UnitRay.Direction
local mouseHitDirection = mouse.Hit.lookVector
-- unitRayDirection ≈ mouseHitDirection
-- ベクトルはおおよそ等しい
```
Hit `Datatype.CFrame` の方向を計算する際、`Class.Workspace.CurrentCamera` のロールは使用されません。

マウスの内部レイは 1,000 スタッズの長さがあります。マウスが 3D空間内のオブジェクトを指し示していない場合（例えば空を指し示しているとき）、このプロパティは `Class.Workspace.CurrentCamera` から 1,000 スタッズの距離にあります。

Mouse.Hit

3D空間におけるマウスの位置の `Datatype.CFrame`。

Mouse.hit

この例では、`Class.Players.LocalPlayer`のマウスアイコンをドラゴンの画像のように変更します。


**アイコン** は、ポインターとして使用される画像を決定するプロパティです。空白の場合は、デフォルトの矢印が使用されます。カーソルが `Class.GuiButton` の上にある間、このプロパティは一時的に無視されます。

カーソルを完全に非表示にするには、**透明な画像を使用しないでください**。代わりに、`Class.UserInputService.MouseIconEnabled` を false に設定してください。

体験でユーザーのマウスアイコンを取得/設定するには、`Class.UserInputService.MouseIcon` を使用する必要があります。`Class.Mouse.Icon` は、マウスカーソルを設定するためのプラグイン用の新しいAPIがリリースされた後に廃止されます。

##### カーソルのデザイン

独自のマウスカーソルを作成する際に役立つガイドラインは以下の通りです。

- 使用する画像の寸法はカーソルのサイズを決定します。
- 画像の寸法は、どの軸でも256ピクセルを超えてはいけません。
- 画像の**中心**がマウス入力が発行される場所です。
- デフォルトのマウス画像は64x64ピクセルで、マウスは17x24ピクセルのスペースを占めます。

##### システムカーソル

`Class.PluginMouse` を `Class.Plugin:GetMouse()` から取得した場合、手や矢印、Iビームなど、システムのデフォルトカーソルに似た以下のアイコンを使用できます。これらは、`Class.GuiObject.MouseEnter|MouseEnter`、`Class.GuiObject.MouseLeave|MouseLeave`、`Class.GuiButton.MouseButton1Down|MouseButton1Down` のようなGUIイベントで使用して、特定の種類のGUIコンポーネントとの相互作用時に一貫したスタジオ体験を提供します。これらはスタジオプラグイン専用であり、他の `Class.Mouse` オブジェクトでは機能しません。

<table>
    <thead>
        <tr>
            <th>外観*</th>
            <th>アセット</th>
            <th>推奨使用法</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Pointer.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Arrow</code></td>
            <td>デフォルトのクリックおよび選択。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-PointingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/PointingHand</code></td>
            <td>アクティブリンク/ボタンの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-OpenHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/OpenHand</code></td>
            <td>ドラッグ可能なアイテムの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-GrabbingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/ClosedHand</code></td>
            <td>アイテムをドラッグ中。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-IBeam.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/IBeam</code></td>
            <td>テキストフィールドの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNS.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNS</code></td>
            <td>垂直のリサイズハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeEW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeEW</code></td>
            <td>水平方向のリサイズハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNESW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNESW</code></td>
            <td>角のリサイズハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNWSE.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNWSE</code></td>
            <td>角のリサイズハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeAll.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeAll</code></td>
            <td>多方向のリサイズハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitV.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitNS</code></td>
            <td>垂直の「スプリット」ハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitH.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitEW</code></td>
            <td>水平方向の「スプリット」ハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Forbidden.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Forbidden</code></td>
            <td>ロックまたは禁止されたアイテムの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Wait.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Wait</code></td>
            <td>アクションが進行中であることを示す。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Busy.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Busy</code></td>
            <td>システムがビジーであることを示す。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Crosshair.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Cross</code></td>
            <td>ピンポイント選択エリアの上にホバーしている場合。</td>
        </tr>
    </tbody>
</table>

<figcaption>* これらの外観は概算です — 実際の見た目はオペレーティングシステムに依存します。</figcaption>


Mouse.Icon

`Class.Mouse` アイコンとして使用される画像のコンテンツID。


**アイコン** は、ポインターとして使用される画像を決定するプロパティです。空白の場合は、デフォルトの矢印が使用されます。カーソルが `Class.GuiButton` の上にある間、このプロパティは一時的に無視されます。このプロパティはアセットURIのみサポートします。

カーソルを完全に非表示にするには、**透明な画像を使用しないでください**。代わりに、`Class.UserInputService.MouseIconEnabled` を false に設定してください。

体験でユーザーのマウスアイコンを取得/設定するには、`Class.UserInputService.MouseIcon` を使用する必要があります。`Class.Mouse.Icon` は、マウスカーソルを設定するためのプラグイン用の新しいAPIがリリースされた後に廃止されます。

##### カーソルのデザイン

独自のマウスカーソルを作成する際に役立つガイドラインは以下の通りです。

- 使用する画像の寸法はカーソルのサイズを決定します。
- 画像の寸法は、どの軸でも256ピクセルを超えてはいけません。
- 画像の**中心**がマウス入力が発行される場所です。
- デフォルトのマウス画像は64x64ピクセルで、マウスは17x24ピクセルのスペースを占めます。

##### システムカーソル

`Class.PluginMouse` を `Class.Plugin:GetMouse()` から取得した場合、手や矢印、Iビームなど、システムのデフォルトカーソルに似た以下のアイコンを使用できます。これらは、`Class.GuiObject.MouseEnter|MouseEnter`、`Class.GuiObject.MouseLeave|MouseLeave`、`Class.GuiButton.MouseButton1Down|MouseButton1Down` のようなGUIイベントで使用して、特定の種類のGUIコンポーネントとの相互作用時に一貫したスタジオ体験を提供します。これらはスタジオプラグイン専用であり、他の `Class.Mouse` オブジェクトでは機能しません。

<table>
    <thead>
        <tr>
            <th>外観*</th>
            <th>アセット</th>
            <th>推奨使用法</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Pointer.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Arrow</code></td>
            <td>デフォルトのクリックおよび選択。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-PointingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/PointingHand</code></td>
            <td>アクティブリンク/ボタンの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-OpenHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/OpenHand</code></td>
            <td>ドラッグ可能なアイテムの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-GrabbingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/ClosedHand</code></td>
            <td>アイテムをドラッグ中。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-IBeam.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/IBeam</code></td>
            <td>テキストフィールドの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNS.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNS</code></td>
            <td>垂直のリサイズハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeEW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeEW</code></td>
            <td>水平方向のリサイズハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNESW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNESW</code></td>
            <td>角のリサイズハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNWSE.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNWSE</code></td>
            <td>角のリサイズハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeAll.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeAll</code></td>
            <td>多方向のリサイズハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitV.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitNS</code></td>
            <td>垂直の「スプリット」ハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitH.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitEW</code></td>
            <td>水平方向の「スプリット」ハンドルの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Forbidden.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Forbidden</code></td>
            <td>ロックまたは禁止されたアイテムの上にホバーしている場合。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Wait.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Wait</code></td>
            <td>アクションが進行中であることを示す。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Busy.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Busy</code></td>
            <td>システムがビジーであることを示す。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Crosshair.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Cross</code></td>
            <td>ピンポイント選択エリアの上にホバーしている場合。</td>
        </tr>
    </tbody>
</table>

<figcaption>* これらの外観は概算です — 実際の見た目はオペレーティングシステムに依存します。</figcaption>


Mouse.IconContent

`Class.Mouse` アイコンとして使用される画像のコンテンツです。アセットURIのみサポートします。


オリジン `Class.Mouse` プロパティは、マウスがどこから始まったかを示す `Datatype.CFrame` です。`Class.Workspace.CurrentCamera` に位置し、マウスの3D位置を向いています。

`Class.Mouse.UnitRay` はオリジンと同じ位置から始まり、同じ方向にスタッド分だけ延長します。

```lua
local unitRay = mouse.UnitRay
local origin = mouse.Origin
-- unitRay.Direction = origin.p
-- unitRay.Direction ≈ origin.lookVector
```
3D空間における `Class.Mouse` の位置については、`Class.Mouse.Hit` を参照してください。


Mouse.Origin

`Class.Workspace.CurrentCamera` に配置され、マウスの3D位置を向いた `Datatype.CFrame`。


 `StarterPlayerScripts`の`LocalScript`に配置されると、次のコードは
プレイヤーがクリックしたすべての`BasePart`の`Class.BasePart.BrickColor`を変更します。
スポーン位置やベースプレートなどが含まれます。


`Class.Mouse|mouse` が指している3D空間のオブジェクト。

注意：

- `Class.Mouse.TargetFilter` が設定されている場合、ターゲットフィルターとその子孫は無視されます。
- マウスが `Class.BasePart` を指していない場合、例えば空を指している場合、ターゲットは `nil` になります。
- 3D空間におけるマウスの位置を探している開発者は、`Class.Mouse.Hit` を使用する必要があります。


Mouse.Target

`Class.Mouse|mouse` が指している3D空間のオブジェクト。


Mouse.target

このプロパティは、`Class.Mouse.Hit` と `Class.Mouse.Target` を計算する際にマウスによって無視されるオブジェクトを決定します。そのオブジェクトの子孫も無視されるため、このプロパティが設定されたオブジェクトの子孫であれば、複数のオブジェクトを無視することが可能です。このプロパティは、`Class.Mouse.Hit` や `Class.Mouse.Target` に影響を与えてはならない特殊効果や装飾を含むモデルをフィルタリングする際に便利です。

このプロパティは任意の `Class.Instance` や `nil` に設定できます。例えば：

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

local player = Players.LocalPlayer
local mouse = player:GetMouse()
mouse.TargetFilter = Workspace.Model
```

`Class.Players.LocalPlayer` の `Class.Player.Character|Character` は、マウスによって自動的に無視されることに注意してください。


Mouse.TargetFilter

`Class.Mouse.Hit` と `Class.Mouse.Target` を決定する際に無視されるオブジェクト（およびその子孫）を決定します。


このサンプルのコードは、`StarterPlayerScripts` 内の `LocalScript` に配置されると、クリックされた任意の `BasePart` の表面をランダムな表面に設定します。

このプロパティは、マウスが指している `Class.BasePart` の表面の `Enum.NormalId` を示します。このプロパティは、マウスのワールド位置 (`Class.Mouse.Hit`) とマウスが指しているパート (`Class.Mouse.Target`) に由来しています。

このプロパティは、マウスがパートを指していない場合、例えば空を指している場合には意味がありません。この場合、このプロパティは「右」に設定されます。このプロパティを使用する前に、マウスのターゲットが `nil` ではないことを確認してください。

```lua
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
-- マウスが指しているパートが存在するか確認
if mouse.Target then
	print("マウスは " .. mouse.TargetSurface.Name .. " 側の " .. mouse.Target.Name .. " を指しています。")
else
	print("マウスは何も指していません。")
end
```


Mouse.TargetSurface

マウスが指している `Class.BasePart` の表面の `Enum.NormalId` を示します。


UnitRay プロパティは、マウスの3D空間における位置（`Class.Mouse.Hit` によって記述される）に向かう `Datatype.Ray` です。`Class.Workspace.CurrentCamera` の `Class.Camera.CFrame|CFrame` から発生します。すべてのユニットレイと同様に、距離は1です。

```lua
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
print(mouse.UnitRay.Direction.Magnitude) -- 常に1
```


Mouse.UnitRay

マウスのワールド位置に向かっている `Datatype.Ray` で、`Class.Workspace.CurrentCamera` のワールド位置から発生します。


このコードサンプルは、`Datatype.Vector2` を作成する方法を示しています。
これは `Mouse` オブジェクトの画面上の位置（`Class.Mouse.X|X()` および
`Class.Mouse.Y|Y()`）と、画面自体のサイズを表します
（`Class.Mouse.ViewSizeX|ViewSizeX()` および `Class.Mouse.ViewSizeY|ViewSizeY()`）。
これらを使用して、上部バーのすぐ下にある左上が (0, 0) にマッピングされ、
右下が (1, 1) にマッピングされるように画面上のマウスの位置を正規化できます。
この正規化された位置は、マウスが移動する際に計算され、印刷されます
`Class.Mouse.Move|Move()` イベントを使用して。

ViewSizeX プロパティは、ゲームウィンドウのサイズの水平方向の成分をピクセル単位で示します。


Mouse.ViewSizeX

ゲームウィンドウの幅をピクセル単位で示します。


ViewSizeY プロパティは、ゲームウィンドウのサイズの垂直方向の成分をピクセル単位で示します。この長さには、トップバーによって使用されるスペースが含まれます。


Mouse.ViewSizeY

ゲームウィンドウの高さをピクセル単位で示します。


マウスの画面上の位置の変化を検出する場合、`Class.ContextActionService:BindAction()` と `Enum.UserInputType.MouseMovement` または `Class.UserInputService.InputChanged` を使用することをお勧めします。これにより、`Class.InputObject.Position|Position`（`Datatype.Vector3`）を使用してマウスの位置を記述します。これをお勧めする理由は、このプロパティや関連プロパティを使用する代わりに、より正確にマウスの動きを検出できるためです。

X プロパティは、画面におけるマウスの位置の水平方向の成分を示します。位置は、トップバーの下の左上隅に対するピクセル単位で測定されます。このプロパティは、`Class.Mouse.Y` と組み合わせて使用することで、マウスの位置を表す `Datatype.Vector2` を生成できます。

```lua
local position = Vector2.new(mouse.X, mouse.Y)
```
このプロパティは `Class.Object.Changed|Changed` や `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal` からの信号を発火しません。代わりに `Class.Mouse.Move` イベントを使用してください。


Mouse.X

画面におけるマウスの位置のX（横）成分を示します。


マウスの画面上の位置の変化を検出する場合、`Class.ContextActionService:BindAction()` と `Enum.UserInputType.MouseMovement` または `Class.UserInputService.InputChanged` を使用することをお勧めします。これにより、`Class.InputObject.Position|Position`（`Datatype.Vector3`）を使用してマウスの位置を記述します。これをお勧めする理由は、このプロパティや関連プロパティを使用する代わりに、より正確にマウスの動きを検出できるためです。

Y プロパティは、画面におけるマウスの位置の垂直方向の成分を示します。位置は、トップバーの下の左上隅に対するピクセル単位で測定されます。このプロパティは、`Class.Mouse.X` と組み合わせて使用することで、マウスの位置を表す `Datatype.Vector2` を生成できます。

```lua
local position = Vector2.new(mouse.X, mouse.Y)
```
このプロパティは `Class.Object.Changed|Changed` や `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal` からの信号を発火しません。代わりに `Class.Mouse.Move` イベントを使用してください。


Mouse.Y

マウスの画面上のY（縦）成分を示します。


ポインター入力に役立つメンバーを含むレガシーオブジェクト。

`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/PluginMouse.yaml