The code below demonstrates how the PluginMouse object can be obtained and
used in a plugin. To use this code, paste it into a `Script` save that script
to the local Plugins Folder using right click, save to file. The plugins
folder can be found in the Plugins tab in the Roblox Studio toolbar.


PluginMouse.DragEnter

instances

PluginMouse

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/PluginMouse.yaml

插件鼠标对象提供 `Class.Plugin|Plugins` 对鼠标的访问。它与 `Class.Mouse` 对象类似，可以使用插件 `Class.Plugin:GetMouse()` 方法获得。

Class.Actor 是一个可以安全分离为其自己线程的代码容器。

Class

Actor

Luau

Array

物理互动的世界对象的抽象基础类。

BasePart

表示 3D 位置和方向的数据类型。

Data Type

CFrame

Dictionary

NormalId 列表设置哪个零件的哪个面/侧面。

Enum

Enum.NormalId

RBXScriptSignal

代表一个向前无限移动的起始点。

Variant

bool

number

字母、数字和符号等的字符串。

string

void

概览

指南

教程

参考

资源

艺术

设计

引擎

虚拟形象

旧版本

云端

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Beta 测试终点已准备好公开使用。可能出现导致功能无法正常运作的更改，但几率极低。

此字段可能在创建资源时被设置，但可能无法在后续请求中修改。

此字段可以在请求中提供，但永远不会包括在答复中。

每个 API 密钥：每个 IP 地址每 {periodInSeconds} 秒有 {maxInPeriod} 次请求

此字段可能被设置为响应，但在请求中将被忽略。

调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息，请查看 【管理 API 密钥】({apiKeyReferenceDocLink})。

相对于基础 URL 的路径，下列端点是可用的。

此字符串格式为 [FieldMask](/cloud/reference/types#fieldmask)。

JSON 值可以是 “null”、“boolean”、“string”、“number”、“array” 或 “object”。

若要使用此端点，你的 OAuth 2.0 应用程序需要以下范围。关于如何注册 OAuth 2.0 应用程序的更多信息，请查看【应用程序注册及评价】({oauth2ReferenceDocLink})。

下列对象描述了接受或返回的有效载荷。请参阅每个单独的端点，以了解更多关于这些对象用途的信息。

这将允许查看关于你素材的信息。

这将允许在 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 you to manage group join requests for your account.

这将允许查看你的道具栏信息。

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 permission to read group 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 allows sending notifications from your experience to users.

这将允许列出与你的作品相关联的密钥。

这将允许创作和更新与你的作品相关联的密钥。

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

此操作将会允许发布作品的新版本至 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.

PluginMouse

代码示例

概要

属性

方法

活动

属性

方法

活动

DragEnter

参数