GuiMouseLeftDown

Constructor:

GuiMouseLeftDown(mousePosition.x, mousePosition.y)

Description

This event is triggered when the left mouse button is pressed on the GUI object.

Parameters

Name Type Description
mousePosition.x float X-coordinate of the mouse
mousePosition.y float Y-coordinate of the mouse

Examples

Add the following client script under ClientfirstLogic. Start the game, and left-click on the UiPanel and the UiButton. Observe whether the event is triggered or not.

wait(1)
local uipanel = RWObject.Create("UiPanel") -- create a UiPanel
local uibtn = RWObject.Create("UiButton") -- create a UiButton
uibtn.Parent = uipanel -- set the parent of the created UiButton to the new created UiPanel
local person = Players:GetLocalPlayer() -- retrieve the player
uipanel.Parent = person. GameUI -- Set the parent of the UiPanel as GameUI
uibtn.GuiMouseLeftDown:Connect(function(x,y) -- click the UiButton to trigger the event of mouse left-clicking
    print("The button is left-clicked on the mouse".." x-coordinate:" ..x.." y-coordinate:" ..y)
end)
uipanel.GuiMouseLeftDown:Connect(function(x,y) -- click the UiPanel to trigger the event of mouse left-clicking
    print("The interface is left-clicked on the mouse".." x-coordinate:" ..x.." y-coordinate:" ..y)
end)