โค้ดด้านล่างแสดงให้เห็นว่าเราสามารถรับและใช้วัตถุ PluginMouse ได้อย่างไรในปลั๊กอิน เพื่อใช้โค้ดนี้ ให้วางลงใน `Script` และบันทึกสคริปต์นั้นไปยังโฟลเดอร์ปลั๊กอินในเครื่องโดยการคลิกขวาและบันทึกเป็นไฟล์ โฟลเดอร์ปลั๊กอินสามารถพบได้ในแท็บปลั๊กอินในแถบเครื่องมือ Roblox Studio


ออบเจ็กต์ PluginMouse ให้ `Class.Plugin|Plugins` เข้าถึงเมาส์ได้ มัน
ทำงานเหมือนกับออบเจ็กต์ `Class.Mouse` และสามารถได้มาโดยใช้
วิธี `Class.Plugin:GetMouse()` ของปลั๊กอิน

โปรดทราบว่า PluginMouse สามารถใช้ได้เฉพาะเมื่อปลั๊กอินถูกเปิดใช้งานด้วย
`Class.Plugin:Activate()` เท่านั้น

นอกเหนือจากฟังก์ชันจากออบเจ็กต์ `Class.Mouse` แล้ว PluginMouse
ยังรวมฟังก์ชัน `Class.PluginMouse.DragEnter` ซึ่งติดตามรายการ
ที่ถูกเลือกขณะเมาส์กำลังลาก

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

ถูกเรียกเมื่อมีการเลือก Instance ขณะที่เมาส์กำลังลาก

PluginMouse.DragEnter

instances

อาร์เรย์ของ `Class.Instance|Instances` ที่ถูกแทรกเข้าไปใน
3D viewport โดยการลากและวาง.

PluginMouse

ออบเจ็กต์ PluginMouse ให้ `Class.Plugin|Plugins` เข้าถึงเมาส์ได้ มัน
ทำงานเหมือนกับออบเจ็กต์ `Class.Mouse` และสามารถได้มาโดยใช้
วิธี `Class.Plugin:GetMouse()` ของปลั๊กอิน

**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") พร้อมกับค่า 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.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` ที่ถูกคลิกให้เป็น
พื้นผิวแบบสุ่ม。


แสดงให้เห็นถึง `Class.Mouse.TargetSurface`.


คุณสมบัตินี้ระบุ `Enum.NormalId` ของพื้นผิว `Class.BasePart` ที่เมาส์ชี้ไปที่ ซึ่งคุณสมบัตินี้ได้มาจากตำแหน่งในโลกของเมาส์ (`Class.Mouse.Hit`) และส่วนที่เมาส์ชี้ไป (`Class.Mouse.Target`).

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


Mouse.TargetSurface

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

แสดงให้เห็นถึง `Class.Mouse.UnitRay`。


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


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` นี้.


ตัวอย่างต่อไปนี้จะแสดงชื่อของวัตถุใดๆ ที่ถูกเพิ่มเข้าไปใน
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` จะถูกลบออก.


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

ตัวอย่างนี้แสดงให้เห็นว่าเมื่อใช้พฤติกรรมสัญญาณ 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()`.


แสดงให้เห็นถึง `Class.Instance.StyledPropertiesChanged`.


เหตุการณ์นี้เกิดขึ้นเมื่อใดก็ตามที่มีการเปลี่ยนแปลงคุณสมบัติสไตล์ใดๆ บนอินสแตนซ์ รวมถึงเมื่อมีการตั้งค่าคุณสมบัติเป็น `nil`.


Instance.StyledPropertiesChanged

เกิดขึ้นเมื่อใดก็ตามที่มีการเปลี่ยนแปลงคุณสมบัติสไตล์ใดๆ บนอินสแตนซ์ รวมถึงเมื่อมีการตั้งค่าคุณสมบัติเป็น `nil`.


วิธีนี้ใช้แท็กกับอินสแตนซ์ โดยไม่มีผลหากแท็กนั้นถูกใช้แล้ว การเพิ่มแท็ก
อย่างสำเร็จจะทำให้เกิดสัญญาณที่สร้างโดย
`Class.CollectionService:GetInstanceAddedSignal()` พร้อมแท็กที่กำหนด。

#### คำเตือน

- แท็กของอินสแตนซ์ที่ถูกเพิ่มจากด้านลูกค้าจะถูกลบหากเซิร์ฟเวอร์
  เพิ่มหรือลบแท็กบนอินสแตนซ์นั้นในภายหลัง เนื่องจากเซิร์ฟเวอร์
  ทำซ้ำแท็กทั้งหมดด้วยกันและเขียนทับแท็กก่อนหน้า。

- เมื่อแท็กอินสแตนซ์ มักจะมีทรัพยากรบางอย่างที่ถูกใช้เพื่อ
  ให้แท็กทำงานได้ เช่น การเชื่อมต่อเหตุการณ์หรือโต๊ะ
  เพื่อป้องกันการรั่วไหลของหน่วยความจำ เป็นความคิดที่ดีที่จะทำความสะอาดสิ่งเหล่านี้ (ตัดการเชื่อมต่อ,
  ตั้งค่าเป็น `nil` เป็นต้น) เมื่อไม่ต้องการอีกต่อไปสำหรับแท็ก ทำเช่นนี้เมื่อ
  เรียก `Class.Instance:RemoveTag()` หรือในฟังก์ชันที่เชื่อมต่อกับสัญญาณ
  ที่ส่งคืนโดย `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

สำเนาของอินสแตนซ์ หรือ `nil` หากอินสแตนซ์ไม่เป็น
`Class.Instance.Archivable|Archivable`。


สร้างสำเนาของอินสแตนซ์และลูกหลานทั้งหมด โดยไม่สนใจอินสแตนซ์
ที่ไม่เป็น `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` ไม่ใช่ลูก
`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

ไม่ว่าจะต้องทำการค้นหาแบบวนซ้ำหรือไม่。


ส่งคืนลูกแรกของ `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` เป็น `Class.Actor` จะส่งคืน `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

ส่งคืนเหตุการณ์ที่เกิดขึ้นเมื่อคุณสมบัติที่กำหนดมีการเปลี่ยนแปลง。


Instance

`Instance` เป็นคลาสพื้นฐานสำหรับคลาสทั้งหมดในลำดับชั้นคลาสของ Roblox
ซึ่งสามารถเป็นส่วนหนึ่งของต้นไม้ `Class.DataModel`。


/reference/engine/classes/PluginMouse.yaml