OnClientMouseEnter: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: {{Client event}} __NOTOC__ This event is fired when the user moves the mouse over a GUI element. ==Parameters== <syntaxhighlight lang="lua"> int absoluteX, int absoluteY </syntaxhighlight> * '''absoluteX''': t...)
 
 
(7 intermediate revisions by 5 users not shown)
Line 5: Line 5:
==Parameters==  
==Parameters==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int absoluteX, int absoluteY
int absoluteX, int absoluteY, element leftGUI
</syntaxhighlight>  
</syntaxhighlight>  
* '''absoluteX''':  the X position of the mouse cursor, in pixels, measured from the left side of the screen.
* '''absoluteX''':  the X position of the mouse cursor, in pixels, measured from the left side of the screen.
* '''absoluteY''':  the Y position of the mouse cursor, in pixels, measured from the top of the screen.
* '''absoluteY''':  the Y position of the mouse cursor, in pixels, measured from the top of the screen.
* '''leftGUI''': the gui element that was switched from, or ''nil'' if it doesn't exist.
==Source==
==Source==
The [[event system#Event source|source]] of this event is the GUI element that was pointed at.
The [[event system#Event source|source]] of this event is the GUI element that was pointed at.
Line 15: Line 17:
This example shows a message when you move over a GUI element.
This example shows a message when you move over a GUI element.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler('onClientMouseEnter', getRootElement(), function(aX, aY)
addEventHandler( "onClientMouseEnter", root,  
    outputChatBox("You're pointing at a GUI element at (" .. tostring(aX) .. ', ' .. tostring(aY) .. ')')
    function(aX, aY)
end)
        outputChatBox( "You're pointing at a GUI element at ("..tostring(aX)..", "..tostring(aY)..")")
    end
)
</syntaxhighlight>
</syntaxhighlight>
[[pl:onClientMouseEnter]]


==See Also==
==See Also==
===GUI events===
{{GUI_events}}
{{GUI_events}}
===Client event functions===
===Client event functions===
{{Client_event_functions}}
{{Client_event_functions}}

Latest revision as of 12:50, 27 October 2023

This event is fired when the user moves the mouse over a GUI element.

Parameters

int absoluteX, int absoluteY, element leftGUI
  • absoluteX: the X position of the mouse cursor, in pixels, measured from the left side of the screen.
  • absoluteY: the Y position of the mouse cursor, in pixels, measured from the top of the screen.
  • leftGUI: the gui element that was switched from, or nil if it doesn't exist.

Source

The source of this event is the GUI element that was pointed at.

Example

This example shows a message when you move over a GUI element.

addEventHandler( "onClientMouseEnter", root, 
    function(aX, aY)
        outputChatBox( "You're pointing at a GUI element at ("..tostring(aX)..", "..tostring(aY)..")")
    end
)

See Also

Input

GUI


Client event functions