このコードサンプルは、ローカルプレイヤーの
`PlayerMouse`を`Class.Player:GetMouse()`関数を使用して取得する方法の簡単な例を含んでいます。
このコードは、`StarterPlayerScripts`内の`LocalScript`に配置する必要があります。


PlayerMouseは、`Class.Tool.Equipped`を使用して取得される`Class.Mouse`オブジェクトと同様に動作します。ローカルプレイヤーの`Class.Player:GetMouse()`メソッドを使用して、`Class.LocalScript|LocalScripts`からアクセスできます。PlayerMouseと`Class.Mouse`の両方は、`Class.UserInputService`に取って代わられたレガシーAPIです。

PlayerMouseと`Class.Mouse`オブジェクトの唯一の違いは、PlayerMouseは`Class.Player:GetMouse()`メソッドを使用して取得できることです。

ほとんどの場合、開発者には新しい`Class.UserInputService`の使用が推奨されます。しかし、PlayerMouseとMouseオブジェクトは、いくつかの理由からサポートが継続されています。あなたの体験の入力をカスタマイズする詳細については、[Input and Camera](/input)を参照してください。

PlayerMouse

PlayerMouseは、`Class.Tool.Equipped`を使用して取得される`Class.Mouse`オブジェクトと同様に動作します。PlayerMouseと`Class.Mouse`の両方は、`Class.UserInputService`に取って代わられたレガシーAPIです。

**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()` メソッドを使用して行うことができます。プレイヤーが前方にスクロールすると "ホイールが前に進みました！" と表示されます。


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.Mouse.TargetSurface`を示します。


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

マウスがパートを指していない場合、たとえばマウスが空を指しているときには、このプロパティは意味を持ちません。このような状況では、このプロパティは 'Right' に設定されます。このプロパティを使用する前に、マウスのターゲットが `nil` でないことを確認してください。


Mouse.TargetSurface

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

UnitRay プロパティは、マウスの位置を指す `Datatype.Ray` です（`Class.Mouse.Hit` で説明されます）。これは、`Class.Workspace.CurrentCamera` の `Class.Camera.CFrame|CFrame` から発生します。すべての単位レイと同様に、距離は 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` は、`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

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


/reference/engine/classes/PlayerMouse.yaml

概要