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

The following code sample, when placed in `StarterPlayerScripts` will create a
tool in the player's backpack that, once equipped, will change the
`Class.BasePart.BrickColor` of every `BasePart` the player clicks on.


Mouse.Button1Down

The follow example changes the `Class.BasePart.BrickColor` of every `BasePart`
the player clicks and releases their mouse on.

In order for a part to change color, the player's mouse must be over the part
both when the player presses their left mouse button down and when the player
releases their left mouse button.


Mouse.Button1Up

Mouse.Button2Down

The follow example changes the `Class.BasePart.BrickColor` of every `BasePart`
the player clicks and releases their right mouse button on.

In order for a part to change color, the player's mouse must be over the part
both when the player presses their right mouse button down and when the player
releases their right mouse button.


Mouse.Button2Up

This example demonstrates how mouse events are passed during each frame


Mouse.Idle

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


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


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


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.


Mouse.WheelBackward

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.


Mouse.WheelForward

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.


Mouse.Hit

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


Mouse.Icon

Mouse.Origin

Mouse.Target

Mouse.TargetFilter

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.


Mouse.TargetSurface

Mouse.UnitRay

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.


Mouse.ViewSizeX

Mouse.ViewSizeY

Mouse.X

Mouse.Y

Mouse.hit

Mouse.target

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.


Instance.AncestryChanged

child

parent

Instance.AttributeChanged

attribute

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


Instance.ChildAdded

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


Instance.ChildRemoved

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


Instance.DescendantAdded

descendant

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


Instance.DescendantRemoving

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.


Instance.Destroying

Instance.childAdded

Instance:AddTag

This example creates a Part and adds a few sparkle objects to the part. Then
it calls Part:ClearAllChildren() to remove all of the children.


Instance:ClearAllChildren

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

Instance:Clone

Demonstrates destroying a Part using the `Class.Instance:Destroy()` function.

This function is the correct way to dispose of objects that are no longer required.


Instance:Destroy

Instance:FindFirstAncestor

name

Instance:FindFirstAncestorOfClass

className

Instance:FindFirstAncestorWhichIsA

The below would look in Workspace for an object name "Brick". If found, it
will change the name of the object to "Foo".


Instance:FindFirstChild

recursive

Instance:FindFirstChildOfClass

Instance:FindFirstChildWhichIsA

Instance:FindFirstDescendant

Instance:GetActor

Instance:GetAttribute

Instance:GetAttributeChangedSignal

Instance:GetAttributes

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


Instance:GetChildren

Instance:GetDebugId

scopeLength

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.


Instance:GetDescendants

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.


Instance:GetFullName

Instance:GetStyled

Instance:GetTags

Instance:HasTag

Demonstrates determining if one instance is the ancestor of another using `Class.Instance:IsAncestorOf()`

Workspace and SpawnLocation are ancestors of the SpawnLocation's decal.
Workspace is an ancestor of SpawnLocation.

SpawnLocation and its decal are descendants of Workspace, not ancenstors.
Decal is a descendant to SpawnLocation, not an ancestor.


Instance:IsAncestorOf

Instance:IsDescendantOf

ancestor

The following code demonstrates how a part can be re-added to the DataModel
after being removed:


Instance:Remove

Instance:RemoveTag

Instance:SetAttribute

value

The following code waits for an instance named "Part" to be added to
Workspace.


Instance:WaitForChild

childName

timeOut

Instance:children

Instance:clone

Instance:destroy

Instance:findFirstChild

Instance:getChildren

Instance:isDescendantOf

Instance:remove

Instance

Instance.Archivable

Instance.Capabilities

Instance.Name

Instance.Parent

Instance.RobloxLocked

Instance.Sandboxed

Instance.UniqueId

Instance.archivable

This sample demonstrates the subtleties of the Changed event on normal objects
and "-Value" objects.


This code sample demonstrates the Changed event firing within a parent object.


Object.Changed

property

This code sample demonstrates how to save a value before a changed event fires
on it in order to get more information about a change.


This code sample demonstrates the equivalence of the `Changed` event and event
returned by `GetPropertyChangedSignal`.


Object:GetPropertyChangedSignal

Demonstrates determining the class of Workspace using `Class.Instance:IsA()`

Workspace is of class 'Workspace', so the first statement is true.
Workspace is not of class 'BasePart', so the second statement is false.
Workspace inherits from Instance and therefore is of class 'Instance', so the third statement is true.


Object:IsA

Object:isA

Object

Object.ClassName

Object.className

/reference/engine/classes/PlayerMouse.yaml

PlayerMouse bersikap sama dengan objek `Class.Mouse` yang diperoleh menggunakan `Class.Tool.Equipped` . Kedua PlayerMouse dan `Class.Mouse` adalah API warisan, digantikan oleh 1> Class.UserInputService1> .

Class.Actor adalah wadah untuk kode yang dapat dibagi dengan aman menjadi threadnya sendiri.

Class

Actor

Luau

Array

Kelas dasar abstrak untuk objek di dunia yang berinteraksi secara fisik.

BasePart

Jenis data yang mewakili posisi dan orientasi 3D.

Data Type

CFrame

Dictionary

Daftar NormalId menetapkan sisi / wajah mana dari Bagian yang digunakan.

Enum

Enum.NormalId

Objek yang mengeksekusi fungsi terhubung pada kesempatan tertentu.

RBXScriptSignal

Menyajikan garis dengan titik awal yang bergulir tanpa batas ke arah tertentu.

Variant

Jenis data yang memiliki nilai benar atau salah.

bool

number

Sebuah urutan karakter, seperti huruf, angka, dan simbol.

string

void

Sekilas

Panduan

Tutorial

Referensi

Seni

Desain

Engine

Avatar

Warisan

Cloud

Metode ini tidak sinkron dan menghasilkan sebuah `Operasi`, yang mewakili keadaan operasi saat ini. Operasi tersebut berisi jalur endpoint yang dapat Anda pantau untuk memperoleh respons aktual dan metadata yang relevan. Lihat [dokumentasi]({longRunningOperationsLink}) tentang operasi jangka panjang untuk mengetahui informasi selengkapnya.
            
Bagian berikut menjelaskan objek respons dan metadata yang disediakan saat operasi selesai.

Endpoint beta siap digunakan publik. Perubahan yang menyebabkan kerusakan mungkin terjadi tetapi jarang.

Kolom ini mungkin akan muncul saat resource dibuat, tetapi mungkin tidak akan diubah oleh permintaan berikutnya.

Kolom ini mungkin akan disediakan di permintaan, tetapi tidak akan pernah disertakan di respons.

Per Kunci API: {maxInPeriod} permintaan setiap {periodInSeconds} detik per Alamat IP

Kolom ini mungkin akan muncul di respons, tetapi akan diabaikan di permintaan.

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya
tentang cara membuat kunci yang tepat, lihat [Cara Mengelola Kunci API]({apiKeyReferenceDocLink}).

Endpoint berikut tersedia di jalur relatif terhadap base URL.

String ini diformat sebagai [FieldMask](/cloud/reference/types#fieldmask).

Nilai JSON dapat berupa `null`, `boolean`, `string`, `number`, `array`, atau `object`.

Cakupan berikut diperlukan agar aplikasi OAuth 2.0 dapat menggunakan endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara mendaftarkan aplikasi OAuth 2.0, lihat [Pendaftaran dan Review Aplikasi]({oauth2ReferenceDocLink}).

Objek berikut mendeskripsikan muatan yang diterima atau diberikan. Lihat masing-masing endpoint untuk mengetahui informasi selengkapnya tentang waktu penggunaan objek ini.

String ini diformat sebagai [Timestamp](/cloud/reference/types#timestamp).

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows viewing information about your communities.

This allows you to manage community join requests and role updates for your account.

This allows viewing information about your inventory.

Grants access to mange your badges and spend robux.

Grants access to manage your developer products.

Grants access to read information about the experiences you follow.

Grants access to follow and unfollow experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

Grants the ability to read user's premium and verified status.

This allows you to view a user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.

PlayerMouse

Contoh Kode

Rangkuman

Properti

Metode

Acara

Properti

Metode

Acara