PluginMouse
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.
Code Samples
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.
plugin:Activate(false) -- gain non exclusive access to the mouse
local mouse = plugin:GetMouse()
local function button1Down()
print("Left mouse click")
end
mouse.Button1Down:Connect(button1Down)Summary
Properties
Properties inherited from MouseThe CFrame of the mouse's position in 3D space.
The content ID of the image used as the Mouse icon.
A CFrame positioned at the Workspace.CurrentCamera and oriented toward the mouse's 3D position.
The object in 3D space the mouse is pointing to.
Determines an object (and its descendants) to be ignored when determining Mouse.Hit and Mouse.Target.
Indicates the Enum.NormalId of the BasePart surface at which the mouse is pointing.
A Ray directed towards the mouse's world position, originating from the Workspace.CurrentCamera world position.
Describes the width of the game window in pixels.
Describes the height of the game window in pixels.
Describes the X (horizontal) component of the mouse's position on the screen.
Describes the Y (vertical) component of the mouse's screen position.
Events
Fired when Instances are being selected while the mouse is dragging.
Fires when the left mouse button is pressed.
Fires when the left mouse button is released.
Fires when the right mouse button is pressed.
Fired when the right mouse button is released.
Fired during every heartbeat that the mouse isn't being passed to another mouse event.
Fired when the mouse is moved.
Fires when the mouse wheel is scrolled backwards.
Fires when the mouse wheel is scrolled forwards.
Properties
Methods
Events
DragEnter
Fired when Instances are being selected while the mouse is dragging.