PluginMouse¶

Supported Class Platform & Data NotCreatable

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.

Description¶

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.

Inheritance¶

Object → Instance → Mouse → PluginMouse

Nova inheritance: Instance → Mouse → PluginMouse

Events¶

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

DragEnter(Objects instances)

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

Roblox reference signature

DragEnter(instances: Instances)

Security: PluginSecurity

Roblox documentation

Inherited members¶

Inherited from Mouse: 21 properties, 36 methods, 18 events. They are documented on the base class page.

Roblox reference: PluginMouse

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.