Contoh kode ini mencakup contoh sederhana tentang cara mengambil `PlayerMouse`
dari pemain lokal menggunakan fungsi `Class.Player:GetMouse()` dalam
`LocalScript`. Kode ini harus ditempatkan dalam `LocalScript` di
`StarterPlayerScripts`.

PlayerMouse berfungsi identik dengan objek `Class.Mouse` yang
didapat dengan menggunakan `Class.Tool.Equipped`. Ini dapat diakses dari
`Class.LocalScript|LocalScripts` menggunakan pemain lokal
`Class.Player:GetMouse()` method. Baik PlayerMouse maupun `Class.Mouse` adalah
API warisan, yang digantikan oleh `Class.UserInputService`.

Satu-satunya perbedaan antara PlayerMouse dan objek `Class.Mouse` adalah
PlayerMouse dapat diperoleh menggunakan metode `Class.Player:GetMouse()`.

Dalam kebanyakan kasus, pengembang disarankan untuk menggunakan `Class.UserInputService` yang baru.
Namun, objek PlayerMouse dan Mouse tetap didukung untuk sejumlah
alasan. Lihat [Input and Camera](/input) untuk informasi lebih lanjut
mengenai menyesuaikan input di pengalaman Anda.


PlayerMouse

PlayerMouse berfungsi identik dengan objek `Class.Mouse` yang
didapat dengan menggunakan `Class.Tool.Equipped`. Baik PlayerMouse maupun `Class.Mouse` adalah
API warisan, yang digantikan oleh `Class.UserInputService`.


**Mouse** telah digantikan oleh `Class.UserInputService` dan
`Class.ContextActionService`, yang mencakup jangkauan yang lebih luas, lebih kaya
fitur, dan mendukung pola **lintas platform** dengan lebih baik. Ini tetap didukung
karena penggunaannya yang luas, tetapi Anda harus sangat mempertimbangkan untuk menggunakan
alternatif ini.

Objek **Mouse** menyimpan berbagai API untuk pointer, terutama untuk tombol
dan raycasting. Ini dapat diakses melalui `Class.Player:GetMouse()` yang dipanggil di
`Class.Players.LocalPlayer` dalam `Class.LocalScript`. Ini juga diteruskan oleh
event `Class.Tool.Equipped`.

- Ini paling dikenal untuk properti `Class.Mouse.Icon|Icon`, yang mengubah
  penampilan kursor.
- Ini terus-menerus melakukan raycasting posisi mouse layar ke dalam dunia 3D dengan
  menggunakan properti `Class.Mouse.TargetFilter|TargetFilter`, menyimpan hasil dari
  raycast dalam properti `Class.Mouse.Hit|Hit`, `Class.Mouse.Target|Target`, dan
  `Class.Mouse.TargetSurface|TargetSurface`. Ini bisa berguna
  untuk kasus sederhana, tetapi `Class.WorldRoot:Raycast()` harus digunakan dalam
  skenario [raycasting](/workspace/raycasting) yang lebih kompleks.
- `Class.Plugin|Plugins` dapat menggunakan `Class.Plugin:GetMouse()` untuk mendapatkan
  `Class.PluginMouse`, yang berfungsi dengan cara yang sama.

```lua
-- Dari LocalScript:
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
-- Mengatur ikon mouse
mouse.Icon = "rbxasset://SystemCursors/Wait"
```
Catatan:

- Objek ini tidak mengontrol/membatasi gerakan pointer. Untuk ini, lihat
  `Class.UserInputService.MouseBehavior` dan
  `Class.UserInputService.MouseDeltaSensitivity`.
- Jika dua fungsi terhubung ke event input yang sama, seperti
  `Class.Mouse.Button1Down|Button1Down`, **kedua** fungsi akan berjalan ketika event
  terjadi. Tidak ada konsep menenggelamkan/meneruskan input, karena event tidak
  mendukung perilaku ini. Namun, `Class.ContextActionService` memiliki perilaku ini
  melalui `Class.ContextActionService:BindAction()|BindAction`.
- Meskipun mouse mungkin tidak tersedia di semua platform, Mouse akan tetap
  berfungsi di mobile (sentuh) dan konsol (gamepad), yang biasanya tidak memiliki
  mouse atau perangkat keras pointer. Untuk perilaku lintas platform yang eksplisit,
  gunakan `Class.UserInputService` dan `Class.ContextActionService`.

  Lihat [Input dan Kamera](/input) untuk informasi lebih lanjut tentang
  menyesuaikan input di pengalaman Anda.

Event ini dipicu ketika pemain menekan tombol mouse kiri mereka. Perhatikan
bahwa ini dapat diakses dari `Class.Tool`; misalnya, ketika ditempatkan di
`Class.LocalScript`, kode di bawah ini mencetak `Button1Down` setiap kali
 tombol mouse kiri ditekan.

```lua
local tool = script.Parent  -- Pastikan ini adalah objek Tool

tool.Equipped:Connect(function(mouse)
	mouse.Button1Down:Connect(function()
		print("Button1Down")
	end)
end)
```
Anda dapat mengetahui posisi mouse dalam ruang dunia dan apakah itu
menunjuk ke `Class.BasePart` menggunakan properti `Class.Mouse.Hit|Hit` dan
`Class.Mouse.Target|Target`.

Mouse.Button1Down

Event ini dipicu ketika pemain melepaskan tombol mouse kiri mereka. Perhatikan
bahwa ini dapat diakses dari `Class.Tool`; misalnya, ketika ditempatkan di
`Class.LocalScript`, kode di bawah ini mencetak `Button1Up` setiap kali tombol
mouse kiri dilepas.

```lua
local tool = script.Parent  -- Pastikan ini adalah objek Tool

tool.Equipped:Connect(function(mouse)
	mouse.Button1Up:Connect(function()
		print("Button1Up")
	end)
end)
```
Anda dapat mengetahui posisi mouse dalam ruang dunia dan apakah itu
menunjuk ke `Class.BasePart` menggunakan properti `Class.Mouse.Hit|Hit` dan
`Class.Mouse.Target|Target`.

Mouse.Button1Up

Event ini dipicu ketika pemain menekan tombol mouse kanan mereka. Perhatikan
bahwa ini dapat diakses dari `Class.Tool`; misalnya, ketika ditempatkan di
`Class.LocalScript`, kode di bawah ini mencetak `Button2Down` setiap kali tombol
mouse kanan ditekan.

```lua
local tool = script.Parent  -- Pastikan ini adalah objek Tool

tool.Equipped:Connect(function(mouse)
	mouse.Button2Down:Connect(function()
		print("Button2Down")
	end)
end)
```
Anda dapat mengetahui posisi mouse dalam ruang dunia dan apakah itu
menunjuk ke `Class.BasePart` menggunakan properti `Class.Mouse.Hit|Hit` dan
`Class.Mouse.Target|Target`.

Mouse.Button2Down

Dipicu ketika tombol mouse kanan ditekan.

Event ini dipicu ketika pemain melepaskan tombol mouse kanan mereka. Perhatikan
bahwa ini dapat diakses dari `Class.Tool`; misalnya, ketika ditempatkan di
`Class.LocalScript`, kode di bawah ini mencetak `Button2Up` setiap kali tombol
mouse kanan dilepas.

```lua
local tool = script.Parent  -- Pastikan ini adalah objek Tool

tool.Equipped:Connect(function(mouse)
	mouse.Button2Up:Connect(function()
		print("Button2Up")
	end)
end)
```
Anda dapat mengetahui posisi mouse dalam ruang dunia dan apakah itu
menunjuk ke `Class.BasePart` menggunakan properti `Class.Mouse.Hit|Hit` dan
`Class.Mouse.Target|Target`.

Mouse.Button2Up

Dipicu ketika tombol mouse kanan dilepas.

Contoh ini menunjukkan bagaimana peristiwa mouse diteruskan selama setiap frame

Dipicu selama setiap heartbeat bahwa mouse tidak sedang diteruskan ke event mouse lainnya.

Catatan, event ini tidak boleh digunakan untuk menentukan kapan mouse diam.
Karena dipicu setiap heartbeat, ini akan dipicu di antara event `Class.Mouse.Move`
.

Untuk informasi tentang cara memperoleh objek `Class.Mouse`, silakan lihat halaman
`Class.Mouse`.

Pengembang dapat mengetahui posisi mouse di ruang dunia, dan jika
itu menunjuk ke `Class.BasePart` menggunakan properti `Class.Mouse.Hit` dan
`Class.Mouse.Target`.

Catatan, pengembang disarankan untuk menggunakan `Class.UserInputService`
dibandingkan objek `Class.Mouse` dalam pekerjaan baru.

Mouse.Idle

Dipicu selama setiap heartbeat bahwa mouse tidak sedang diteruskan ke event mouse lainnya.

Contoh di bawah ini, dengan asumsi bahwa 'mouse' telah didefinisikan, akan mencetak tombol yang
tekan (misalnya "q") beserta nilai ascii untuk tombol tersebut (misalnya 113).

Event ini dipicu ketika sebuah Kunci ditekan, dengan argumen yang diteruskan adalah
kunci yang ditekan.

Catatan:

- Tidak semua kunci menghasilkan event ini. Namun, Anda dapat mengelak dari ini dengan
  beberapa kunci, misalnya, "/", dengan menggunakan event `Class.Mouse.KeyUp`.
- Beberapa kunci menghasilkan string yang sama dengan kunci lainnya.
- Ada kemungkinan stringnya kosong (mungkin karena kode kunci "\\0").

Mouse.KeyDown

Mouse.keyDown

Contoh di bawah ini, dengan asumsi bahwa 'mouse' telah didefinisikan, akan mencetak tombol yang
lepaskan (misalnya "q") bersama dengan nilai ascii untuk tombol tersebut (misalnya 113).

Acara ini dipicu saat sebuah Kunci dilepaskan, dengan argumen yang diteruskan adalah
 kunci yang dilepaskan.

Catatan:

- Tidak semua kunci menghasilkan acara ini. Namun, Anda dapat mengakali ini dengan
 beberapa kunci, misalnya "/" dengan menggunakan
  [[API:Class/Mouse/KeyUp|KeyUp]] acara.
- Beberapa kunci menghasilkan string yang sama seperti kunci lainnya.
- Ada kemungkinan stringnya kosong (mungkin karena kode kunci "\\0").


Mouse.KeyUp

Contoh di bawah ini memungkinkan `Class.Players.LocalPlayer|pemain lokal` untuk memindahkan
bagian dengan mouse mereka.

Ketika pemain menekan tombol mouse kiri mereka di atas sebuah bagian, bagian tersebut adalah
`Class.Mouse.Target|target mouse` dan menjadi _titik_. Sampai pemain
melepaskan tombol mouse kiri mereka, bagian itu akan pindah ke posisi dunia mouse
ketika pemain memindahkan mouse mereka.

Perhatikan bahwa properti `Class.Mouse.TargetFilter` memungkinkan kode untuk mengabaikan
bagian yang sedang dipindahkan saat menentukan posisi dunia mouse.

Kode ini seharusnya bekerja seperti yang diharapkan ketika diletakkan dalam `LocalScript`.

Ditembak saat mouse dipindahkan.

Catatan, acara ini dipicu saat posisi mouse diperbarui, sehingga
 akan terpicu berulang kali saat bergerak.

Untuk informasi tentang cara mendapatkan objek `Class.Mouse`, silakan lihat
 halaman `Class.Mouse`.

Pengembang dapat menemukan posisi mouse dalam ruang dunia, dan jika
 mouse menunjuk ke bagian `Class.BasePart` menggunakan properti `Class.Mouse.Hit` dan
 `Class.Mouse.Target`.

```
mouse.Move:Connect(function()
	local position = mouse.Hit.p
	local target = mouse.Target
	print(target, position)
end)
```
Catatan, pengembang disarankan untuk menggunakan `Class.UserInputService` sebagai gantinya
 dari objek `Class.Mouse` dalam pekerjaan baru.


Mouse.Move

Contoh di bawah ini mengasumsikan bahwa Anda sudah mendapatkan mouse pemain (dan
menyimpannya sebagai variabel bernama 'mouse'), baik dengan menggunakan `Class.Tool`,
`Class.HopperBin` atau metode `Class.Player:GetMouse()`. Ini akan mencetak
"Roda bergerak ke belakang!" saat pemain menggulir ke belakang.

Acara WheelBackward terjadi saat roda mouse digulir ke belakang.
Penggunaan yang mungkin untuk acara ini termasuk mengalihkan scope senjata dalam
 tembak-menembak orang pertama (FPS) atau memperbesar kamera pemain.

Ini dapat digunakan bersama dengan acara pengguliran ke depan,
 `Class.Mouse.WheelForward`.

Untuk informasi tentang cara mendapatkan objek `Class.Mouse`, silakan lihat
 halaman `Class.Mouse`.

Catatan, pengembang disarankan untuk menggunakan `Class.UserInputService` sebagai gantinya
 dari objek `Class.Mouse` dalam pekerjaan baru.


Mouse.WheelBackward

Ditembak saat roda mouse digulir ke belakang.


Contoh di bawah ini mengasumsikan bahwa Anda sudah mendapatkan mouse pemain (dan
menetapkannya sebagai variabel bernama 'mouse'), baik menggunakan `Tool`, `HopperBin`
atau metode `Class.Player:GetMouse()`. Ini akan mencetak "Gulir maju!"
ketika pemain menggulir maju.

Acara WheelForward terjadi saat roda mouse digulir ke depan.
Penggunaan yang mungkin untuk acara ini termasuk mengalihkan scope senjata dalam
 tembak-menembak orang pertama (FPS) atau memperbesar kamera pemain.

Ini dapat digunakan bersama dengan acara pengguliran ke belakang,
 `Class.Mouse.WheelBackward`.

Untuk informasi tentang cara mendapatkan objek `Class.Mouse`, silakan lihat
 halaman `Class.Mouse`.

Catatan, pengembang disarankan untuk menggunakan `Class.UserInputService` sebagai gantinya
 dari objek `Class.Mouse` dalam pekerjaan baru.


Mouse.WheelForward

Ditembak saat roda mouse digulir ke depan.


Mouse

Kode dalam contoh ini, ketika ditempatkan di dalam `LocalScript` di
`StarterPlayerScripts`, akan menggambar bilah laser merah antara kepala karakter
serta `Class.Mouse.Hit` setiap saat.

Perhatikan, bilah ini akan melewati berbagai rintangan di tampilan orang ketiga
karena pencahayaan `Mouse` dilakukan dari `Class.Workspace.CurrentCamera`, bukan dari
kepala.

Kode di bawah ini memvisualisasikan perbedaan antara `Class.Mouse.Hit` dan
`Class.Mouse.Origin`. Untuk melakukan ini, kode menggunakan
posisi `Datatype.Vector3` dari nilai hit dan origin `Datatype.CFrame`
dengan menggunakan `.p`.

Perbedaannya adalah bahwa asal adalah "di mana mouse berasal" (asalnya)
dan hit adalah posisi di mana mouse mengenai (ketika pemain menekan
mouse mereka).

Contoh ini juga memvisualisasikan bahwa asal mouse sangat mirip dengan
posisi dari `CurrentCamera` dengan mencetak magnitudo (jarak) antara
kedua posisi.

Properti ini menunjukkan `Datatype.CFrame` dari posisi mouse di 3D
ruang. Perhatikan bahwa `Class.Mouse.TargetFilter` dan keturunannya akan diabaikan.

Pengembang dapat memperoleh posisi Hit seperti ini:

```
local position = mouse.Hit.Position
```
Hit sering digunakan oleh `Class.Tool|Tools` untuk menembakkan senjata ke arah mouse
dalam tampilan orang ketiga.

Pengembang yang mencari `Class.BasePart` yang ditunjuk mouse harus menggunakan
`Class.Mouse.Target`.

#### Bagaimana cara Mouse.Hit dihitung?

Posisi CFrame Hit dihitung sebagai titik perpotongan
antara `Datatype.Ray` internal mouse (versi diperpanjang dari
`Class.Mouse.UnitRay`) dan objek di ruang 3D (seperti bagian).

Orientasi CFrame Hit sesuai dengan arah dari
`Class.Mouse.UnitRay`.

```
local unitRayDirection = mouse.UnitRay.Direction
local mouseHitDirection = mouse.Hit.lookVector
-- unitRayDirection ≈ mouseHitDirection
-- vektor adalah hampir sama
```
Perhatikan, roll dari `Class.Workspace.CurrentCamera` tidak digunakan saat
menghitung orientasi dari `Datatype.CFrame` Hit.

Ray internal mouse memiliki panjang 1.000 studs. Jika mouse tidak
mengarah ke objek di ruang 3D (misalnya saat mengarah ke langit),
properti ini akan berjarak 1.000 studs dari
`Class.Workspace.CurrentCamera`.

Mouse.Hit

`Datatype.CFrame` dari posisi mouse di ruang 3D.

Mouse.hit

Contoh ini mengubah ikon mouse `Class.Players.LocalPlayer` menjadi terlihat seperti gambar
dragon.


**Icon** adalah properti yang menentukan gambar yang digunakan sebagai pointer. Jika
kosong, panah default digunakan. Saat kursor melayang di atas
`Class.GuiButton`, properti ini sementara diabaikan. Properti ini
hanya mendukung URI aset.

Untuk menyembunyikan kursor sepenuhnya, **jangan** gunakan gambar transparan &ndash;
melainkan, setel `Class.UserInputService.MouseIconEnabled` ke false.

Untuk mendapatkan/mengatur ikon mouse pengguna dalam pengalaman, Anda harus menggunakan
`Class.UserInputService.MouseIcon`. `Class.Mouse.Icon` akan dinyatakan usang
setelah API baru untuk plugin untuk mengatur kursor mouse dirilis.

##### Merancang Kursor

Panduan berikut mungkin berguna saat membuat kursor mouse Anda sendiri:

- Dimensi gambar yang digunakan menentukan ukuran kursor.
- Dimensi gambar tidak boleh melebihi 256 piksel pada sumbu manapun.
- **Tengah** gambar adalah tempat dimana input mouse dikeluarkan.
- Gambar mouse default adalah 64x64 piksel, dengan mouse menghabiskan 17x24
  piksel ruang.

##### Kursor Sistem

Saat menggunakan `Class.PluginMouse` yang diambil dari `Class.Plugin:GetMouse()`,
you dapat menggunakan ikon berikut yang mirip dengan kursor default sistem Anda,
such as hands, arrows, I-beams, dll. Anda dapat menggunakan ini dengan event GUI
seperti `Class.GuiObject.MouseEnter|MouseEnter`,
`Class.GuiObject.MouseLeave|MouseLeave`, dan
`Class.GuiButton.MouseButton1Down|MouseButton1Down` untuk memberikan
pengalaman Studio yang konsisten saat berinteraksi dengan jenis komponen GUI tertentu.
Perhatikan bahwa ini hanya berfungsi untuk plugin Studio; mereka tidak akan
bekerja untuk objek `Class.Mouse` lainnya.

<table>
    <thead>
        <tr>
            <th>Tampilan*</th>
            <th>Asset</th>
            <th>Penggunaan yang Disarankan</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>Klik dan pemilihan default.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-PointingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/PointingHand</code></td>
            <td>Melayang di atas link/button aktif.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-OpenHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/OpenHand</code></td>
            <td>Melayang di atas item yang dapat diseret.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-GrabbingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/ClosedHand</code></td>
            <td>Menyeret item.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-IBeam.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/IBeam</code></td>
            <td>Melayang di field teks.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNS.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNS</code></td>
            <td>Melayang di atas pegangan resize vertikal.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeEW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeEW</code></td>
            <td>Melayang di atas pegangan resize horizontal.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNESW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNESW</code></td>
            <td>Melayang di atas pegangan resize sudut.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNWSE.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNWSE</code></td>
            <td>Melayang di atas pegangan resize sudut.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeAll.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeAll</code></td>
            <td>Melayang di atas pegangan resize multi arah.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitV.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitNS</code></td>
            <td>Melayang di atas pegangan "split" vertikal.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitH.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitEW</code></td>
            <td>Melayang di atas pegangan "split" horizontal.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Forbidden.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Forbidden</code></td>
            <td>Melayang di atas item yang terkunci/dilarang.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Wait.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Wait</code></td>
            <td>Menunjukkan sebuah tindakan sedang berlangsung.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Busy.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Busy</code></td>
            <td>Menunjukkan sistem sedang sibuk.</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Crosshair.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Cross</code></td>
            <td>Melayang di atas area pemilihan titik.</td>
        </tr>
    </tbody>
</table>

<figcaption>* Tampilan ini adalah perkiraan &mdash; penampilan sebenarnya tergantung pada sistem operasi Anda.</figcaption>

Mouse.Icon

ID konten dari gambar yang digunakan sebagai ikon `Class.Mouse`.


Properti asal `Class.Mouse` adalah sebuah `Datatype.CFrame` yang menunjukkan dari mana
mouse berasal. Itu terletak di
`Class.Workspace.CurrentCamera` dan berorientasi ke posisi 3D
mouse.

`Class.Mouse.UnitRay` dimulai dari posisi yang sama dengan Origin, dan memperpanjang
untuk sebuah stud dalam arah yang sama.

```lua
local unitRay = mouse.UnitRay
local origin = mouse.Origin
-- unitRay.Direction = origin.p
-- unitRay.Direction ≈ origin.lookVector
```
Untuk posisi dari `Class.Mouse` dalam ruang 3D, lihat `Class.Mouse.Hit`.

Mouse.IconContent

Konten dari gambar yang digunakan sebagai ikon `Class.Mouse`. Hanya mendukung
 URI aset.


Properti asal `Class.Mouse` adalah `Datatype.CFrame` yang menunjukkan dari mana
 mouse berasal. Ini diposisikan di
 `Class.Workspace.CurrentCamera` dan berorientasi ke posisi 3D
 mouse.

`Class.Mouse.UnitRay` dimulai dari posisi yang sama dengan Asal, dan diperpanjang
 sejauh satu stud ke arah yang sama.

```lua
local unitRay = mouse.UnitRay
local origin = mouse.Origin
-- unitRay.Direction = origin.p
-- unitRay.Direction ≈ origin.lookVector
```
Untuk posisi `Class.Mouse` dalam ruang 3D, lihat `Class.Mouse.Hit`.


Mouse.Origin

Sebuah `Datatype.CFrame` yang diposisikan di `Class.Workspace.CurrentCamera` dan
 berorientasi menuju posisi 3D mouse.


Ketika ditempatkan dalam `LocalScript` di `StarterPlayerScripts`, kode berikut
mengubah `Class.BasePart.BrickColor` dari setiap `BasePart` yang diklik pemain,
seperti lokasi spawn atau baseplate.


Objek dalam ruang 3D yang ditunjuk oleh `Class.Mouse|mouse`.

Catatan:

- Jika `Class.Mouse.TargetFilter` telah disetel, filter target dan
descendants-nya akan diabaikan.
- Ketika mouse tidak menunjuk pada `Class.BasePart`, misalnya saat
 menunjuk ke langit, Target akan bernilai `nil`.
- Pengembang yang mencari posisi mouse dalam ruang 3D harus menggunakan
 `Class.Mouse.Hit`.


Mouse.Target

Objek dalam ruang 3D yang ditunjuk oleh `Class.Mouse|mouse`.


Mouse.target

Properti ini menentukan objek yang diabaikan oleh mouse saat
 menghitung `Class.Mouse.Hit` dan `Class.Mouse.Target`. Descendants dari
 objek juga diabaikan, sehingga Anda dapat mengabaikan beberapa objek
 selama mereka adalah turunan dari objek yang diberikan properti ini.
Properti ini berguna saat menyaring model yang mengandung efek
 khusus atau dekorasi yang tidak seharusnya mempengaruhi `Class.Mouse.Hit` atau
 `Class.Mouse.Target`.

Properti ini dapat disetel ke sembarang `Class.Instance` atau `nil`, misalnya:

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

local player = Players.LocalPlayer
local mouse = player:GetMouse()
mouse.TargetFilter = Workspace.Model
```
Perhatikan bahwa `Class.Player.Character|Character` dari
 `Class.Players.LocalPlayer` diabaikan oleh mouse secara otomatis.


Mouse.TargetFilter

Menentukan objek (dan descendannya) yang diabaikan saat menentukan
 `Class.Mouse.Hit` dan `Class.Mouse.Target`.


Kode dalam contoh ini, ketika diletakkan dalam `LocalScript` di dalam
`StarterPlayerScripts` akan mengatur permukaan dari setiap `BasePart` yang diklik menjadi
permukaan yang acak.

Properti ini menunjukkan `Enum.NormalId` dari permukaan `Class.BasePart`
 yang ditunjuk oleh mouse. Properti ini diperoleh dari
 posisi dunia mouse (`Class.Mouse.Hit`) dan bagian yang ditunjuk
 oleh mouse (`Class.Mouse.Target`).

Properti ini tidak berarti ketika mouse tidak menunjuk ke bagian,
 misalnya ketika mouse menunjuk ke langit. Untuk saat ini, properti ini
 disetel ke 'Kanan' dalam keadaan ini. Sebelum menggunakan properti ini,
 pastikan bahwa target mouse tidak `nil`.

```lua
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
-- Periksa apakah ada bagian yang ditunjuk oleh mouse
if mouse.Target then
	print("Mouse menunjuk ke sisi " .. mouse.TargetSurface.Name .. " dari " .. mouse.Target.Name)
else
	print("Mouse tidak menunjuk ke apapun.")
end
```


Mouse.TargetSurface

Menunjukkan `Enum.NormalId` dari permukaan `Class.BasePart` yang
 ditunjuk oleh mouse.


Properti UnitRay adalah `Datatype.Ray` yang diarahkan ke posisi mouse
 dalam ruang 3D (dijelaskan oleh `Class.Mouse.Hit`). Ini berasal dari
 `Class.Camera.CFrame|CFrame` dari `Class.Workspace.CurrentCamera`.
Seperti semua unit ray, ini memiliki jarak 1.

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


Mouse.UnitRay

Sebuah `Datatype.Ray` yang diarahkan ke posisi dunia mouse, berasal
 dari posisi dunia `Class.Workspace.CurrentCamera`.


Contoh kode ini menunjukkan bagaimana Anda dapat membuat sebuah `Datatype.Vector2` yang mewakili
posisi objek `Mouse` di layar (`Class.Mouse.X|X()` dan
`Class.Mouse.Y|Y()`) serta ukuran layar itu sendiri
(`Class.Mouse.ViewSizeX|ViewSizeX()` dan `Class.Mouse.ViewSizeY|ViewSizeY()`).
Dengan menggunakan ini, Anda dapat menormalisasi posisi mouse di layar sedemikian rupa
sehingga sudut kiri atas tepat di bawah bilah atas memetakan ke (0, 0) dan sudut kanan bawah memetakan ke
(1, 1). Posisi yang dinormalisasi ini dihitung dan dicetak saat mouse bergerak
menggunakan event `Class.Mouse.Move|Move()`.

Properti ViewSizeX menggambarkan komponen horizontal dari ukuran
 jendela permainan dalam piksel.


Mouse.ViewSizeX

Menggambarkan lebar jendela permainan dalam piksel.


Properti ViewSizeY menggambarkan komponen vertikal dari ukuran
 jendela permainan dalam piksel. Panjang ini mencakup ruang yang digunakan oleh
 bilah atas.


Mouse.ViewSizeY

Menggambarkan tinggi jendela permainan dalam piksel.


Saat mendeteksi perubahan posisi mouse di layar, sangat disarankan
 agar Anda menggunakan `Class.ContextActionService:BindAction()` dengan
 `Enum.UserInputType.MouseMovement` atau
 `Class.UserInputService.InputChanged`, yang keduanya menggambarkan posisi mouse
 menggunakan `Class.InputObject.Position|Position` (sebuah
 `Datatype.Vector3`) dari `Class.InputObject`, bukan
 dengan menggunakan properti ini dan relasinya.

Properti X menggambarkan komponen horizontal dari posisi mouse
 di layar. Posisi diukur dalam piksel relatif terhadap sudut kiri atas,
 di bawah bilah atas. Properti ini dapat digunakan bersamaan dengan
 `Class.Mouse.Y` untuk menghasilkan `Datatype.Vector2` yang mewakili
 posisi mouse:

```lua
local position = Vector2.new(mouse.X, mouse.Y)
```
Properti ini tidak memicu `Class.Object.Changed|Changed` atau sinyal
 yang dikembalikan dari
 `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal`. Gunakan
 acara `Class.Mouse.Move` sebagai gantinya.


Mouse.X

Menggambarkan komponen X (horizontal) dari posisi mouse di
 layar.


Saat mendeteksi perubahan posisi mouse di layar, sangat disarankan
 agar Anda menggunakan `Class.ContextActionService:BindAction()` dengan
 `Enum.UserInputType.MouseMovement` atau
 `Class.UserInputService.InputChanged`, yang keduanya menggambarkan posisi mouse
 menggunakan `Class.InputObject.Position|Position` (sebuah
 `Datatype.Vector3`) dari `Class.InputObject`, bukan
 dengan menggunakan properti ini dan relasinya.

Properti Y menggambarkan komponen vertikal dari posisi mouse
 di layar. Posisi diukur dalam piksel relatif terhadap sudut kiri atas,
 di bawah bilah atas. Properti ini dapat digunakan bersamaan dengan
 `Class.Mouse.X` untuk menghasilkan `Datatype.Vector2` yang mewakili
 posisi mouse:

```lua
local position = Vector2.new(mouse.X, mouse.Y)
```
Properti ini tidak memicu `Class.Object.Changed|Changed` atau sinyal
 yang dikembalikan dari
 `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal`. Gunakan
 acara `Class.Mouse.Move` sebagai gantinya.


Mouse.Y

Menggambarkan komponen Y (vertikal) dari posisi mouse di
 layar.


Objek warisan yang berisi anggota yang berguna untuk input pointer.

`Instance` adalah kelas dasar untuk semua kelas dalam hierarki kelas Roblox
yang dapat menjadi bagian dari pohon `Class.DataModel`.

Tidak mungkin untuk secara langsung membuat objek root `Instance`, tetapi konstruktor khusus
`Datatype.Instance.new()` membuat objek melalui kode, mengambil nama kelas
sebagai parameter dan mengembalikan objek yang dibuat.

Menunjukkan cara mendeteksi perubahan pada leluhur sebuah instance dengan menghubungkan ke
`Class.Instance.AncestryChanged` event.

Parent dari ChangingPart diatur ke nilai yang berbeda seiring waktu. Parent dari
part adalah leluhur part, jadi event `Class.Instance.AncestryChanged`
akan dipicu setiap kali terjadi perubahan.


Dibakar saat instans ini diubah parent-nya atau saat salah satu nenek
moyangnya diubah parent-nya.

Anda dapat menggunakan peristiwa ini untuk melacak penghapusan sebuah
instans di Studio, seperti penghapusan manual di Explorer atau melalui
plugin. Jika Anda perlu mendeteksi saat sebuah instans dihancurkan menggunakan
`Class.Instance:Destroy()`, gunakan peristiwa `Class.Instance.Destroying`
sebagai gantinya.

Instance.AncestryChanged

child

Instans yang properti `Class.Instance.Parent|Parent`-nya diubah,
yang bisa jadi instans ini atau nenek moyang yang lebih jauh, **tidak**
selalu instans yang terhubung dengan handler.

parent

Dibakar saat properti `Class.Instance.Parent` dari objek ini atau salah satu
nenek moyangnya diubah.

Peristiwa ini dibakar setiap kali atribut apa pun diubah pada instans,
termasuk ketika atribut diatur ke `nil`. Nama atribut yang diubah
akan diteruskan ke fungsi yang terhubung.

Sebagai contoh, cuplikan kode berikut menghubungkan fungsi `attributeChanged()`
untuk dibakar kapan pun salah satu atribut bagian diubah:

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

local part = Workspace.Part

local function attributeChanged(attributeName)
	print(attributeName, "diubah")
end

part.AttributeChanged:Connect(attributeChanged)
```
Lihat juga `Class.Instance:GetAttributeChangedSignal()` yang mengembalikan sebuah
event yang dibakar saat atribut tertentu diubah.

Instance.AttributeChanged

attribute

Dibakar kapan pun atribut diubah pada `Class.Instance`.

Cuplikan ini mencetak nama objek saat mereka ditambahkan ke Workspace:


Dibakar setelah sebuah objek di-parent ke `Class.Instance` ini.

Catatan, saat menggunakan metode ini di client untuk mendeteksi objek yang
 dibuat oleh server itu perlu menggunakan `Class.Instance:WaitForChild()` saat
mengindeks keturunan objek ini. Ini karena objek dan keturunannya tidak
dijamin untuk direplikasi dari server ke client secara bersamaan. Sebagai contoh:

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

Workspace.ChildAdded:Connect(function(child)
	-- Gunakan WaitForChild() karena keturunan mungkin belum direplikasi
	local head = child:WaitForChild("Head")
end)
```
Catatan, peristiwa ini hanya beroperasi untuk anak-anak langsung dari
`Class.Instance`. Untuk sebuah peristiwa yang menangkap semua keturunan, gunakan
`Class.Instance.DescendantAdded`.

Lihat juga `Class.Instance.ChildRemoved`.

Instance.ChildAdded

Dibakar setelah sebuah objek di-parent ke `Class.Instance` ini.

Instance.childAdded

Potongan ini mencetak nama objek saat mereka dihapus dari Workspace:

Dibakar setelah seorang anak dihapus dari `Class.Instance` ini.

Dihapus berarti saat parent objek diubah dari `Class.Instance` ini ke
sesuatu selain `Class.Instance` ini. Catatan, peristiwa ini juga akan dibakar
 saat seorang anak dihancurkan (menggunakan
`Class.Instance:Destroy()`) karena fungsi hancur menetapkan parent objek ke
`nil`.

Peristiwa ini hanya beroperasi untuk anak-anak langsung dari `Class.Instance`.
Untuk sebuah peristiwa yang menangkap semua keturunan, gunakan
`Class.Instance.DescendantRemoving`.

Lihat juga `Class.Instance.ChildAdded`.

Instance.ChildRemoved

Dibakar setelah seorang anak dihapus dari `Class.Instance` ini.

Contoh berikut akan mencetak nama objek apa pun yang ditambahkan ke
Workspace:

Peristiwa ini dibakar setelah sebuah keturunan ditambahkan ke `Class.Instance`.

Karena dibakar untuk setiap keturunan, meng-parent sebuah objek ke
`Class.Instance` akan membakar peristiwa untuk objek ini dan semua keturunannya
secara terpisah.

Jika Anda hanya khawatir dengan **anak-anak langsung** dari
`Class.Instance`, gunakan `Class.Instance.ChildAdded` sebagai gantinya.

Lihat juga `Class.Instance.DescendantRemoving`.

Instance.DescendantAdded

descendant

Dibakar setelah sebuah keturunan ditambahkan ke `Class.Instance`.

Contoh berikut mencetak nama dari setiap keturunan saat sedang dihapus
 dari Workspace:

Peristiwa ini dibakar **segera sebelum** parent `Class.Instance`
berubah sehingga sebuah instans **keturunan** tidak lagi menjadi
keturunan. `Class.Instance:Destroy()|Destroy()` mengubah `Class.Instance.Parent|Parent`
menjadi `nil`, jadi memanggil metode itu pada seorang keturunan dari parent
akan menyebabkan peristiwa ini dibakar.

Karena peristiwa ini dibakar **sebelum** penghapusan keturunan, parent dari
keturunan tidak akan berubah pada saat peristiwa ini dibakar. Jika keturunan
 juga adalah **anak langsung** dari parent, peristiwa ini akan dibakar
sebelum `Class.Instance.ChildRemoved`.

Jika keturunan memiliki anak, peristiwa ini dibakar dengan keturunan terlebih dahulu,
dikuti oleh keturunannya.

#### Peringatan

Peristiwa ini dibakar dengan objek keturunan yang sedang dihapus.
Mencoba mengatur `Class.Instance.Parent|Parent` dari keturunan ke yang lain
akan gagal. Di bawah ini adalah contoh yang menunjukkan hal ini:

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

Workspace.DescendantRemoving:Connect(function(descendant)
	-- Jangan manipulasi parent dari keturunan dalam fungsi ini!
	-- Peristiwa ini dibakar KARENA parent telah dimanipulasi, dan perubahan belum terjadi
	-- Oleh karena itu, problematik untuk mengubah parent seperti ini:
	descendant.Parent = game
end)

local part = Instance.new("Part")
part.Parent = Workspace
part.Parent = nil
```
Lihat juga `Class.Instance.DescendantAdded|DescendantAdded`.

Instance.DescendantRemoving

Dibakar segera sebelum seorang keturunan dari `Class.Instance` dihapus.

Contoh ini menunjukkan bagaimana, saat menggunakan perilaku sinyal Segera, sebuah
Instance yang dihancurkan tetap berada di tempatnya sampai fungsi yang terhubung menunggu.


Contoh ini menunjukkan bagaimana, ketika menggunakan perilaku sinyal Tertunda, sebuah Instance
 dihancurkan sebelum sinyal dipicu.


`Class.Instance` tidak akan pernah dihapus dari memori selama fungsi yang terhubung
masih menggunakannya. Namun, jika fungsi tersebut menunggu pada titik manapun,
`Class.Instance` dan keturunannya akan di-parent ke `nil`.

Jika properti `Class.Workspace.SignalBehavior` diatur ke
`Enum.SignalBehavior.Immediate`, peristiwa ini dibakar segera sebelum
`Class.Instance` atau salah satu nenek moyangnya dihancurkan dengan
`Class.Instance:Destroy()`.

Jika properti `Class.Workspace.SignalBehavior` diatur ke
`Enum.SignalBehavior.Deferred`, peristiwa ini dibakar pada titik pemulihan
b berikutnya, yang akan terjadi setelah `Class.Instance` atau salah satu nenek moyangnya dihancurkan dengan
`Class.Instance:Destroy()`.

Dengan perilaku `Enum.SignalBehavior.Deferred|Deferred`, menghubungkan skrip
dengan peristiwa `Class.Instance.Destroying` sendiri adalah problematik,
karena skrip akan dihancurkan sebelum callback dapat dipanggil (berarti tidak
akan dieksekusi).

Saat menghapus `Class.Instance` di Studio, seperti menghapus secara manual
melalui [Explorer](/studio/explorer) atau melalui plugin,
`Class.Instance` tidak dihapus. Sebagai gantinya, parent diatur ke `nil`
 yang dapat Anda lacak dengan `Class.Instance.AncestryChanged`.

Instance.Destroying

Dibakar segera sebelum (atau ditunda sampai setelah) instans dihancurkan
melalui `Class.Instance:Destroy()`.

Peristiwa ini dibakar kapan pun properti gaya apa pun diubah pada instans,
termasuk ketika sebuah properti diatur ke `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("Properti gaya diubah")
end

meterBar:StyledPropertiesChanged():Connect(stylePropertyChanged)
```

Instance.StyledPropertiesChanged

Dibakar kapan pun properti gaya apa pun diubah pada instans, termasuk
ketika sebuah properti diatur ke `nil`.

Metode ini memberi tag pada instance, tanpa efek jika tag sudah
 diterapkan. Menambahkan tag dengan sukses akan memicu sinyal yang dibuat untuk
`Class.CollectionService:GetInstanceAddedSignal()` dengan tag yang diberikan.

#### Peringatan

- Tag-tag dari sebuah instance yang ditambahkan di sisi klien akan diabaikan jika
  server menghapus atau menambah tag pada instance tersebut karena server
  mereplikasi semua tag bersama-sama dan menimpa tag sebelumnya.

- Ketika memberi tag pada sebuah instance, umum untuk menggunakan beberapa sumber
  daya untuk memberikan fungsionalitas kepada tag tersebut, misalnya sambungan
  peristiwa atau tabel. Untuk mencegah kebocoran memori, merupakan ide baik
  untuk membersihkannya (putuskan sambungan, atur ke `nil`, dll.) ketika
  tidak lagi dibutuhkan untuk tag. Ini dilakukan saat memanggil
  `Class.Instance:RemoveTag()`, memanggil
  `Class.Instance:Destroy()`, atau dalam fungsi yang terhubung ke sinyal
  yang dikembalikan oleh`Class.CollectionService:GetInstanceRemovedSignal()`.

Instance:AddTag

Fungsi anak mengembalikan array dari anak-anak objek.

Instance:children

Mengembalikan array dari anak-anak objek.

Metode ini menghancurkan semua anak dari sebuah instance dan keturunannya.

```
local part = Instance.new("Part")

-- Tambahkan beberapa kilau
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
```
Jika Anda tidak ingin menghancurkan **semua** anak dan keturunan, gunakan
`Class.Instance:GetChildren()` atau `Class.Instance:GetDescendants()` untuk
menelusuri anak-anak/keturunan tersebut dan memilih apa yang akan dihancurkan.
Sebagai contoh, sampel kode berikut akan menghancurkan semua
`Class.BasePart|BaseParts` yang turun dari sebuah `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

Metode ini menghancurkan semua anak dari sebuah instance.

Menunjukkan cara mengkloning sebuah model menggunakan `Class.Instance:Clone()`.

`Clone()` membuat salinan dari sebuah instance dan semua keturunannya,
mengabaikan semua instance yang tidak
`Class.Instance.Archivable|Archivable`. Salinan dari instance root dikembalikan
oleh metode ini dan `Class.Instance.Parent|Parent`-nya diatur menjadi
`nil`. Perlu dicatat bahwa jika instance itu sendiri memiliki
`Class.Instance.Archivable|Archivable` diatur menjadi `false`, metode ini akan
mengembalikan `nil`.

Jika properti referensi seperti `Class.ObjectValue.Value` diatur pada
instance yang dikloning, nilai dari properti salinan tergantung pada
nilai asli:

- Jika sebuah properti referensi merujuk pada instance yang **juga**
dikloning, salinan akan merujuk pada salinan tersebut.
- Jika sebuah properti referensi merujuk pada instance yang **tidak**
dikloning, nilai yang sama dipertahankan di dalam salinan.

Instance:Clone

Buat salinan dari sebuah instance dan semua keturunannya, mengabaikan instance
 yang tidak `Class.Instance.Archivable|Archivable`.

Instance:clone

Menunjukkan cara menghancurkan sebuah Part menggunakan fungsi `Class.Instance:Destroy()`.

Fungsi ini adalah cara yang benar untuk membuang objek yang tidak lagi
dibutuhkan.


Mengatur properti `Class.Instance.Parent` menjadi `nil`, mengunci
properti `Class.Instance.Parent`, memutus semua koneksi, dan memanggil
`Destroy()` pada semua anak. Metode ini adalah cara yang benar untuk menghapus
objek yang tidak lagi diperlukan.

Menghapus objek yang tidak diperlukan sangat penting, karena objek dan
koneksi yang tidak dibutuhkan dapat menghabiskan memori yang dapat
menyebabkan masalah kinerja yang serius seiring waktu.

Sebagai praktik terbaik setelah memanggil `Destroy()` pada sebuah objek,
aturkan variabel apa pun yang merujuk ke objek (atau keturunannya) ke `nil`.
Ini mencegah kode Anda mengakses hal yang berkaitan dengan objek tersebut.

```lua
local part = Instance.new("Part")
part.Name = "Hello, world"
part:Destroy()
-- Jangan lakukan ini:
print(part.Name)  --> "Hello, world"
-- Lakukan ini untuk mencegah baris di atas bekerja:
part = nil
```
Setelah `Class.Instance` dihancurkan oleh metode ini, tidak dapat digunakan
kembali karena properti `Class.Instance.Parent` dikunci. Untuk
**sementara** menghapus objek alih-alih menghancurkannya, atur
`Class.Instance.Parent|Parent` menjadi `nil`. Sebagai contoh:

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

object.Parent = nil
task.wait(2)
object.Parent = Workspace
```
Untuk menghancurkan objek setelah jangka waktu tertentu, gunakan
`Class.Debris:AddItem()`.

Instance:Destroy

Mengatur properti `Class.Instance.Parent` menjadi `nil`, mengunci
properti `Class.Instance.Parent`, memutus semua koneksi, dan memanggil
`Destroy()` pada semua anak.

Instance:destroy

Mengembalikan nenek moyang pertama dari `Class.Instance` yang
`Class.Instance.Name`-nya sama dengan nama yang diberikan.

Metode ini bekerja ke atas, artinya mulai dari `Class.Instance.Parent`
yang dekat dengan instance dan bekerja ke atas menuju `Class.DataModel`. Jika tidak
ada nenek moyang yang cocok ditemukan, metode ini mengembalikan `nil`.

Sampel kode berikut akan menemukan nenek moyang pertama dari objek
bernama `Car`.

```
local car = object:FindFirstAncestor("Car")
```
Untuk varian dari metode ini yang menemukan nenek moyang dari kelas tertentu,
lihat `Class.Instance:FindFirstAncestorOfClass()` dan
`Class.Instance:FindFirstAncestorWhichIsA()`.

Instance:FindFirstAncestor

name

Nama `Class.Instance.Name` yang akan dicari.

Mengembalikan nenek moyang pertama dari `Class.Instance` yang
`Class.Instance.Name`-nya sama dengan nama yang diberikan.

Mengembalikan nenek moyang pertama dari `Class.Instance` yang
`Class.Object.ClassName`-nya sama dengan className yang diberikan.

Metode ini bekerja ke atas, artinya mulai dari `Class.Instance.Parent`
yang dekat dengan instance dan bekerja ke atas menuju `Class.DataModel`. Jika tidak
ada nenek moyang yang cocok ditemukan, metode ini mengembalikan `nil`.

Kegunaan umum dari metode ini adalah menemukan `Class.Model` tempat
 `Class.BasePart` bernaung. Sebagai contoh:

```
local model = part:FindFirstAncestorOfClass("Model")
```
Metode ini adalah varian dari `Class.Instance:FindFirstAncestor()` yang
memeriksa properti `Class.Object.ClassName` alih-alih `Class.Instance.Name`. `Class.Instance:FindFirstAncestorWhichIsA()` juga
ada, menggunakan metode `Class.Object:IsA()` alih-alih untuk menghormati
pewarisan kelas.

Instance:FindFirstAncestorOfClass

className

Nama `Class.Object.ClassName` yang akan dicari.

Mengembalikan nenek moyang pertama dari `Class.Instance` yang
`Class.Object.ClassName`-nya sama dengan className yang diberikan.

Mengembalikan nenek moyang pertama dari `Class.Instance` yang
`Class.Object:IsA()` mengembalikan nilai benar untuk className yang diberikan.

Metode ini bekerja ke atas, artinya mulai dari `Class.Instance.Parent`
yang dekat dengan instance dan bekerja ke atas menuju `Class.DataModel`. Jika tidak
ada nenek moyang yang cocok ditemukan, metode ini mengembalikan `nil`.

Berbeda dengan `Class.Instance:FindFirstAncestorOfClass()`, metode ini menggunakan
`Class.Object:IsA()` yang menghormati pewarisan kelas. Sebagai contoh:

```
print(part:IsA("Part"))  --> true
print(part:IsA("BasePart"))  --> true
print(part:IsA("Instance"))  --> true
```
Oleh karena itu, sampel kode berikut akan mengembalikan
nenek moyang pertama `Class.BasePart`, terlepas dari apakah itu `Class.WedgePart`,
`Class.MeshPart` atau `Class.Part`.

```
local part = object:FindFirstAncestorWhichIsA("BasePart")
```
Lihat juga `Class.Instance:FindFirstAncestor()`.

Instance:FindFirstAncestorWhichIsA

Mengembalikan nenek moyang pertama dari `Class.Instance` yang
`Class.Object:IsA()` mengembalikan nilai benar untuk className yang diberikan.

Di bawah ini akan mencari di Workspace untuk objek dengan nama "Brick". Jika ditemukan,
akan mengganti nama objek tersebut menjadi "Foo".

Mengembalikan anak pertama dari `Class.Instance` dengan nama yang diberikan, atau
`nil` jika tidak ada anak seperti itu. Jika argumen opsional `recursive`
bernilai `true`, metode ini mencari semua keturunan daripada hanya anak langsung
`Class.Instance`.

#### Memeriksa Keberadaan Objek

`FindFirstChild()` diperlukan jika Anda perlu memverifikasi sebuah objek ada
sebelum melanjutkan. Mencoba mengindeks seorang anak berdasarkan nama menggunakan
operator titik akan menghasilkan kesalahan jika anak tidak ada.

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

-- Baris berikut menghasilkan kesalahan jika bagian tidak ada di workspace
Workspace.Part.Transparency = 0.5
```
Pendekatan yang lebih baik adalah menggunakan `FindFirstChild()` untuk
pertama memeriksa `Part`, kemudian menggunakan pernyataan `if` untuk menjalankan
kode yang membutuhkannya.

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

local part = Workspace:FindFirstChild("Part")
if part then
	part.Transparency = 0.5
end
```

#### Menemukan Anak yang Nama Sesuai dengan Properti

Kadang-kadang nama `Class.Instance.Name|Name` dari sebuah objek sama dengan
sebuah properti dari `Class.Instance.Parent|Parent`-nya. Saat menggunakan operator titik,
properti memiliki prioritas lebih dari anak-anak jika keduanya memiliki nama yang sama.

Pada contoh berikut, sebuah `Class.Folder` yang disebut `Color` ditambahkan ke
`Class.Part`, yang juga memiliki properti `Class.Part.Color`. Perhatikan bahwa
`part.Color` merujuk pada nilai properti `Datatype.Color3`, bukan pada instance
anak `Class.Folder`. Keuntungan dari menggunakan
`Class.Instance:FindFirstChild()|FindFirstChild()` adalah bahwa
pengenalan properti baru tidak mengenakan risiko pada kode Anda.

```lua
local part = Instance.new("Part")
local folder = Instance.new("Folder")
folder.Name = "Color"
folder.Parent = part
local c1 = part.Color  -- Properti
local c2 = part:FindFirstChild("Color")  -- Folder anak
```

#### Catatan Kinerja

`Class.Instance:FindFirstChild()|FindFirstChild()` memakan waktu sekitar 20%
lebih lama daripada menggunakan operator titik dan hampir 8 kali lebih lama daripada
hanya menyimpan referensi ke suatu objek. Oleh karena itu, Anda harus menghindari
memanggilnya dalam kode yang bergantung pada kinerja seperti dalam loop ketat atau
fungsi yang terhubung ke `Class.RunService.Heartbeat` dan `Class.RunService.PreRender`.
Sebaliknya, simpan hasil dalam variabel, atau pertimbangkan untuk menggunakan
`Class.Instance.ChildAdded|ChildAdded` atau
`Class.Instance:WaitForChild()|WaitForChild()` untuk mendeteksi kapan anak dengan
nama tertentu tersedia.

Instance:FindFirstChild

recursive

Apakah pencarian harus dilakukan secara rekursif.

Mengembalikan anak pertama dari `Class.Instance` yang ditemukan dengan
nama yang diberikan.

Instance:findFirstChild

Mengembalikan anak pertama dari `Class.Instance` yang memiliki
`Class.Object.ClassName|ClassName` yang sama dengan `className` yang diberikan.
Tidak seperti `Class.Instance:FindFirstChildWhichIsA()`, metode ini hanya mengembalikan
objek yang kelasnya cocok dengan `className`, mengabaikan pewarisan kelas. Jika tidak
ada anak yang cocok ditemukan, metode ini mengembalikan `nil`.

Instance:FindFirstChildOfClass

Mengembalikan anak pertama dari `Class.Instance` yang memiliki
`Class.Object.ClassName|ClassName` yang sama dengan nama kelas yang diberikan.

Mengembalikan anak pertama dari `Class.Instance` yang
`Class.Object:IsA()` mengembalikan nilai benar untuk className yang diberikan.

Jika tidak ada anak yang cocok ditemukan, metode ini mengembalikan `nil`. Jika
argumen opsional rekursif bernilai benar, metode ini mencari semua keturunan
dari hanya anak langsung `Class.Instance`.

Tidak seperti `Class.Instance:FindFirstChildOfClass()`, metode ini menggunakan
`Class.Object:IsA()` yang menghormati pewarisan kelas. Sebagai contoh:

```lua
print(part:IsA("Part")) --> true
print(part:IsA("BasePart")) --> true
print(part:IsA("Instance")) --> true
```
Oleh karena itu, sampel kode berikut akan mengembalikan anak pertama
`Class.BasePart`, terlepas dari apakah itu `Class.WedgePart`,
`Class.MeshPart`, atau `Class.Part`.

```
local part = object:FindFirstChildWhichIsA("BasePart")
```
Pengembang yang mencari anak berdasarkan nama, sebaiknya menggunakan
`Class.Instance:FindFirstChild()` sebagai gantinya.

Instance:FindFirstChildWhichIsA

Mengembalikan anak pertama dari `Class.Instance` yang
`Class.Object:IsA()` mengembalikan nilai benar untuk className yang diberikan.

Mengembalikan keturunan pertama yang ditemukan dengan
`Class.Instance.Name` yang diberikan.

Metode ini dinonaktifkan dan tidak dapat digunakan. Untuk menemukan
keturunan pertama dari sebuah instance, pertimbangkan untuk menggunakan
parameter `recursive` pada `Class.Instance:FindFirstChild()` sebagai gantinya.

Instance:FindFirstDescendant

Mengembalikan keturunan pertama yang ditemukan dengan
`Class.Instance.Name` yang diberikan.

Jika `Class.Instance` adalah `Class.Actor`, `Class.Actor` itu sendiri akan
 dikembalikan. Jika tidak, nenek moyang terdekat `Class.Actor` akan
 dikembalikan. Jika tidak ada nenek moyang `Class.Actor`, hasilnya adalah `nil`.

Instance:GetActor

Mengembalikan `Class.Actor` yang terkait dengan Instance, jika ada.

Metode ini mengembalikan nilai yang telah ditetapkan untuk nama atribut yang
 diberikan. Jika tidak ada atribut yang telah ditetapkan, `nil` akan dikembalikan.

Sebagai contoh, potongan kode berikut mengatur dan kemudian mengambil nilai
 atribut `InitialPosition` dari instance:

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

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)

local initialPosition = instance:GetAttribute("InitialPosition")
print(initialPosition)
```

#### Lihat Juga

- `Class.Instance:SetAttribute()` yang mengatur atribut dengan nama
yang diberikan ke nilai yang diberikan.
- `Class.Instance:GetAttributes()` yang mengembalikan kamus dari pasangan kunci-nilai
 untuk setiap atribut instance.

Instance:GetAttribute

Nilai yang telah ditetapkan untuk nama atribut yang diberikan. Jika tidak
 ada atribut yang telah ditetapkan, `nil` akan dikembalikan.

Mengembalikan nilai yang telah ditetapkan untuk nama atribut yang diberikan.

Metode ini mengembalikan sebuah event yang berfungsi sama dengan
event `Class.Object.Changed|Changed`, kecuali bahwa event ini hanya terpicu ketika
atribut tertentu yang diberikan berubah; secara efektif mirip dengan
`Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()` tetapi
 untuk atribut.

Umumnya merupakan ide bagus untuk menggunakan metode ini alih-alih koneksi
ke `Class.Object.Changed|Changed` dengan sebuah fungsi yang memeriksa nama atribut.
Panggilan berikutnya ke metode ini pada objek yang sama dengan nama atribut
 yang sama mengembalikan event yang sama.

Sampel kode berikut mengembalikan sinyal yang mengaktifkan fungsi
`attributeChanged()` ketika atribut `InitialPosition` dari bagian tersebut berubah:

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

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)

local function attributeChanged()
	print("Atribut telah diubah")
end

part:GetAttributeChangedSignal("InitialPosition"):Connect(attributeChanged)
```
Lihat juga `Class.Instance.AttributeChanged` yang terpicu kapan saja ada
atribut yang diubah pada instance tersebut.

Instance:GetAttributeChangedSignal

Nama atribut yang ditentukan untuk mana sinyal perubahan sedang
 dikembalikan.

Sebuah event yang terpicu ketika atribut yang diberikan berubah.

Mengembalikan sebuah event yang terpicu ketika atribut yang diberikan
berubah.

Metode ini mengembalikan kamus dari pasangan kunci-nilai untuk setiap atribut
dimana kuncinya adalah nama atribut dan nilainya adalah nilai yang tidak `nil`.

Sebagai contoh, potongan kode berikut mengeluarkan atribut dan nilai
 dari sebuah instance:

```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
```
Lihat juga `Class.Instance:GetAttribute()` yang mengembalikan nilai yang telah
 ditetapkan untuk nama atribut yang diberikan.

Instance:GetAttributes

Sebuah kamus dari pasangan string → varian untuk setiap atribut dimana
string adalah nama atribut dan varian adalah nilai yang tidak nil.

Mengembalikan kamus dari atribut instance.

Di bawah ini akan mencetak nama semua objek yang saat ini ada di Workspace saat dijalankan.

Mengembalikan sebuah array (sebuah tabel yang terindeks numerik)
yang berisi semua anak langsung dari instance, atau setiap `Class.Instance`
yang `Class.Instance.Parent|Parent`-nya sama dengan objek tersebut. Array tersebut dapat
iterasi menggunakan baik loop numerik maupun loop generik:

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

-- Contoh loop numerik
local children = Workspace:GetChildren()
for i = 1, #children do
	local child = children[i]
	print(child.Name .. " adalah anak nomor " .. i)
end
```

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

-- Contoh loop generik
local children = Workspace:GetChildren()
for i, child in children do
	print(child.Name .. " adalah anak nomor " .. i)
end
```
Perhatikan bahwa array yang dikembalikan **tidak** diurutkan dalam urutan tertentu, jadi
pengurutan manual (misalnya menggunakan `Library.table.sort()`) sangat dianjurkan untuk
mengurutkan anak-anak yang dikembalikan oleh metode ini.

Lihat juga metode `Class.Instance:GetDescendants()|GetDescendants()`.

Instance:GetChildren

Sebuah array yang berisi anak-anak instance.

Mengembalikan sebuah array yang berisi semua anak dari
 instance.

Instance:getChildren

Mengembalikan string terkode dari ID debug yang digunakan secara internal oleh Roblox. Perlu dicatat bahwa:

- Item ini dilindungi. Mencoba menggunakan ini di dalam `Class.Script` atau
  `Class.LocalScript` akan menyebabkan kesalahan.
- Sebuah ID debug adalah ID yang digunakan dalam proses debugging. Ini memungkinkan debugger untuk
  membaca setiap instruksi sebelum sebuah aplikasi memprosesnya. Semua objek di
  Roblox bertindak sebagai proses dan menjalankan instruksi (atau 'kode') yang dapat
  di-debug jika diperlukan.
- Ini bisa bermanfaat bagi plugin-plugin yang perlu membedakan objek-objek yang serupa
  satu sama lain (seperti objek yang memiliki nama yang sama).

Instance:GetDebugId

scopeLength

Mengembalikan string terkode dari ID debug yang digunakan secara internal oleh Roblox.

GetDescendants sering digunakan untuk melakukan sesuatu kepada semua keturunan yang merupakan
jenis objek tertentu. Kode dalam contoh ini menggunakan GetDescendants dan
`Class.Instance:IsA()` untuk menemukan semua bagian di workspace dan mengubah
warna mereka menjadi hijau.

Metode objek ini mengembalikan array yang berisi semua keturunan
 dari objek tersebut. Berbeda dengan `Class.Instance:GetChildren()`, yang hanya mengembalikan
anak langsung dari sebuah objek, metode ini menemukan setiap anak dari objek,
every child of those children, dan seterusnya.

Perhatikan bahwa array yang dikembalikan **tidak** diurutkan dalam urutan tertentu, jadi
pengurutan manual (misalnya menggunakan `Library.table.sort()`) sangat dianjurkan untuk
mengurutkan keturunan yang dikembalikan oleh metode ini. Juga pertimbangkan
 metode `Class.Instance:QueryDescendants()|QueryDescendants()` untuk melakukan
query keturunan berdasarkan kombinasi selector dan kombinator.

Instance:GetDescendants

Sebuah array yang berisi keturunan instance.

Mengembalikan array yang berisi semua keturunan dari instance.

Contoh kode ini menunjukkan perilaku dari `Class.Instance:GetFullName()`.
Ini menunjukkan bagaimana fungsi berperilaku saat dipanggil pada objek yang tidak berada di
hierarki `DataModel`, dan juga menunjukkan bagaimana nilai yang dikembalikan tidak meloloskan
karakter khusus.

Contoh kode ini mengimplementasikan kembali fungsi `Class.Instance:GetFullName()` dalam
Lua.

Mengembalikan string yang menjelaskan silsilah instance. String tersebut adalah
konkatenasi dari `Class.Instance.Name|Name` dari objek dan para nenek moyangnya,
yang dipisahkan oleh titik. `Class.DataModel` (`game`) tidak dianggap.
Sebagai contoh, sebuah `Class.Part` di dalam `Class.Workspace` mungkin
mengembalikan `Class.Workspace.Part`.

Ketika dipanggil pada `Class.Instance` yang bukan keturunan dari
`Class.DataModel`, metode ini mempertimbangkan semua nenek moyang hingga dan termasuk
nenek moyang teratas yang tidak memiliki `Class.Instance.Parent|Parent`.

Metode ini berguna untuk pencatatan dan debugging. Anda tidak seharusnya mencoba
mengurai string yang dikembalikan untuk operasi yang berguna; metode ini tidak
melindungi titik (atau simbol lainnya) dalam nama objek. Dengan kata lain,
meskipun outputnya sering tampak sebagai identifier Luau yang valid, itu tidak
dijamin.

Instance:GetFullName

Mengembalikan string yang menjelaskan silsilah instance.

Instance

`Instance` adalah kelas dasar untuk semua kelas dalam hierarki kelas Roblox
yang dapat menjadi bagian dari pohon `Class.DataModel`.

/reference/engine/classes/PlayerMouse.yaml