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
  • Read Only
    Not Replicated
    Read Parallel

    The CFrame of the mouse's position in 3D space.

  • Icon:ContentId
    Read Parallel

    The content ID of the image used as the Mouse icon.

  • Read Only
    Not Replicated
    Read Parallel

    A CFrame positioned at the Workspace.CurrentCamera and oriented toward the mouse's 3D position.

  • Read Only
    Not Replicated
    Read Parallel

    The object in 3D space the mouse is pointing to.

  • Read Parallel

    Determines an object (and its descendants) to be ignored when determining Mouse.Hit and Mouse.Target.

  • Read Only
    Not Replicated
    Read Parallel

    Indicates the Enum.NormalId of the BasePart surface at which the mouse is pointing.

  • Read Only
    Not Replicated
    Read Parallel

    A Ray directed towards the mouse's world position, originating from the Workspace.CurrentCamera world position.

  • Read Only
    Not Replicated
    Read Parallel

    Describes the width of the game window in pixels.

  • Read Only
    Not Replicated
    Read Parallel

    Describes the height of the game window in pixels.

  • Read Only
    Not Replicated
    Read Parallel

    Describes the X (horizontal) component of the mouse's position on the screen.

  • Read Only
    Not Replicated
    Read Parallel

    Describes the Y (vertical) component of the mouse's screen position.

Events

Events inherited from Mouse

Properties

Methods

Events

DragEnter

Plugin Security

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

Parameters

instances: Objects