PluginMouse

Inherits from: Mouse → Instance → Object

The PluginMouse object gives Plugins access to the mouse. It works like the Mouse object and can be obtained using the plugin Plugin:GetMouse() method.

Note the PluginMouse can only be used when the plugin has been activated using Plugin:Activate().

In addition to the functions from the Mouse object, the PluginMouse includes the PluginMouse.DragEnter function which keeps track of items being selected while the mouse is dragging.

For more information on how to use mouse objects, see the Mouse page.

Inherits from: Mouse

Memory category: Instances

Tags: NotCreatable

Code samples: View on Creator Hub (PluginMouse-Get).

Events

Name	Type / Returns	Description
PluginMouse.DragEnter		Fired when Instances are being selected while the mouse is dragging.

Inherited from Mouse

Name	Type / Returns	Description
Mouse.Button1Down		Fires when the left mouse button is pressed.
Mouse.Button1Up		Fires when the left mouse button is released.
Mouse.Button2Down		Fires when the right mouse button is pressed.
Mouse.Button2Up		Fired when the right mouse button is released.
Mouse.Idle		Fired during every heartbeat that the mouse isn't being passed to another mouse event.
Mouse.KeyDown		Fires when a Key is pressed.
Mouse.keyDown
Mouse.KeyUp		Fires when a Key is released.
Mouse.Move		Fired when the mouse is moved.
Mouse.WheelBackward		Fires when the mouse wheel is scrolled backwards.
Mouse.WheelForward		Fires when the mouse wheel is scrolled forwards.

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.

PluginMouse.DragEnter

Fired when Instances are being selected while the mouse is dragging.

Parameters

Name	Type	Default	Description
instances	Instances		An array of the `Instances` that were inserted into the 3D viewport by the drag-and-drop operation.

Field	Value
security	PluginSecurity
capabilities	["Input"]

Properties

Inherited from Mouse

Name	Type / Returns	Description
Mouse.Hit	CFrame	The `CFrame` of the mouse's position in 3D space.
Mouse.hit	CFrame
Mouse.Icon	ContentId	The content ID of the image used as the `Mouse` icon.
Mouse.IconContent	Content	The content of the image used as the `Mouse` icon. Only supports asset URIs.
Mouse.Origin	CFrame	A `CFrame` positioned at the `Workspace.CurrentCamera` and oriented toward the mouse's 3D position.
Mouse.Target	BasePart	The object in 3D space the `mouse` is pointing to.
Mouse.target	BasePart
Mouse.TargetFilter	Instance	Determines an object (and its descendants) to be ignored when determining `Mouse.Hit` and `Mouse.Target`.
Mouse.TargetSurface	NormalId	Indicates the `NormalId` of the `BasePart` surface at which the mouse is pointing.
Mouse.UnitRay	Ray	A `Ray` directed towards the mouse's world position, originating from the `Workspace.CurrentCamera` world position.
Mouse.ViewSizeX	int	Describes the width of the game window in pixels.
Mouse.ViewSizeY	int	Describes the height of the game window in pixels.
Mouse.X	int	Describes the X (horizontal) component of the mouse's position on the screen.
Mouse.Y	int	Describes the Y (vertical) component of the mouse's screen position.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

Methods

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean