PluginMouse

Afficher les obsolètes
création impossible

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.

Échantillons de code

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)

Résumé

Propriétés

Propriétés hérités de Mouse
  • Hit:CFrame
    lecture uniquement
    non répliqué
    lecture parallèle

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

  • Icon:Content
    lecture parallèle

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

  • Origin:CFrame
    lecture uniquement
    non répliqué
    lecture parallèle

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

  • Target:BasePart
    lecture uniquement
    non répliqué
    lecture parallèle

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

  • TargetFilter:Instance
    lecture parallèle

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

  • TargetSurface:Enum.NormalId
    lecture uniquement
    non répliqué
    lecture parallèle

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

  • UnitRay:Ray
    lecture uniquement
    non répliqué
    lecture parallèle

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

  • ViewSizeX:number
    lecture uniquement
    non répliqué
    lecture parallèle

    Describes the width of the game window in pixels.

  • ViewSizeY:number
    lecture uniquement
    non répliqué
    lecture parallèle

    Describes the height of the game window in pixels.

  • X:number
    lecture uniquement
    non répliqué
    lecture parallèle

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

  • Y:number
    lecture uniquement
    non répliqué
    lecture parallèle

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

Afficher tous les hérités de Instance

Évènements

Évènements hérités de Mouse
Afficher tous les hérités de Instance

Propriétés

Afficher tous les hérités de Instance

Méthodes

Afficher tous les hérités de Instance

Évènements

DragEnter

sécurité des plugins

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

Paramètres

instances: Objects

Afficher tous les hérités de Instance