This code sample includes a simple example of how the local player's
`PlayerMouse` can be retrieved using the `Class.Player:GetMouse()` function in
a `LocalScript`. This code should be placed in a `LocalScript` in
`StarterPlayerScripts`.

PlayerMouse berperilaku identik dengan objek `Class.Mouse` yang diperoleh menggunakan `Class.Tool.Equipped` .Ini dapat diakses dari `Class.LocalScript|LocalScripts` menggunakan metode `Class.Player:GetMouse()` pemainlokal.Kedua PlayerMouse dan `Class.Mouse` adalah API lama, 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 yang baru `Class.UserInputService` .Namun objek PlayerMouse dan Mouse tetap didukung karena beberapa alasan.Lihat [Input dan Kamera](/input) untuk informasi lebih lanjut tentang menyesuaikan input dalam pengalaman Anda.

PlayerMouse

PlayerMouse berperilaku identik dengan objek `Class.Mouse` yang diperoleh menggunakan `Class.Tool.Equipped` .Kedua PlayerMouse dan `Class.Mouse` adalah API lama, digantikan oleh `Class.UserInputService` .

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

  Objek **Tikus** memiliki berbagai API untuk pointer, terutama untuk tombol dan raycasting.Ini dapat diakses melalui `Class.Player:GetMouse()` dipanggil pada `Class.Players.LocalPlayer` di dalam `Class.LocalScript` .Ini juga dilewati oleh acara `Class.Tool.Equipped` .

  *   Ini paling terkenal untuk properti `Class.Mouse.Icon|Icon` , yang mengubah penampilan kurator.
  *   Ini terus melemparkan posisi mouse layar ke dunia 3D menggunakan properti `Class.Mouse.TargetFilter|TargetFilter` , menyimpan hasil raycast di `Class.Mouse.Hit|Hit` , `Class.Mouse.Target|Target` , dan `Class.Mouse.TargetSurface|TargetSurface` properti.Ini bisa berguna untuk kasus sederhana, tetapi `Class.WorldRoot:Raycast()` harus digunakan dalam skenario [raycasting](/workspace/raycasting) yang lebih rumit.
  *   `Class.Plugin|Plugins` dapat menggunakan `Class.Plugin:GetMouse()` untuk mendapatkan `Class.PluginMouse` , yang berperilaku serupa.

  ```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 peristiwa input yang sama, seperti , kedua fungsi akan berjalan saat peristiwa terjadi.Tidak ada konsep sinkronisasi/pengiriman input, karena acara tidak mendukung perilaku ini.Namun, `Class.ContextActionService` memiliki perilaku ini melalui `Class.ContextActionService:BindAction()|BindAction` .
  *   Sementara mouse mungkin tidak tersedia di semua platform, Mouse masih akan berfungsi di perangkat seluler (sentuh) dan konsol (gamepad), yang biasanya tidak memiliki perangkat mouse atau penunjuk.Untuk perilaku silang platform eksplisit, gunakan `Class.UserInputService` dan `Class.ContextActionService`.

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

Acara ini terjadi ketika pemain menekan tombol mouse kiri mereka.Perhatikan bahwa ini dapat diakses dari `Class.Tool` ; misalnya, saat ditempatkan di `Class.LocalScript` , kode di bawah ini akan dicetak `Button1Down` setiap kali tombol mouse kiri ditekan.

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

  tool.Equipped:Connect(function(mouse)
  	mouse.Button1Down:Connect(function()
  		print("Button1Down")
  	end)
  end)
  ```

  Anda dapat mengetahui posisi mouse di ruang dunia dan jika menunjuk ke salah satu `Class.BasePart` menggunakan properti `Class.Mouse.Hit|Hit` dan `Class.Mouse.Target|Target`.

Mouse.Button1Down

Melepaskan api saat tombol mouse kiri ditekan.

Acara ini terjadi ketika pemain melepaskan tombol mouse kiri mereka.Perhatikan bahwa ini dapat diakses dari `Class.Tool` ; misalnya, saat ditempatkan di `Class.LocalScript` , kode di bawah ini akan dicetak `Button1Up` setiap kali tombol mouse kiri dilepaskan.

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

  tool.Equipped:Connect(function(mouse)
  	mouse.Button1Up:Connect(function()
  		print("Button1Up")
  	end)
  end)
  ```

  Anda dapat mengetahui posisi mouse di ruang dunia dan jika menunjuk ke salah satu `Class.BasePart` menggunakan properti `Class.Mouse.Hit|Hit` dan `Class.Mouse.Target|Target`.

Mouse.Button1Up

Melepaskan api saat tombol mouse kiri dilepaskan.

Acara ini terjadi ketika pemain menekan tombol mouse kanan mereka.Perhatikan bahwa ini dapat diakses dari `Class.Tool` ; misalnya, saat ditempatkan di `Class.LocalScript` , kode di bawah ini akan dicetak `Button2Down` setiap kali tombol mouse kanan ditekan.

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

  tool.Equipped:Connect(function(mouse)
  	mouse.Button2Down:Connect(function()
  		print("Button2Down")
  	end)
  end)
  ```

  Anda dapat mengetahui posisi mouse di ruang dunia dan jika menunjuk ke salah satu `Class.BasePart` menggunakan properti `Class.Mouse.Hit|Hit` dan `Class.Mouse.Target|Target`.

Mouse.Button2Down

Melepaskan api saat tombol mouse kanan ditekan.

Acara ini terjadi ketika pemain melepaskan tombol mouse kanan mereka.Perhatikan bahwa ini dapat diakses dari `Class.Tool` ; misalnya, saat ditempatkan di `Class.LocalScript` , kode di bawah ini akan dicetak `Button2Up` setiap kali tombol mouse kanan dilepaskan.

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

  tool.Equipped:Connect(function(mouse)
  	mouse.Button2Up:Connect(function()
  		print("Button2Up")
  	end)
  end)
  ```

  Anda dapat mengetahui posisi mouse di ruang dunia dan jika menunjuk ke salah satu `Class.BasePart` menggunakan properti `Class.Mouse.Hit|Hit` dan `Class.Mouse.Target|Target`.

Mouse.Button2Up

Ditembak ketika tombol mouse kanan dilepaskan.

Contoh ini menunjukkan bagaimana peristiwa mouse ditransmisikan selama setiap frame

Ditembak selama setiap detak jantung yang mouse tidak dikirim ke acara mouse lain.

  Catatan, acara ini tidak boleh digunakan untuk menentukan kapan mouse masih. Karena menembak setiap denyut nadi, ia akan menembak di antara `Class.Mouse.Move` peristiwa.

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

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

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

Mouse.Idle

Ditembak selama setiap detak jantung yang mouse tidak dikirim ke acara mouse lain.

The below example, assuming that 'mouse' was defined, would print the key that
was pressed (e.g. "q") along with the ascii value for that key (e.g. 113).

Acara ini terjadi ketika Tombol ditekan, dengan argumen yang dilewati menjadi kunci yang ditekan.

  Catatan:

  *   Tidak semua kunci menghasilkan peristiwa ini. Namun, Anda dapat mengelilinginya dengan beberapa kunci, "/" misalnya, dengan menggunakan peristiwa `Class.Mouse.KeyUp`.
  *   Beberapa kunci menghasilkan string yang sama dengan kunci lain.
  *   Ada kemungkinan string kosong (mungkin karena kode kunci \\(0)\\).

Mouse.KeyDown

The below example, assuming that 'mouse' was defined, would print the key that
was released (e.g. "q") along with the ascii value for that key (e.g. 113).

Acara ini dinyalakan saat Kunci dirilis, dengan argumen yang dilewati menjadi kunci yang dirilis.

  Catatan:

  *   Tidak semua kunci menghasilkan peristiwa ini.Namun, Anda bisa mengatasinya dengan beberapa kunci, "/" misalnya, dengan menggunakan peristiwa \[\[API:Class/Mouse/KeyUp|KeyUp]].
  *   Beberapa kunci menghasilkan string yang sama dengan kunci lain.
  *   Ada kemungkinan string kosong (mungkin karena kode kunci \\(0)\\).

Mouse.KeyUp

The example below allows the `Class.Players.LocalPlayer|local player` to move
parts with their mouse.

When the player presses their left mouse button over a part, that part is the
`Class.Mouse.Target|mouse's target` and becomes the _point_. Until the player
releases their left mouse button, that part will move to the mouse's world
position when the player moves their mouse.

Note that the `Class.Mouse.TargetFilter` property allows the code to ignore
the part being moved when determining the mouse's world position.

The code should work as expected when placed in a `LocalScript`.

Ditembak ketika mouse dipindahkan.

  Catatan, acara ini dinyalakan ketika posisi mouse diperbarui, oleh karena itu akan menyala berulang kali saat dipindahkan.

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

  Pengembang dapat mengetahui posisi mouse di ruang dunia, dan jika menunjuk ke salah satu `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` alih-alih objek `Class.Mouse` dalam pekerjaan baru.

Mouse.Move

The below example assumes that you have already got the player's mouse (and
set it as a variable named 'mouse'), whether by use of a `Class.Tool`,
`Class.HopperBin` or the `Class.Player:GetMouse()` method. It will print
"Wheel went backwards!" when the player scrolls backwards.

Acara WheelBackward terjadi ketika roda mouse diputar ke belakang.Penggunaan yang mungkin untuk acara ini termasuk menyalakan scope senjata di penembak orang pertama (FPS) atau memperbesar kamera pemain.

  Ini dapat digunakan bersama dengan acara gulir 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` alih-alih objek `Class.Mouse` dalam pekerjaan baru.

Mouse.WheelBackward

Melepaskan api saat roda mouse diputar ke belakang.

The below example assumes that you have already got the player's mouse (and
set it as a variable named 'mouse'), whether by use of a `Tool`, `HopperBin`
or the `Class.Player:GetMouse()` method. It will print "Wheel went forward!"
when the player scrolls forwards.

Acara WheelForward terjadi ketika roda mouse diputar ke depan.Penggunaan yang mungkin untuk acara ini termasuk menyalakan scope senjata di penembak orang pertama (FPS) atau memperbesar kamera pemain.

  Ini dapat digunakan bersama dengan acara gulir 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` alih-alih objek `Class.Mouse` dalam pekerjaan baru.

Mouse.WheelForward

Melepaskan api saat roda mouse diputar ke depan.

Mouse.keyDown

Mouse

The code in this sample, when placed inside a `LocalScript` within
`StarterPlayerScripts` will draw a red laser beam between the character's head
and `Class.Mouse.Hit` at all times.

Note, this beam will pass directly through obstructions in third person as the
`Mouse`'s raycasting is done from the `Class.Workspace.CurrentCamera` not the
head.

The code below visualizes the difference between `Class.Mouse.Hit` and
`Class.Mouse.Origin`. In order to do this, the code uses the
`Datatype.Vector3` positions of the hit and origin `Datatype.CFrame` values
using `.p`.

The difference is that the origin is "where the mouse came from" (its origin)
and the hit is the position where the mouse hits (is when the player presses
their mouse).

This example also visualizes that the mouse origin is very similar to the
position of the `CurrentCamera` by printing the magnitude (distance) between
the two positions.

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

  Pengembang dapat mendapatkan posisi Hit seperti ini:

  ```
  local position = mouse.Hit.Position
  ```

  Hit sering digunakan oleh `Class.Tool|Tools` untuk menembak senjata ke arah mouse dalam orang ketiga.

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

  #### Bagaimana Mouse.Hit dihitung?

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

  Orientasi CFrame pukul sesuai dengan arah `Class.Mouse.UnitRay` .

  ```
  local unitRayDirection = mouse.UnitRay.Direction
  local mouseHitDirection = mouse.Hit.lookVector
  -- unitRayDirection ≈ mouseHitDirection
  -- the vectors are approximately equal
  ```

  Catatan, gulungan dari `Class.Workspace.CurrentCamera` tidak digunakan saat menghitung orientasi Hit `Datatype.CFrame` .

  Sinar internal mouse memanjang untuk 1.000 stud.Jika mouse tidak menunjuk ke objek di ruang 3D (misalnya saat menunjuk ke langit), properti ini akan berjarak 1.000 stud dari `Class.Workspace.CurrentCamera` .

Mouse.Hit

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

This example changes the `Class.Players.LocalPlayer` mouse icon to look like
a dragon image.

**Simbol** adalah properti yang menentukan gambar yang digunakan sebagai penunjuk.Jika kosong, panah default digunakan.Sementara kursor mengarah ke atas `Class.GuiButton` , properti ini diabaikan sementara.

  Untuk menyembunyikan kursor sepenuhnya, **jangan** menggunakan gambar transparan - sebagai gantinya, atur `Class.UserInputService.MouseIconEnabled` ke false.

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

  ##### Mendesain Kursor

  Panduan berikut dapat terbukti berguna saat membuat kursor mouse Anda sendiri:

  *   Dimensi gambar yang digunakan menentukan ukuran kursor.
  *   Dimensi gambar tidak boleh melebihi 256 piksel di setiap sumbu.
  *   Pusat **dari gambar** adalah tempat di mana input mouse dikeluarkan.
  *   Gambar mouse default adalah 64x64 piksel, dengan mouse mengambil 17x24 piksel ruang.

  ##### Kursor Sistem

  Saat menggunakan `Class.PluginMouse` yang diambil dari `Class.Plugin:GetMouse()` , Anda dapat menggunakan ikon berikut yang mirip dengan kurator default sistem Anda, seperti tangan, panah, I-beam, dll.Anda dapat menggunakan ini dengan acara 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 berfungsi untuk objek lain `Class.Mouse` .

  <table>
    <thead>
      <tr>
        <th>Lihat*</th>

        <th>Aset</th>

        <th>Penggunaan yang disarankan</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <img src="../../../assets/misc/Mouse-Icon-Pointer.png" width="30">

          </img>
        </td>

        <td><code>rbxasset://SystemCursors/Arrow</code></td><td>Klik dan seleksi default.</td>
      </tr>

      <tr>
        <td>
          <img src="../../../assets/misc/Mouse-Icon-PointingHand.png" width="30">

          </img>
        </td>

        <td><code>rbxasset://SystemCursors/PointingHand</code></td><td>Melayang di atas tautan/tombol aktif.</td>
      </tr>

      <tr>
        <td>
          <img src="../../../assets/misc/Mouse-Icon-OpenHand.png" width="30">

          </img>
        </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">

          </img>
        </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">

          </img>
        </td>

        <td><code>rbxasset://SystemCursors/IBeam</code></td><td>Melayang di bidang teks.</td>
      </tr>

      <tr>
        <td>
          <img src="../../../assets/misc/Mouse-Icon-ResizeNS.png" width="30">

          </img>
        </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">

          </img>
        </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">

          </img>
        </td>

        <td><code>rbxasset://SystemCursors/SizeNESW</code></td><td>Melayang di atas sisi penangan resize.</td>
      </tr>

      <tr>
        <td>
          <img src="../../../assets/misc/Mouse-Icon-ResizeNWSE.png" width="30">

          </img>
        </td>

        <td><code>rbxasset://SystemCursors/SizeNWSE</code></td><td>Melayang di atas sisi pegangan resize.</td>
      </tr>

      <tr>
        <td>
          <img src="../../../assets/misc/Mouse-Icon-ResizeAll.png" width="30">

          </img>
        </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">

          </img>
        </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">

          </img>
        </td>

        <td><code>rbxasset://SystemCursors/SplitEW</code></td><td>Menggantung di atas pegangan "split" horizontal.</td>
      </tr>

      <tr>
        <td>
          <img src="../../../assets/misc/Mouse-Icon-Forbidden.png" width="30">

          </img>
        </td>

        <td><code>rbxasset://SystemCursors/Forbidden</code></td><td>Melayang di atas item terkunci/dilarang.</td>
      </tr>

      <tr>
        <td>
          <img src="../../../assets/misc/Mouse-Icon-Wait.png" width="30">

          </img>
        </td>

        <td><code>rbxasset://SystemCursors/Wait</code></td><td>Menunjukkan bahwa tindakan sedang berlangsung.</td>
      </tr>

      <tr>
        <td>
          <img src="../../../assets/misc/Mouse-Icon-Busy.png" width="30">

          </img>
        </td>

        <td><code>rbxasset://SystemCursors/Busy</code></td><td>Menunjukkan sistem sibuk.</td>
      </tr>

      <tr>
        <td>
          <img src="../../../assets/misc/Mouse-Icon-Crosshair.png" width="30">

          </img>
        </td>

        <td><code>rbxasset://SystemCursors/Cross</code></td><td>Melayang di atas area seleksi pinpoint.</td>
      </tr>
    </tbody>
  </table>

  <figcaption>\* Penampilan ini adalah aproksimasi - penampilan sebenarnya tergantung pada sistem operasi Anda.</figcaption>

Mouse.Icon

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

Properti asal menunjukkan dari mana asal mouse berasal.Ini ditempatkan di `Class.Workspace.CurrentCamera` dan diposisikan ke arah posisi 3D mouse.

  `Class.Mouse.UnitRay` dimulai di posisi yang sama dengan Asal, dan berlanjut untuk satu stud di arah yang sama.

  ```lua
  local unitRay = mouse.UnitRay
  local origin = mouse.Origin
  -- unitRay.Direction = asal.p
  -- unitRay.Direction ≈ origin.lookVector
  ```

  Untuk posisi `Class.Mouse` di ruang 3D, lihat `Class.Mouse.Hit` .

Mouse.Origin

A `Datatype.CFrame` ditempatkan di `Class.Workspace.CurrentCamera` dan berorientasi pada posisi 3D mouse.

Contoh kode berikut, saat ditempatkan di `StarterPlayerScripts` akan membuat alat di ransel pemain yang, setelah dilengkapi, akan mengubah `Class.BasePart.BrickColor` dari setiap `BasePart` yang diklik pemain.

Objek di ruang 3D yang ditunjuk ke `Class.Mouse|mouse` adalah menunjuk ke.

  Catatan:

  *   Jika `Class.Mouse.TargetFilter` telah ditetapkan, filter target dan keturunannya akan diabaikan.
  *   Ketika mouse tidak menunjuk pada `Class.BasePart`, misalnya ketika menunjuk ke langit, Target akan menjadi `nil` .
  *   Pengembang yang mencari posisi mouse di ruang 3D harus menggunakan `Class.Mouse.Hit` .

Mouse.Target

Objek di ruang 3D yang ditunjuk ke `Class.Mouse|mouse` adalah menunjuk ke.

Properti ini menentukan objek yang diabaikan oleh mouse saat menghitung `Class.Mouse.Hit` dan `Class.Mouse.Target` .Keturunan objek juga diabaikan, sehingga mungkin untuk mengabaikan beberapa objek selama mereka adalah keturunan dari objek ke mana properti ini ditetapkan.Properti ini berguna saat menyaring model yang berisi efek khusus atau dekorasi yang tidak boleh mempengaruhi `Class.Mouse.Hit` atau `Class.Mouse.Target` .

  Properti ini dapat ditetapkan ke `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 keturunannya) untuk diabaikan saat menentukan `Class.Mouse.Hit` dan `Class.Mouse.Target` .

The code in this sample, when placed in a `LocalScript` inside
`StarterPlayerScripts` will set the surface of any `BasePart` clicked on to a
random surface.

Properti ini menunjukkan `Enum.NormalId` permukaan `Class.BasePart` di mana mouse ditujukan.Properti ini berasal dari posisi dunia mouse ( `Class.Mouse.Hit` ) dan bagian yang dituju oleh mouse ( `Class.Mouse.Target` ).

  Properti ini tidak berarti ketika mouse tidak menunjuk ke bagian, misalnya ketika mouse menunjuk ke langit.Saat ini, properti ini diatur ke 'Kanan' dalam kondisi ini.Sebelum menggunakan properti ini, periksa apakah target mouse tidak `nil` .

  ```lua
  local Players = game:GetService("Players")
  local player = Players.LocalPlayer
  local mouse = player:GetMouse()
  -- Periksa apakah ada bagian di mana mouse ditunjuk
  if mouse.Target then
  	print("The mouse is pointing to the " .. mouse.TargetSurface.Name .. " side of " .. mouse.Target.Name)
  else
  	print("The mouse is not pointing at anything.")
  end
  ```

Mouse.TargetSurface

Menunjukkan `Enum.NormalId` permukaan `Class.BasePart` di mana mouse ditujukan.

Properti UnitRay adalah `Datatype.Ray` ditujukan ke posisi mouse di ruang 3D (dijelaskan oleh `Class.Mouse.Hit` ).Asalnya dari `Class.Camera.CFrame|CFrame` dari `Class.Workspace.CurrentCamera` .Seperti semua sinar unit, ia memiliki jarak 1.

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

Mouse.UnitRay

A `Datatype.Ray` ditujukan ke posisi dunia mouse, berasal dari posisi dunia `Class.Workspace.CurrentCamera`.

This code sample shows how you can create a `Datatype.Vector2` representing
the `Mouse` object's position on screen (`Class.Mouse.X|X()` and
`Class.Mouse.Y|Y()`) and the size of the screen itself
(`Class.Mouse.ViewSizeX|ViewSizeX()` and `Class.Mouse.ViewSizeY|ViewSizeY()`).
Using these, you can normalize the position of the mouse on-screen such that
the top-left just under the topbar maps to (0, 0) and the bottom-right maps to
(1, 1). This normalized position is calculated and printed as the mouse moves
using the `Class.Mouse.Move|Move()` event.

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

Mouse.ViewSizeX

Menggambarkan lebar jendela permainan dalam piksel.

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

Mouse.ViewSizeY

Menggambarkan ketinggian jendela permainan dalam piksel.

Saat mendeteksi perubahan posisi mouse di layar, 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` (a `Datatype.Vector3`) dari `Class.InputObject`, bukan menggunakan ini dan properti terkait.

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

  ```lua
  local position = Vector2.new(mouse.X, mouse.Y)
  ```

  Properti ini tidak menembak `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, 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` (a `Datatype.Vector3`) dari `Class.InputObject`, bukan menggunakan ini dan properti terkait.

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

  ```lua
  local position = Vector2.new(mouse.X, mouse.Y)
  ```

  Properti ini tidak menembak `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 layar mouse.

Mouse.hit

Mouse.target

Objek warisan yang berisi anggota 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 langsung membuat objek akar `Instance` , tetapi konstruktor khusus `Datatype.Instance.new()` membuat objek melalui kode, mengambil nama kelas sebagai parameter dan mengembalikan objek yang dibuat.

Demonstrates detecting changes to an instance's ancestry by connecting to the `Class.Instance.AncestryChanged` event.

The ChangingPart's Parent is set to different values overtime. The parent of the part is the part's ancestor, so the `Class.Instance.AncestryChanged` event will fire whenever it changes.

Memicu ketika properti `Class.Instance.Parent` dari objek atau salah satu leluhurnya diubah.

  Acara ini mencakup dua parameter: merujuk pada yang sebenarnya telah diubah, sementara merujuk pada baru kasus ini.

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

Instance.AncestryChanged

child

The `Class.Instance` yang `Class.Instance.Parent` telah diubah.

parent

The new `Class.Instance.Parent` dari `Class.Instance` yang `Class.Instance.Parent` telah diubah.

Memicu ketika properti `Class.Instance.Parent` dari objek atau salah satu leluhurnya diubah.

Peristiwa ini terjadi setiap kali ada atribut yang diubah pada instans, termasuk saat atribut diatur ke `nil` .Nama atribut yang diubah dikirim ke fungsi terhubung.

  Sebagai contoh, potongan kode berikut menghubungkan fungsi `attributeChanged()` ke api setiap kali salah satu atribut bagian berubah:

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

  local part = Workspace.Part

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

  part.AttributeChanged:Connect(attributeChanged)
  ```

  Lihat juga `Class.Instance:GetAttributeChangedSignal()` yang men返ikan peristiwa yang menyala saat atribut tertentu berubah.

Instance.AttributeChanged

attribute

Memicu kebakaran setiap kali atribut diubah pada `Class.Instance`.

This snippet prints the names of objects as they are added to the Workspace:

Api setelah objek diberikan kepada orangtua ini `Class.Instance` .

  Catatan, saat menggunakan fungsi ini pada klien untuk mendeteksi objek yang dibuat oleh server, diperlukan untuk menggunakan `Class.Instance:WaitForChild()` saat mengindeks keturunan objek ini.Ini karena objek dan keturunannnya tidak dijamin untuk mereplikasi dari server ke klien secara bersamaan.Sebagai contoh:

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

  Workspace.ChildAdded:Connect(function(child)
  	-- Use WaitForChild() since descendants may not have replicated yet
  	local head = child:WaitForChild("Head")
  end)
  ```

  Catatan, fungsi ini hanya berfungsi untuk anak-anak langsung dari `Class.Instance` . Untuk fungsi yang menangkap semua keturunan, gunakan `Class.Instance.DescendantAdded` .

  Lihat juga `Class.Instance.ChildRemoved` .

Instance.ChildAdded

The `Class.Instance` yang telah ditambahkan.

Api setelah objek diberikan kepada orangtua ini `Class.Instance` .

This snippet prints the names of objects as they are removed from the
Workspace:

Api setelah anak dihapus dari ini `Class.Instance` .

  Dihapus merujuk pada ketika orangtua objek diubah dari ini `Class.Instance` ke sesuatu yang berbeda dari ini `Class.Instance` .Catatan, acara ini juga akan terjadi saat anak dihancurkan (menggunakan `Class.Instance:Destroy()` ) karena fungsi hancur menetapkan orangtua objek menjadi `nil` .

  Fungsi ini hanya berfungsi untuk anak-anak langsung dari `Class.Instance` . Untuk fungsi yang menangkap semua keturunan, gunakan `Class.Instance.DescendantRemoving` .

  Lihat juga `Class.Instance.ChildAdded` .

Instance.ChildRemoved

Api setelah anak dihapus dari ini `Class.Instance` .

This following example will print the name of any object that is added to the
Workspace:

Peristiwa ini terjadi setelah keturunan ditambahkan ke `Class.Instance`.

  Saat menembak untuk setiap keturunan, membesarkan objek ke `Class.Instance` akan menembakkan peristiwa untuk objek ini dan semua keturunannnya secara individual.

  Jika Anda hanya peduli dengan anak-anak langsung dari , gunakan sebagai gantinya.

  Lihat juga `Class.Instance.DescendantRemoving` .

Instance.DescendantAdded

descendant

Api setelah keturunan ditambahkan ke `Class.Instance` .

The following example prints the name of any descendant as it is being removed
from the Workspace:

Peristiwa ini menembak **segera sebelum** orangtua `Class.Instance` mengubah sehingga instansi **turunan** tidak lagi menjadi turunan.`Class.Instance:Destroy()|Destroy()` mengubah `Class.Instance.Parent|Parent` instansi menjadi `nil` , sehingga memanggil metode itu pada turunan dari orangtua akan menyebabkan peristiwa ini terjadi.

  Karena acara ini menembak **sebelum** penghapusan keturunan, orangtua keturunan tidak akan berubah saat penembakan acara ini.Jika keturunan juga merupakan anak langsung **dari orang tua** , acara ini akan terbakar sebelum `Class.Instance.ChildRemoved`.

  Jika seorang keturunan memiliki anak, acara ini terbakar dengan keturunan terlebih dahulu, diikuti oleh anak-anaknya.

  ##### Peringatan

  Peristiwa ini terjadi dengan objek keturunan yang dihapus.Mencoba untuk mengatur `Class.Instance.Parent|Parent` anak turun ke sesuatu yang lain akan gagal.Di bawah ini adalah contoh yang menunjukkan ini:

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

  Workspace.DescendantRemoving:Connect(function(descendant)
  	-- Do not manipulate the parent of the descendant in this function!
  	-- This event fires BECAUSE the parent was manipulated, and the change hasn't happened yet
  	-- Therefore, it is problematic to change the parent like this:
  	descendant.Parent = game
  end)

  local part = Instance.new("Part")
  part.Parent = Workspace
  part.Parent = nil
  ```

  Lihat juga `Class.Instance.DescendantAdded|DescendantAdded` .

Instance.DescendantRemoving

Api segera sebelum keturunan dari `Class.Instance` dihapuskan.

This sample demonstrates how, when using Immediate signal behavior, an Instance being destroyed remains in place until the connected function yields.

This sample demonstrates how, when using Deferred signal behavior,
an Instance is destroyed before the signal fires.

The `Class.Instance` tidak akan pernah dihapus dari memori saat fungsi terhubung masih menggunakannya.Namun, jika fungsi menghasilkan di titik mana pun, `Class.Instance` dan keturunannnya akan diberikan kepada `nil` .

  Jika properti `Class.Workspace.SignalBehavior` diatur ke `Enum.SignalBehavior.Immediate` , acara ini terbakar segera sebelum `Class.Instance` atau salah satu leluhurnya hancur dengan `Class.Instance:Destroy()` .

  Jika properti `Class.Workspace.SignalBehavior` diatur ke `Enum.SignalBehavior.Deferred` , acara ini akan terjadi di titik penyambungan berikutnya, yang akan terjadi setelah `Class.Instance` atau salah satu leluhurnya hancur dengan `Class.Instance:Destroy()` .

  Dengan perilaku `Enum.SignalBehavior.Deferred|Deferred` , menghubungkan skrip ke acara sendiri `Class.Instance.Destroying` adalah bermasalah, karena skrip akan dihapus sebelum panggilan balasan dapat dilakukan (berarti tidak akan dieksekusi).

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

Instance.Destroying

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

Acara ini terjadi setiap kali properti gaya diubah pada instance, termasuk saat 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("Styled properties changed")
  end

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

Instance.StyledPropertiesChanged

Memicu kapan pun properti gaya diubah pada instans, termasuk saat properti diatur ke `nil` .

Instance.childAdded

Metode ini menerapkan tag ke instansi, tanpa efek jika tag sudah diterapkan.Berhasil menambahkan tag akan menyala sinyal yang dibuat oleh `Class.CollectionService:GetInstanceAddedSignal()` dengan tag yang diberikan.

  ##### Peringatan

  *   Tag instansi yang ditambahkan sisi klien akan dihapus jika server kemudian menambahkan atau menghapus tag pada instansi itu karena server menyalin semua tag bersama-sama dan menghapus tag sebelumnya.

  *   Saat menandai instansi, umumnya beberapa sumber daya digunakan untuk memberikan tag fungsionalnya, misalnya koneksi acara atau tabel.Untuk mencegah kebocoran memori, ide bagus adalah membersihkan ini (putus koneksi, atur ke `nil` , dll.) ketika tidak lagi dibutuhkan untuk tag.Lakukan ini saat menelepon `Class.Instance:RemoveTag()` , menelepon `Class.Instance:Destroy()` , atau dalam fungsi yang terhubung ke sinyal yang dikembalikan oleh `Class.CollectionService:GetInstanceRemovedSignal()` .

Instance:AddTag

Fungsi ini menghancurkan semua anak dan keturunan instansi.

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

  -- Add some sparkles
  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-anak dan keturunan, gunakan `Class.Instance:GetChildren()` atau `Class.Instance:GetDescendants()` untuk melingkar melalui anak-anak / keturunan itu dan pilih apa yang harus dihancurkan.Sebagai contoh, sampel kode berikut akan menghancurkan semua `Class.BasePart|BaseParts` 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

Fungsi ini menghancurkan semua anak instansi.

Demonstrates cloning a model using `Class.Instance:Clone()`.

`Clone()` membuat salinan instansi dan semua keturunannnya, mengabaikan semua instansi yang tidak `Class.Instance.Archivable|Archivable` .Salinan instansi akar dikembalikan oleh metode ini dan `Class.Instance.Parent|Parent` nya diatur ke `nil` .Perhatikan bahwa jika instance itu sendiri memiliki `Class.Instance.Archivable|Archivable` diatur ke `false` , fungsi ini akan kembali `nil` .

  Jika properti referensi seperti `Class.ObjectValue.Value` ditetapkan di instansi yang diklon, nilai properti salinan tergantung pada nilai asli:

  *   Jika properti referensi merujuk pada instansi yang telah **juga** diklon, salinan akan merujuk pada salinan.
  *   Jika properti referensi merujuk ke objek yang tidak **tidak** diklon, nilai yang sama dipertahankan dalam salinan.

Instance:Clone

Buat salinan instansi dan semua keturunannya, mengabaikan instansi yang tidak `Class.Instance.Archivable|Archivable` .

Menunjukkan menghancurkan Suku Cadang menggunakan fungsi `Class.Instance:Destroy()`.

  Fungsi ini adalah cara yang benar untuk menyingkirkan objek yang tidak lagi diperlukan.

Atur properti `Class.Instance.Parent` ke `nil` , mengunci properti `Class.Instance.Parent` , memutus semua koneksi, dan memanggil `Destroy()` pada semua anak.Fungsi ini adalah cara yang benar untuk menyingkirkan objek yang tidak lagi diperlukan.

  Menyingkirkan objek yang tidak diperlukan penting, karena objek dan koneksi yang tidak perlu di tempat menggunakan memori yang dapat menyebabkan masalah kinerja serius seiring waktu.

  Sebagai praktik terbaik setelah memanggil `Destroy()` pada objek, atur variabel apa pun yang merujuk pada objek (atau keturunannnya) ke `nil` .Ini mencegah kode Anda mengakses apa pun yang berhubungan dengan objek.

  ```lua
  local part = Instance.new("Part")
  part.Name = "Hello, world"
  part:Destroy()
  -- Jangan lakukan ini:
  print(part.Name)  --> "Halo, dunia"
  -- Lakukan ini untuk mencegah baris di atas tidak berfungsi:
  part = nil
  ```

  Setelah `Class.Instance` dihancurkan dengan metode ini, tidak dapat digunakan kembali karena properti `Class.Instance.Parent` terkunci.Untuk **sementara** menghapus objek alih-alih menghancurkannya, atur `Class.Instance.Parent|Parent` ke `nil`.Sebagai contoh:

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

  object.Parent = nil
  task.wait(2)
  object.Parent = Workspace
  ```

  Untuk menghancurkan objek setelah jumlah waktu tertentu, gunakan `Class.Debris:AddItem()` .

Instance:Destroy

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

Kembalikan nenek moyang pertama dari `Class.Instance` yang `Class.Instance.Name` sama dengan nama yang diberikan.

  Fungsi ini bekerja ke atas, artinya dimulai pada langsung instansi `Class.Instance.Parent` dan bekerja menuju `Class.DataModel` .Jika tidak ada leluhur yang cocok ditemukan, ia kembalikan `nil` .

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

  ```
  local car = object:FindFirstAncestor("Car")
  ```

  Untuk varian fungsi ini yang menemukan leluhur kelas tertentu, silakan lihat `Class.Instance:FindFirstAncestorOfClass()` dan `Class.Instance:FindFirstAncestorWhichIsA()` .

Instance:FindFirstAncestor

name

Kembalikan nenek moyang pertama dari `Class.Instance` yang `Class.Instance.Name` sama dengan nama yang diberikan.

Kembalikan nenek moyang pertama dari `Class.Instance` yang `Class.Object.ClassName` sama dengan kelas yang diberikan.

  Fungsi ini bekerja ke atas, artinya dimulai pada langsung instansi `Class.Instance.Parent` dan bekerja menuju `Class.DataModel` .Jika tidak ada leluhur yang cocok ditemukan, ia kembalikan `nil` .

  Penggunaan umum dari fungsi ini adalah menemukan `Class.Model` milik `Class.BasePart` . Misalnya:

  ```
  local model = part:FindFirstAncestorOfClass("Model")
  ```

  Fungsi ini adalah variasi dari `Class.Instance:FindFirstAncestor()` yang memeriksa properti `Class.Object.ClassName` bukan `Class.Instance.Name`.`Class.Instance:FindFirstAncestorWhichIsA()` juga ada, menggunakan metode `Class.Object:IsA()` untuk menghormati warisan kelas.

Instance:FindFirstAncestorOfClass

className

The `Class.Object.ClassName` untuk dicari.

Kembalikan nenek moyang pertama dari `Class.Instance` yang `Class.Object.ClassName` sama dengan kelas yang diberikan.

Kembalikan nenek moyang pertama dari `Class.Instance` untuk siapa `Class.Object:IsA()` kembali benar untuk kelas yang diberikan.

  Fungsi ini bekerja ke atas, artinya dimulai pada langsung instansi `Class.Instance.Parent` dan bekerja menuju `Class.DataModel` .Jika tidak ada leluhur yang cocok ditemukan, ia kembalikan `nil` .

  Tidak seperti `Class.Instance:FindFirstAncestorOfClass()` , fungsi ini menggunakan `Class.Object:IsA()` yang menghormati warisan kelas. Misalnya:

  ```
  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 adalah `Class.WedgePart` , `Class.MeshPart` atau `Class.Part` .

  ```
  local part = object:FindFirstAncestorWhichIsA("BasePart")
  ```

  Lihat juga `Class.Instance:FindFirstAncestor()` .

Instance:FindFirstAncestorWhichIsA

Kembalikan nenek moyang pertama dari `Class.Instance` untuk siapa `Class.Object:IsA()` kembali benar untuk kelas yang diberikan.

Yang berikut akan mencari di Workspace untuk nama objek "Brick". Jika ditemukan, itu akan mengubah nama objek menjadi "Foo".

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

  ##### Memeriksa Keberadaan Objek

  `FindFirstChild()` diperlukan jika Anda perlu memverifikasi objek ada sebelum melanjutkan.Mencoba mengindeks anak dengan nama menggunakan operator dot memunculkan kesalahan jika anak tidak ada.

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

  -- Kesalahan baris berikut jika bagian tidak ada di ruang kerja
  Workspace.Part.Transparency = 0.5
  ```

  Pendekatan yang lebih baik adalah menggunakan `FindFirstChild()` untuk memeriksa `Part` terlebih dahulu, lalu gunakan 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 Nya Sesuai dengan Properti

  Terkadang `Class.Instance.Name|Name` dari objek adalah sama dengan properti dari objeknya `Class.Instance.Parent|Parent` .Saat menggunakan operator dot, properti memiliki prioritas lebih tinggi atas anak-anak jika mereka berbagi nama.

  Dalam contoh berikut, `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 anak `Class.Folder` instansi.Manfaat menggunakan `Class.Instance:FindFirstChild()|FindFirstChild()` adalah bahwa pengenalan properti baru tidak memberikan 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  -- Kepemilikan
  local c2 = part:FindFirstChild("Color")  -- The child folder
  ```

  ##### Catatan Kinerja

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

Instance:FindFirstChild

The `Class.Instance.Name` yang harus dicari.

recursive

Apakah pencarian harus dilakukan secara berulang atau tidak.

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

Kembalikan anak pertama dari `Class.Instance` yang `Class.Object.ClassName|ClassName` sama dengan yang diberikan `className` .Tidak seperti `Class.Instance:FindFirstChildWhichIsA()` , fungsi ini hanya mengembalikan objek yang kelasnya cocok dengan `className` , mengabaikan warisan kelas.Jika anak yang cocok tidak ditemukan, fungsi ini akan mengembalikan `nil` .

Instance:FindFirstChildOfClass

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

Kembalikan anak pertama dari `Class.Instance` untuk siapa `Class.Object:IsA()` kembali benar untuk kelas yang diberikan.

  Jika tidak ada anak yang cocok ditemukan, fungsi ini返回 `nil` .Jika argumen recursif opsional benar, fungsi ini mencari semua keturunan daripada hanya anak-anak langsung dari `Class.Instance` .

  Tidak seperti `Class.Instance:FindFirstChildOfClass()` , fungsi ini menggunakan `Class.Object:IsA()` yang menghormati warisan kelas. Misalnya:

  ```lua
  print(part:IsA("Part")) --> benar
  print(part:IsA("BasePart")) --> benar
  print(part:IsA("Instance")) --> true
  ```

  Oleh karena itu, sampel kode berikut akan mengembalikan anak pertama `Class.BasePart` , terlepas dari apakah itu adalah `Class.WedgePart` , `Class.MeshPart` atau `Class.Part` .

  ```
  local part = object:FindFirstChildWhichIsA("BasePart")
  ```

  Pengembang yang mencari anak dengan nama, harus menggunakan `Class.Instance:FindFirstChild()` sebagai gantinya.

Instance:FindFirstChildWhichIsA

The `Class.Object.ClassName` yang harus dicari.

Kembalikan anak pertama dari `Class.Instance` untuk siapa `Class.Object:IsA()` kembali benar untuk kelas yang diberikan.

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

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

Instance:FindFirstDescendant

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

Jika `Class.Instance` adalah `Class.Actor` , maka `Class.Actor` sendiri dikembalikan.Jika tidak, leluhur terdekatnya `Class.Actor` dikembalikan.Jika tidak ada leluhur adalah `Class.Actor` , hasilnya adalah `nil` .

Instance:GetActor

Kembalikan `Class.Actor` yang terkait dengan Instansi, jika ada.

Metode ini mengembalikan nilai yang telah ditugaskan ke nama atribut yang diberikan. Jika tidak ada atribut yang ditugaskan, `nil` dikembalikan.

  Sebagai contoh, potongan kode berikut menetapkan dan kemudian mendapatkan nilai atribut instance `InitialPosition`:

  ```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 men返ikan kamus pasangan kunci-nilai untuk setiap atribut instansi.

Instance:GetAttribute

Nilai yang telah ditugaskan ke nama atribut yang diberikan. Jika tidak ada atribut yang ditugaskan, `nil` dikembalikan.

Kembalikan nilai yang telah ditugaskan ke nama atribut yang diberikan.

Fungsi ini mengembalikan peristiwa yang berperilaku persis seperti peristiwa `Class.Object.Changed|Changed` , kecuali bahwa itu hanya menembak ketika atribut tertentu berubah; secara efektif itu mirip dengan `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()` tetapi untuk atribut.

  Secara umum, ide yang baik adalah menggunakan metode ini alih-alih koneksi ke `Class.Object.Changed|Changed` dengan fungsi yang memeriksa nama atribut.Panggilan berikutnya ke metode ini pada objek yang sama dengan nama atribut yang sama mengembalikan peristiwa yang sama.

  Contoh kode berikut mengembalikan sinyal yang memicu fungsi `attributeChanged()` ketika atribut bagian `InitialPosition` berubah:

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

  Lihat juga `Class.Instance.AttributeChanged` yang menembak setiap kali ada atribut yang diubah pada instans.

Instance:GetAttributeChangedSignal

Nama atribut yang ditentukan untuk mana sinyal perubahan dikembalikan.

Sebuah peristiwa yang menembak ketika atribut yang diberikan berubah.

Kembalikan acara yang terbakar saat atribut yang diberikan berubah.

Metode ini mengembalikan kamus pasangan kunci-nilai untuk setiap atribut di mana kunci adalah nama atribut dan nilainya adalah nilai non-`nil` .

  Sebagai contoh, potongan kode berikut menampilkan atribut dan nilai instansi:

  ```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 men返ikan nilai yang telah ditugaskan ke nama atribut yang diberikan.

Instance:GetAttributes

Kamus pasangan string → varian untuk setiap atribut di mana string adalah nama atribut dan varian adalah nilai non-nol.

The below would print the name of all objects currently in Workspace when ran.

Kembalikan array (tabel berindeks numerik) yang berisi semua anak langsung instansi, atau setiap `Class.Instance` yang `Class.Instance.Parent|Parent` sama dengan objek.배열 dapat diulang saat menggunakan loop for numerik atau umum:

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

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

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

  -- Contoh lop loop umum
  local children = Workspace:GetChildren()
  for i, child in children do
  	print(child.Name .. " is child number " .. i)
  end
  ```

  Anak-anak diurutkan berdasarkan urutan di mana properti `Class.Instance.Parent|Parent` mereka ditetapkan ke objek.

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

Instance:GetChildren

Sebuah array yang berisi anak-anak instansi.

Kembalikan array yang berisi semua anak instansi.

Kembalikan string terkode dari ID debug yang digunakan secara internal oleh Roblox. Perhatikan bahwa:

  *   Item ini dilindungi. Mencoba menggunakannya di `Class.Script` atau `Class.LocalScript` akan menyebabkan kesalahan.
  *   ID debug adalah ID yang digunakan dalam proses debugging.Ini memungkinkan debugger untuk membaca setiap instruksi sebelum aplikasi memprosesnya.Semua objek di Roblox bertindak seperti proses dan setiap instruksi jalankan (atau 'kode') yang dapat di debug jika diperlukan.
  *   Ini bisa membantu untuk plugin yang perlu membedakan objek serupa dari satu sama lain (seperti objek yang berbagi nama yang sama).

Instance:GetDebugId

scopeLength

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

GetDescendants is often used to do something to all the descendants that are a
particular type of object. The code in this example uses GetDescendants and
`Class.Instance:IsA()` to find all of the parts in the workspace and turns
them green.

Metode objek ini mem返回 array yang berisi semua keturunan dari objek itu.Tidak seperti `Class.Instance:GetChildren()` , yang hanya mengembalikan anak-anak langsung dari objek, metode ini menemukan setiap anak dari objek, setiap anak dari anak-anak itu, dan seterusnya.

Instance:GetDescendants

Sebuah array yang berisi keturunan instansi.

Kembalikan array yang berisi semua keturunan instansi.

This code sample demonstrates the behavior of `Class.Instance:GetFullName()`.
It shows how the function behaves when called on an object not in the
`DataModel` hierarchy, and it also shows how the return value does not escape
special characters.

This code sample re-implements the `Class.Instance:GetFullName()` function in
Lua.

Kembalikan string yang menjelaskan leluhur instansi.String adalah koncatenasi dari `Class.Instance.Name|Name` objek dan leluhurnya, dipisahkan oleh periode.The `Class.DataModel` ( `game` ) tidak dipertimbangkan.Sebagai contoh, `Class.Part` di `Class.Workspace` mungkin kembali `Class.Workspace.Part` .

  Ketika dipanggil pada `Class.Instance` yang bukan keturunan dari `Class.DataModel` , fungsi ini mempertimbangkan semua nenek moyang hingga dan termasuk yang paling atas tanpa `Class.Instance.Parent|Parent` .

  Fungsi ini berguna untuk pencatatan dan debugging.Anda tidak boleh mencoba memecahkan string yang dikembalikan untuk operasi yang berguna; fungsi ini tidak melarikan periode (atau simbol lain) dalam nama objek.Dengan kata lain, meskipun outputnya sering tampak menjadi identifikasi Luau yang valid, tidak dijamin.

Instance:GetFullName

Kembalikan string yang menjelaskan leluhur instansi.

Metode ini mengembalikan nilai gaya atau secara eksplisit dimodifikasi dari properti yang ditentukan, atau nilai properti default jika belum ditata/dimodifikasi.Ini berbeda sedikit dari mengakses nilai properti secara langsung, seperti `[GuiObject].Rotation` , yang men返ikan nilai default atau modifikasi properti.

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

  local player = Players.LocalPlayer
  local playerGui = player.PlayerGui
  local HUDContainer = playerGui:WaitForChild("HUDContainer")

  local coreSheet = ReplicatedStorage:FindFirstChild("CoreSheet")
  local rule = coreSheet:FindFirstChildWhichIsA("StyleRule")
  rule.Selector = "TextButton"

  -- Referensi ke tombol
  local button = HUDContainer:FindFirstChildWhichIsA("TextButton")

  print(button:GetStyled("Rotation")) --> 0 (nilai default)
  print(button.Rotation) --> 0 (nilai default)

  -- Terapkan rotasi melalui properti aturan gaya
  rule:SetProperty("Rotation", 30)

  print(button:GetStyled("Rotation")) --> 30 (nilai bergaya berdasarkan aturan)
  print(button.Rotation) --> 0 (nilai default)

  -- Secara eksplisit mengubah/menghapus properti berstyling
  button.Rotation = 45

  print(button:GetStyled("Rotation")) --> 45 (nilai yang dimodifikasi)
  print(button.Rotation) --> 45 (modified value)
  ```

Instance:GetStyled

Nilai bergaya atau secara eksplisit dimodifikasi dari properti yang ditentukan, atau nilai properti default jika belum diubah/dimodifikasi.

Kembalikan nilai bergaya atau secara eksplisit dimodifikasi dari properti yang ditentukan, atau nilai properti default jika belum diberi gaya/dimodifikasi.

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

PlayerMouse

Contoh Kode

Rangkuman

Properti

Metode

Acara

Properti

Metode

Acara