PluginMouse
Show Deprecated
Not Creatable
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
PluginMouse Get
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 Mouse
Properties inherited from Instance
Methods
Methods inherited from Instance
Events
Fired when Instances are being selected while the mouse is dragging.
Events inherited from Mouse
Events inherited from Instance
Properties
Properties inherited from Mouse
Properties inherited from Instance
Methods
Methods inherited from Instance
Events
DragEnter
Plugin Security
Fired when Instances are being selected while the mouse is dragging.
Parameters
Events inherited from Mouse
Events inherited from Instance