ตัวอย่างโค้ดนี้รวมตัวอย่างง่าย ๆ ของวิธีการเรียกดู `PlayerMouse` ของผู้เล่นท้องถิ่น โดยใช้ฟังก์ชัน `Class.Player:GetMouse()` ใน `LocalScript` โค้ดนี้ควรจะถูกวางใน `LocalScript` ใน `StarterPlayerScripts`.

PlayerMouse ทำงานเหมือนกับวัตถุ `Class.Mouse` ที่ได้รับจากการใช้ `Class.Tool.Equipped` สามารถเข้าถึงได้จาก `Class.LocalScript|LocalScripts` โดยใช้วิธี `Class.Player:GetMouse()` ของผู้เล่นท้องถิ่น ทั้ง PlayerMouse และ `Class.Mouse` เป็น APIs เก่าที่ถูกแทนที่ด้วย `Class.UserInputService`。

ความแตกต่างเพียงอย่างเดียวระหว่าง PlayerMouse และวัตถุ `Class.Mouse` คือ PlayerMouse สามารถได้รับจากการใช้วิธี `Class.Player:GetMouse()` ได้。

ในเกือบทุกกรณีนักพัฒนาถูกแนะนำให้ใช้ `Class.UserInputService` ใหม่ แต่ PlayerMouse และวัตถุ Mouse ยังคงได้รับการสนับสนุนจากเหตุผลหลายประการ ดู [Input and Camera](/input) เพื่อข้อมูลเพิ่มเติมเกี่ยวกับการปรับแต่งการป้อนข้อมูลในประสบการณ์ของคุณ。


PlayerMouse

PlayerMouse ทำงานเหมือนกับวัตถุ `Class.Mouse` ที่ได้รับจากการใช้ `Class.Tool.Equipped` โดย PlayerMouse และ `Class.Mouse` เป็น APIs เก่าที่ถูกแทนที่ด้วย `Class.UserInputService`。


**Mouse** ได้ถูกแทนที่โดย `Class.UserInputService` และ
`Class.ContextActionService` ซึ่งครอบคลุมขอบเขตที่กว้างกว่า มีคุณสมบัติมากมาย
และสนับสนุนรูปแบบ **ข้ามแพลตฟอร์ม** ได้ดีกว่า มันยังคงถูกสนับสนุน
เนื่องจากการใช้งานอย่างแพร่หลาย แต่ควรพิจารณาใช้ตัวเลือกเหล่านี้อย่างจริงจัง

วัตถุ **Mouse** มี API ต่างๆ สำหรับพ้อยเตอร์ โดยหลักแล้วสำหรับปุ่ม
และการเรย์แคส มันสามารถเข้าถึงได้ผ่าน `Class.Player:GetMouse()` ที่เรียกบน
`Class.Players.LocalPlayer` ใน `Class.LocalScript` นอกจากนี้ยังถูกส่งผ่าน
เหตุการณ์ `Class.Tool.Equipped`

- มันเป็นที่รู้จักดีที่สุดสำหรับคุณสมบัติ `Class.Mouse.Icon|Icon` ซึ่งเปลี่ยน
  รูปลักษณ์ของเคอร์เซอร์
- มันจะเรย์แคสตำแหน่งเมาส์บนหน้าจอลงในโลก 3D อย่างต่อเนื่องโดยใช้
  คุณสมบัติ `Class.Mouse.TargetFilter|TargetFilter` โดยเก็บผลลัพธ์ของ
  การเรย์แคสไว้ในคุณสมบัติ `Class.Mouse.Hit|Hit`, `Class.Mouse.Target|Target` และ
  `Class.Mouse.TargetSurface|TargetSurface` อย่างไรก็ตามควรใช้
  `Class.WorldRoot:Raycast()` ในสถานการณ์ [เรย์แคส](/workspace/raycasting) ที่ซับซ้อนกว่า
- `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

เกิดขึ้นเมื่อปุ่มเมาส์ซ้ายถูกกดลง。

เกิดขึ้นเมื่อผู้เล่นปล่อยปุ่มเมาส์ซ้าย โปรดทราบว่า
สามารถเข้าถึงได้จาก `Class.Tool`; ตัวอย่างเช่น เมื่อนำไปวางใน
`Class.LocalScript` โค้ดด้านล่างจะแสดง `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

เกิดขึ้นเมื่อปุ่มเมาส์ซ้ายถูกปล่อยขึ้น。

เกิดขึ้นเมื่อผู้เล่นกดปุ่มเมาส์ขวา โปรดทราบว่า
สามารถเข้าถึงได้จาก `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

เกิดขึ้นเมื่อปุ่มเมาส์ขวาถูกปล่อยขึ้น。

ตัวอย่างนี้จะแสดงวิธีการที่เหตุการณ์เมาส์ถูกส่งในแต่ละเฟรม

เกิดขึ้นในทุกๆชีพจรที่เมาส์ไม่ได้ถูกส่งไปยังเหตุการณ์
เมาส์อื่น。

โปรดทราบว่าเหตุการณ์นี้ไม่ควรใช้ในการกำหนดว่าเมาส์หยุดนิ่ง
เพราะมันเกิดขึ้นทุกชีพจร มันจะเกิดขึ้นระหว่างเหตุการณ์
`Class.Mouse.Move`

สำหรับข้อมูลเกี่ยวกับวิธีการรับวัตถุ `Class.Mouse` กรุณาดูที่
หน้า `Class.Mouse`。

นักพัฒนาสามารถค้นหาตำแหน่งของเมาส์ในพื้นที่โลก และถ้า
มันชี้ไปที่ `Class.BasePart` ใด ๆ โดยใช้คุณสมบัติ `Class.Mouse.Hit` และ
`Class.Mouse.Target`。

โปรดทราบว่านักพัฒนาถูกแนะนำให้ใช้ `Class.UserInputService` แทน
วัตถุ `Class.Mouse` ในงานใหม่。

Mouse.Idle

เกิดขึ้นในทุกๆชีพจรที่เมาส์ไม่ได้ถูกส่งไปยังเหตุการณ์
เมาส์อื่น。

ตัวอย่างด้านล่าง หาก 'mouse' ถูกกำหนดไว้ จะพิมพ์ปุ่มที่ถูกกด
(เช่น "q") พร้อมกับค่าตัวอักษรสำหรับปุ่มนั้น (เช่น 113).

เหตุการณ์นี้เกิดขึ้นเมื่อกดปุ่มใดปุ่มหนึ่ง โดยมีอาร์กิวเมนต์ที่ส่งผ่านซึ่งเป็น
ปุ่มที่ถูกกดลง。

หมายเหตุ:

- ไม่ทุกรหัสกดปุ่มสร้างเหตุการณ์นี้ อย่างไรก็ตามคุณสามารถหลีกเลี่ยงสิ่งนี้ด้วย
ปุ่มบางปุ่ม เช่น "/" โดยการใช้เหตุการณ์ `Class.Mouse.KeyUp`
- บางปุ่มสร้างสตริงเดียวกันกับปุ่มอื่นๆ
- เป็นไปได้ที่สตริงอาจว่างเปล่า (อาจมีสาเหตุมาจากรหัสปุ่ม "\\0").

Mouse.KeyDown

เกิดขึ้นเมื่อกดปุ่มใดปุ่มหนึ่ง。

Mouse.keyDown

ตัวอย่างด้านล่าง สมมติว่า 'mouse' ถูกกำหนด จะพิมพ์คีย์ที่
ถูกปล่อย (เช่น "q") พร้อมกับค่าซีดสำหรับคีย์นั้น (เช่น 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.UserInputService`
แทนวัตถุ `Class.Mouse` ในงานใหม่.


Mouse.Move

เกิดขึ้นเมื่อเมาส์ถูกเคลื่อนที่.


ตัวอย่างด้านล่างนี้ถือว่าคุณได้เข้าถึงเมาส์ของผู้เล่นแล้ว (และ
ตั้งค่าให้เป็นตัวแปรชื่อ 'mouse') ไม่ว่าจะโดยการใช้ `Class.Tool`,
`Class.HopperBin` หรือวิธี `Class.Player:GetMouse()` มันจะพิมพ์
"ล้อเลื่อนถอยหลัง!" เมื่อผู้เล่นเลื่อนถอยหลัง.

เหตุการณ์ WheelBackward เกิดขึ้นเมื่อวงล้อเมาส์เลื่อนไปข้างหลัง.
การใช้งานที่เป็นไปได้สำหรับเหตุการณ์นี้รวมถึงการเปิด/ปิดเลนส์ของปืนในเกม FPS หรือการซูมกล้องของผู้เล่น.

สามารถใช้คู่กับเหตุการณ์การเลื่อนข้างหน้า,
`Class.Mouse.WheelForward`.

สำหรับข้อมูลเกี่ยวกับการได้รับวัตถุ `Class.Mouse`
โปรดดูที่หน้า `Class.Mouse`.

หมายเหตุ นักพัฒนาขอแนะนำให้ใช้ `Class.UserInputService`
แทนวัตถุ `Class.Mouse` ในงานใหม่.


Mouse.WheelBackward

เกิดขึ้นเมื่อวงล้อเมาส์ถูกเลื่อนย้อนกลับ.


ตัวอย่างด้านล่างสมมติว่าคุณได้จับเมาส์ของผู้เล่นเรียบร้อยแล้ว (และ
ตั้งเป็นตัวแปรชื่อ 'mouse') ไม่ว่าจะโดยใช้ `Tool`, `HopperBin`
หรือวิธีการ `Class.Player:GetMouse()` จะพิมพ์ "ล้อนี้ไปข้างหน้า!"
เมื่อผู้เล่นเลื่อนมันไปข้างหน้า.

เหตุการณ์ WheelForward เกิดขึ้นเมื่อวงล้อเมาส์เลื่อนไปข้างหน้า.
การใช้งานที่เป็นไปได้สำหรับเหตุการณ์นี้รวมถึงการเปิด/ปิดเลนส์ของปืนในเกม FPS หรือการซูมกล้องของผู้เล่น.

สามารถใช้คู่กับเหตุการณ์การเลื่อนย้อนกลับ,
`Class.Mouse.WheelBackward`.

สำหรับข้อมูลเกี่ยวกับการได้รับวัตถุ `Class.Mouse`
โปรดดูที่หน้า `Class.Mouse`.

หมายเหตุ นักพัฒนาขอแนะนำให้ใช้ `Class.UserInputService`
แทนวัตถุ `Class.Mouse` ในงานใหม่.


Mouse.WheelForward

เกิดขึ้นเมื่อวงล้อเมาส์เลื่อนข้างหน้า.


Mouse

โค้ดในตัวอย่างนี้ เมื่อวางภายใน `LocalScript` ภายใน
`StarterPlayerScripts` จะวาดลเซอร์บีมสีแดงระหว่างหัวตัวละคร
และ `Class.Mouse.Hit` ตลอดเวลา。

หมายเหตุ ลเซอร์นี้จะทะลุผ่านอุปสรรคในมุมมองบุคคลที่สาม เนื่องจาก
การทำเรย์แคสของ `Mouse` จะทำจาก `Class.Workspace.CurrentCamera` ไม่ใช่จาก
หัว

โค้ดด้านล่างแสดงความแตกต่างระหว่าง `Class.Mouse.Hit` และ
`Class.Mouse.Origin` เพื่อทำแบบนี้ โค้ดใช้
ตำแหน่ง `Datatype.Vector3` ของจุดที่ชนและต้นกำเนิด `Datatype.CFrame`
โดยใช้ `.p`.

ความแตกต่างคือ ต้นกำเนิดคือ "จุดที่เมาส์เริ่มต้น" (ต้นกำเนิดของมัน)
และจุดที่ชนคือ ตำแหน่งที่เมาส์ชน (คือช่วงที่ผู้เล่นกดเมาส์).

ตัวอย่างนี้ยังแสดงว่าต้นกำเนิดของเมาส์มีความคล้ายคลึงกับ
ตำแหน่งของ `CurrentCamera` โดยการพิมพ์ขนาด (ระยะทาง) ระหว่าง
สองตำแหน่ง.

คุณสมบัตินี้ระบุ `Datatype.CFrame` ของตำแหน่งเมาส์ใน 3D
พื้นที่ โปรดทราบว่า `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
-- เวคเตอร์จะมีค่าใกล้เคียงกัน
```
หมายเหตุ, การหมุนของ `Class.Workspace.CurrentCamera` จะไม่ถูกใช้เมื่อ
คำนวณทิศทางของ Hit `Datatype.CFrame`.

รังสีภายในของเมาส์จะขยายออกไป 1,000 studs หากเมาส์ไม่ได้
ชี้ไปยังวัตถุในพื้นที่ 3D (เช่นเมื่อชี้ไปที่ท้องฟ้า)
คุณสมบัตินี้จะอยู่ห่างออกไป 1,000 studs จาก
`Class.Workspace.CurrentCamera`。

Mouse.Hit

`Datatype.CFrame` ของตำแหน่งของเมาส์ในพื้นที่ 3D。

Mouse.hit

ตัวอย่างนี้จะแก้ไขไอคอนเมาส์ของ `Class.Players.LocalPlayer` ให้ดูเหมือนกับภาพ
มังกร.


**ไอคอน** เป็นคุณสมบัติที่กำหนดภาพที่ใช้เป็นตัวชี้ หาก
เว้นว่างไว้ จะใช้ลูกศรเริ่มต้น ขณะที่เคอร์เซอร์อยู่เหนือ
`Class.GuiButton` คุณสมบัตินี้จะถูกละเว้นชั่วคราว

ในการซ่อนเคอร์เซอร์โดยสิ้นเชิง **อย่า** ใช้ภาพโปร่งใส &ndash;
instead, ตั้งค่า `Class.UserInputService.MouseIconEnabled` เป็น false.

ในการรับ/ตั้งค่าไอคอนเมาส์ของผู้ใช้ในประสบการณ์ คุณควรใช้
`Class.UserInputService.MouseIcon`. `Class.Mouse.Icon` จะถูกเลิกใช้
หลังจากที่มีการเปิดตัว API ใหม่สำหรับปลั๊กอินในการตั้งค่าเคอร์เซอร์เมาส์.

##### การออกแบบเคอร์เซอร์

แนวทางต่อไปนี้อาจมีประโยชน์เมื่อสร้างเคอร์เซอร์เมาส์ของคุณเอง:

- ขนาดของภาพที่ใช้จะกำหนดขนาดของเคอร์เซอร์
- ขนาดของภาพไม่ควรเกิน 256 พิกเซลในทุกด้าน
- **ศูนย์กลาง** ของภาพคือจุดที่มีการออกคำสั่งเมาส์
- ภาพเมาส์เริ่มต้นมีขนาด 64x64 พิกเซล โดยมีพื้นที่ที่ใช้เป็น 17x24
  พิกเซล.

##### เคอร์เซอร์ของระบบ

เมื่อใช้ `Class.PluginMouse` ที่ดึงมาจาก `Class.Plugin:GetMouse()`,
คุณสามารถใช้ไอคอนดังต่อไปนี้ซึ่งคล้ายกับเคอร์เซอร์เริ่มต้นของระบบคุณ,
เช่น มือ, ลูกศร, I-beams ฯลฯ คุณสามารถใช้สิ่งเหล่านี้กับเหตุการณ์ GUI
เช่น `Class.GuiObject.MouseEnter|MouseEnter`,
`Class.GuiObject.MouseLeave|MouseLeave`, และ
`Class.GuiButton.MouseButton1Down|MouseButton1Down` เพื่อให้ประสบการณ์ Studio
ที่สอดคล้องกันเมื่อมีปฏิสัมพันธ์กับส่วนประกอบ GUI บางประเภท โปรดทราบว่าสิ่งเหล่านี้จะทำงานได้เฉพาะสำหรับปลั๊กอินของ Studio เท่านั้น; จะไม่ทำงานสำหรับวัตถุ `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>เคลื่อนที่เหนือพื้นที่เลือกจุด.
        </tr>
    </tbody>
</table>

<figcaption>* การปรากฏเหล่านี้เป็นประมาณการ &mdash; ลักษณะจริงขึ้นอยู่กับระบบปฏิบัติการของคุณ.
</figcaption>

Mouse.Icon

รหัสเนื้อหาของภาพที่ใช้เป็นไอคอน `Class.Mouse`.


**ไอคอน** เป็นคุณสมบัติที่กำหนดภาพที่ใช้เป็นตัวชี้ หาก
เว้นว่าง จะใช้ลูกศรเริ่มต้น ขณะที่เคอร์เซอร์อยู่เหนือ
`Class.GuiButton` คุณสมบัตินี้จะถูกละเว้นชั่วคราว คุณสมบัตินี้
รองรับเฉพาะ asset URIs.

ในการซ่อนเคอร์เซอร์โดยสิ้นเชิง **อย่า** ใช้ภาพโปร่งใส &ndash;
instead, ตั้งค่า `Class.UserInputService.MouseIconEnabled` เป็น false.

ในการรับ/ตั้งค่าไอคอนเมาส์ของผู้ใช้ในประสบการณ์ คุณควรใช้
`Class.UserInputService.MouseIcon`. `Class.Mouse.Icon` จะถูกเลิกใช้
หลังจากที่มีการเปิดตัว API ใหม่สำหรับปลั๊กอินในการตั้งค่าเคอร์เซอร์เมาส์.

##### การออกแบบเคอร์เซอร์

แนวทางต่อไปนี้อาจมีประโยชน์เมื่อสร้างเคอร์เซอร์เมาส์ของคุณเอง:

- ขนาดของภาพที่ใช้จะกำหนดขนาดของเคอร์เซอร์
- ขนาดของภาพไม่ควรเกิน 256 พิกเซลในทุกด้าน
- **ศูนย์กลาง** ของภาพคือจุดที่มีการออกคำสั่งเมาส์
- ภาพเมาส์เริ่มต้นมีขนาด 64x64 พิกเซล โดยมีพื้นที่ที่ใช้เป็น 17x24
  พิกเซล.

##### เคอร์เซอร์ของระบบ

เมื่อใช้ `Class.PluginMouse` ที่ดึงมาจาก `Class.Plugin:GetMouse()`,
คุณสามารถใช้ไอคอนดังต่อไปนี้ซึ่งคล้ายกับเคอร์เซอร์เริ่มต้นของระบบคุณ,
เช่น มือ, ลูกศร, I-beams ฯลฯ คุณสามารถใช้สิ่งเหล่านี้กับเหตุการณ์ GUI
เช่น `Class.GuiObject.MouseEnter|MouseEnter`,
`Class.GuiObject.MouseLeave|MouseLeave`, และ
`Class.GuiButton.MouseButton1Down|MouseButton1Down` เพื่อให้ประสบการณ์ Studio
ที่สอดคล้องกันเมื่อมีปฏิสัมพันธ์กับส่วนประกอบ GUI บางประเภท โปรดทราบว่าสิ่งเหล่านี้จะทำงานได้เฉพาะสำหรับปลั๊กอินของ Studio เท่านั้น; จะไม่ทำงานสำหรับวัตถุ `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>เคลื่อนที่เหนือพื้นที่เลือกจุด.
        </tr>
    </tbody>
</table>

<figcaption>* การปรากฏเหล่านี้เป็นประมาณการ &mdash; ลักษณะจริงขึ้นอยู่กับระบบปฏิบัติการของคุณ.
</figcaption>

Mouse.IconContent

เนื้อหาของภาพที่ใช้เป็นไอคอน `Class.Mouse`. รองรับเฉพาะ
asset URIs.


คุณสมบัติ `Class.Mouse` ต้นฉบับเป็น `Datatype.CFrame` ที่บ่งบอกว่าเมาส์
มาจากที่ใด มันจะตั้งอยู่ที่ `Class.Workspace.CurrentCamera` และหันไปทาง
ตำแหน่ง 3D ของเมาส์.

`Class.Mouse.UnitRay` เริ่มจากตำแหน่งเดียวกับต้นฉบับ และยืดออกไป
สำหรับ stud ในทิศทางเดียวกัน.

```lua
local unitRay = mouse.UnitRay
local origin = mouse.Origin
-- unitRay.Direction = origin.p
-- unitRay.Direction ≈ origin.lookVector
```
สำหรับตำแหน่งของ `Class.Mouse` ในพื้นที่ 3D โปรดดูที่ `Class.Mouse.Hit`.


Mouse.Origin

ประเภท `Datatype.CFrame` ที่ตั้งอยู่ที่ `Class.Workspace.CurrentCamera` และ
หันไปทางตำแหน่ง 3D ของเมาส์.


เมื่อวางใน `LocalScript` ใน `StarterPlayerScripts` รหัสต่อไปนี้
จะเปลี่ยน `Class.BasePart.BrickColor` ของทุก `BasePart` ที่ผู้เล่นคลิก
เช่น ตำแหน่งการเกิดหรือพื้นฐาน.


วัตถุในพื้นที่ 3D ที่ `Class.Mouse|mouse` ชี้ไป.

หมายเหตุ:

- หาก `Class.Mouse.TargetFilter` ถูกตั้งค่า เป้าหมายจะถูกกรองและลูกหลานของมัน
  จะถูกละเว้น.
- เมื่อเมาส์ไม่ชี้ไปที่ `Class.BasePart` เช่นเมื่อมันชี้ไปที่ท้องฟ้า เป้าหมายจะเป็น `nil`.
- นักพัฒนาที่กำลังมองหาตำแหน่งของเมาส์ในพื้นที่ 3D ควรใช้
  `Class.Mouse.Hit`.


Mouse.Target

วัตถุในพื้นที่ 3D ที่ `Class.Mouse|mouse` ชี้ไป.


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.Player.Character|Character` ของ
`Class.Players.LocalPlayer` จะถูกละเว้นโดยเมาส์โดยอัตโนมัติ.


Mouse.TargetFilter

กำหนดวัตถุ (และลูกหลานของมัน) ที่จะถูกละเว้นเมื่อทำการกำหนด
`Class.Mouse.Hit` และ `Class.Mouse.Target`.


โค้ดในตัวอย่างนี้ เมื่อวางไว้ใน `LocalScript` ภายใน
`StarterPlayerScripts` จะตั้งค่าพื้นผิวของ `BasePart` ที่ถูกคลิกไปยังพื้นผิวที่
สุ่ม

คุณสมบัตินี้บ่งชี้ `Enum.NormalId` ของพื้นผิว `Class.BasePart`
ที่เมาส์ชี้ไป.ยังไม่เป็นความหมายเมื่อเคอร์เซอร์ไม่ชี้ไปที่ส่วนใด ๆ,
เช่นเมื่อเคอร์เซอร์ชี้ไปที่ท้องฟ้า ในขณะนี้คุณสมบัตินี้ได้รับการตั้งเป็น 'ขวา' ในสถานการณ์เหล่านี้ ก่อนใช้งานคุณสมบัตินี้ ให้ตรวจสอบเป้าหมายของเมาส์ว่าไม่เป็น `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

บ่งชี้ `Enum.NormalId` ของพื้นผิว `Class.BasePart` ที่เมาส์
ชี้ไป.


คุณสมบัติ UnitRay เป็น `Datatype.Ray` ที่ชี้ไปยังตำแหน่งของเมาส์ในพื้นที่ 3D (อธิบายโดย `Class.Mouse.Hit`). จุดกำเนิดมาจาก
`Class.Camera.CFrame|CFrame` ของ `Class.Workspace.CurrentCamera`.
เช่นเดียวกับที่อยู่ในหน่วยทุกชนิด มีระยะทางเท่ากับ 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`) ของ `Class.InputObject` แทนการใช้คุณสมบัตินี้และ
คุณสมบัติที่เกี่ยวข้อง.

คุณสมบัติ 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`) ของ `Class.InputObject` แทนการใช้คุณสมบัตินี้และ
คุณสมบัติที่เกี่ยวข้อง.

คุณสมบัติ 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` event.

พารต์ ChangingPart จะถูกตั้งค่า Parent เป็นค่าที่แตกต่างกันในช่วงเวลา พ่อแม่ของ
พารต์ คือบรรพบุรุษของพารต์ ดังนั้น `Class.Instance.AncestryChanged` event
จะถูกเรียกใช้เมื่อมันเปลี่ยนแปลง.

เกิดขึ้นเมื่อมีการเปลี่ยนสถานะของอินสแตนซ์นี้ หรือลูกหลานของมัน.

คุณสามารถใช้เหตุการณ์นี้เพื่อติดตามการลบของอินสแตนซ์ใน Studio,
เช่นการลบด้วยตนเองใน 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` ที่ถูกเพิ่ม.

เกิดขึ้นหลังจากที่วัตถุถูกเพิ่มเข้าไปใน `Class.Instance` นี้.

Instance.childAdded

สคริปต์นี้จะแสดงชื่อของวัตถุเมื่อถูกลบออกจาก
Workspace:

เกิดขึ้นหลังจากที่ลูกหลานถูกลบออกจาก `Class.Instance` นี้.

'ได้ถูกลบ' หมายถึงเมื่อพ่อแม่ของวัตถุมีการเปลี่ยนจาก `Class.Instance` นี้เป็นสิ่งอื่นนอกจาก `Class.Instance` นี้ หมายเหตุ เหตุการณ์นี้จะเกิดขึ้นเมื่อมีการทำลายลูกหลานด้วย (การใช้
`Class.Instance:Destroy()`) เนื่องจากฟังก์ชันการทำลายจะตั้งค่าวัตถุให้มีพ่อแม่เป็น `nil`.

เหตุการณ์นี้ทำงานเฉพาะกับลูกหลานโดยตรงของ `Class.Instance` สำหรับเหตุการณ์ที่บันทึกลูกหลานทั้งหมด ให้ใช้ `Class.Instance.DescendantRemoving`.

ดูเพิ่มเติมที่ `Class.Instance.ChildAdded`.

Instance.ChildRemoved

อินสแตนซ์ `Class.Instance` ที่ถูกลบ.

เกิดขึ้นหลังจากที่ลูกหลานถูกลบออกจาก `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` ที่กำลังจะถูกลบ.

เกิดขึ้นโดยทันทีเมื่อมีการลบลูกหลานของ `Class.Instance`.

ตัวอย่างนี้แสดงให้เห็นว่า เมื่อใช้พฤติกรรมของสัญญาณทันที อินสแตนซ์ที่ถูกทำลายจะยังคงอยู่ในตำแหน่งจนกว่าฟังก์ชันที่เชื่อมโยงจะหยุด.

ตัวอย่างนี้แสดงให้เห็นว่าเมื่อใช้พฤติกรรมสัญญาณ 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` ใน Studio เช่นโดยการลบด้วยตนเองผ่าน
[Explorer](/studio/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.BasePart|BaseParts` ทั้งหมดที่
ลงมาจาก `Class.Model`:

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

แสดงให้เห็นถึงการทำลาย Part โดยใช้ฟังก์ชัน `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` ซึ่ง
`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.Instance` ที่พบ.

ส่งคืนบรรพบุรุษแรกของ `Class.Instance` ซึ่ง
`Class.Instance.Name` มีค่าเท่ากับชื่อที่กำหนด.

ส่งคืนบรรพบุรุษแรกของ `Class.Instance` ซึ่ง
`Class.Object.ClassName` มีค่าเท่ากับ className ที่กำหนด.

วิธีนี้ทำงานไปข้างบน, หมายถึงมันเริ่มที่
`Class.Instance.Parent` ที่ใกล้ที่สุดและทำงานขึ้นไปยัง
`Class.DataModel`. หากไม่พบบรรพบุรุษที่ตรงกัน, จะส่งคืน `nil`.

การใช้งานทั่วไปของวิธีนี้คือการค้นหา `Class.Model` ที่
`Class.BasePart` เป็นของ. เช่น:

```
local model = part:FindFirstAncestorOfClass("Model")
```
วิธีนี้เป็นรูปแบบหนึ่งของ `Class.Instance:FindFirstAncestor()`
ที่ตรวจสอบคุณสมบัติ `Class.Object.ClassName` แทนที่จะใช้
`Class.Instance.Name`. `Class.Instance:FindFirstAncestorWhichIsA()` ยังมี,
โดยใช้วิธี `Class.Object:IsA()` แทนเพื่อให้เคารพการสืบทอดคลาส.

Instance:FindFirstAncestorOfClass

className

ชื่อ `Class.Object.ClassName` ที่จะถูกค้นหา.

ส่งคืนบรรพบุรุษแรกของ `Class.Instance` ซึ่ง
`Class.Object.ClassName` มีค่าเท่ากับ className ที่กำหนด.

ส่งคืนบรรพบุรุษแรกของ `Class.Instance` ซึ่ง
`Class.Object:IsA()` ส่งคืน true สำหรับ className ที่กำหนด.

วิธีนี้ทำงานไปข้างบน, หมายถึงมันเริ่มที่
`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()` ส่งคืน true สำหรับ className ที่กำหนด.

ด้านล่างนี้จะค้นหาใน 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.Folder` ที่เรียกว่า `Color` ถูกเพิ่มไปยัง
`Class.Part`, ซึ่งยังมีคุณสมบัติ `Class.Part.Color`. โปรดสังเกตว่า
`part.Color` อ้างอิงไปยังค่าคุณสมบัติ `Datatype.Color3`, ไม่ใช่
to `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

recursive

ว่า การค้นหาควรดำเนินการแบบ recursive หรือไม่.

ส่งคืนลูกแรกของ `Class.Instance` ที่ถูกพบที่มีชื่อที่กำหนด.

Instance:findFirstChild

ส่งคืนลูกแรกของ `Class.Instance` ที่มี
`Class.Object.ClassName|ClassName` เท่ากับ `className` ที่กำหนด.
แตกต่างจาก `Class.Instance:FindFirstChildWhichIsA()`, วิธีนี้จะส่งคืน
วัตถุที่มีคลาสตรงตาม `className`, ไม่สนใจการสืบทอดคลาส. หากไม่พบลูก
ที่ตรงกัน, วิธีนี้จะส่งคืน `nil`.

Instance:FindFirstChildOfClass

ส่งคืนลูกแรกของ `Class.Instance` ที่มี
`Class.Object.ClassName|ClassName` เท่ากับชื่อคลาสที่กำหนด.

ส่งคืนลูกแรกของ `Class.Instance` ที่มี
`Class.Object:IsA()` ส่งคืน true สำหรับ className ที่กำหนด.

หากไม่พบลูกที่ตรงกัน, วิธีนี้จะส่งคืน `nil`. หากพารามิเตอร์
recursive เป็น 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()` ส่งคืน true สำหรับ className ที่กำหนด.

ส่งคืนทายาทแรกที่ถูกพบที่มี `Class.Instance.Name` ที่กำหนด.

วิธีนี้ถูกปิดใช้งานและไม่สามารถนำมาใช้ได้. เพื่อค้นหาทายาทแรก
ของอินสแตนซ์, ขอแนะนำให้ใช้พารามิเตอร์ `recursive` บน
`Class.Instance:FindFirstChild()` แทน.

Instance:FindFirstDescendant

ชื่อ `Class.Instance.Name` ที่ค้นหา.

ส่งคืนทายาทแรกที่ถูกพบที่มี `Class.Instance.Name` ที่กำหนด.

หาก `Class.Instance` เป็น `Class.Actor`, จะส่งคืน `Class.Actor` เอง. มิฉะนั้น, บรรพบุรุษที่ใกล้ที่สุดของมันจะถูกส่งคืน. หากไม่มี
บรรพบุรุษเป็น `Class.Actor`, ผลลัพธ์คือ `nil`.

Instance:GetActor

คลาส `Class.Actor` ที่พบ.

ส่งคืน `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:GetPropertyChangedSignal()|GetPropertyChangedSignal()` แต่
สำหรับคุณสมบัติ.

โดยทั่วไปแล้ว, มันเป็นความคิดที่ดีที่จะใช้วิธีนี้แทนการเชื่อมต่อ
กับ `Class.Object.Changed|Changed` ด้วยฟังก์ชันที่ตรวจสอบชื่อคุณสมบัติ.
การเรียกใช้ในครั้งถัดไปให้กับวิธีนี้บนวัตถุที่เหมือนกันด้วยชื่อคุณสมบัติที่เหมือนกันจะส่งคืนเหตุการณ์เดียวกัน.

ตัวอย่างโค้ดด้านล่างจะส่งคืนสัญญาณที่ส่ง
ฟังก์ชัน `attributeChanged()` เมื่อคุณสมบัติ `InitialPosition`
ของส่วนเปลี่ยนแปลง:

```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` เท่ากับวัตถุ. อาร์เรย์สามารถวนรอบได้ด้วยการใช้ลูปเชิงตัวเลขหรือทั่วไป:

```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` เป็นคลาสพื้นฐานสำหรับคลาสทั้งหมดในลำดับชั้นคลาส Roblox
ซึ่งสามารถเป็นส่วนหนึ่งของต้นไม้ `Class.DataModel`.

/reference/engine/classes/PlayerMouse.yaml