OnClientCursorMove: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(Replace to predefined variables.)
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category:Incomplete Event]]
{{Client event}}
__NOTOC__
This event is called by the root element whenever the cursor is moved over the screen, by the player. It returns information about the world coordinates as well as the screen coordinates of where the player moved the cursor.


__NOTOC__
The difference between this event and [[onClientMouseMove]], is that the latter is actually called by GUI elements. This is to prevent double calling of onClientCursorMove, as onClientCursorMove is always called.
This event is blahblah and is used for blahblah.


==Syntax==  
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onClientCursorMove ( float cursorX, float cursorY )
float cursorX, float cursorY, int absoluteX, int absoluteY, float worldX, float worldY, float worldZ
</syntaxhighlight>  
</syntaxhighlight>
*'''cursorX:''' the relative X coordinate of the mouse cursor. 0 = left side of the screen, 1 = right side.
*'''cursorY:''' the relative Y coordinate of the mouse cursor. 0 = top of the screen, 1 = bottom.
*'''absoluteX:''' the X coordinate of the mouse cursor, in pixels, measured from the left side of the screen.
*'''absoluteY:''' the Y coordinate of the mouse cursor, in pixels, measured from the top of the screen.
*'''worldX, worldY, worldZ:''' the 3D in-game world coordinates that the cursor is pointing at.


==Example==  
==Source==
This example does...
The source of this event is the root element.
 
==Example==
This example creates a text label at the bottom of the screen which displays the mouse position in pixels.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
addEventHandler( "onClientResourceStart", resourceRoot,
blabhalbalhb --abababa
    function ( )
--This line does this...
        textLabel = guiCreateLabel( 0, .9, 1, .1, "X: -;  Y: -", true );
mooo
        guiLabelSetHorizontalAlign( textLabel, "center" );
    end
);
 
addEventHandler( "onClientCursorMove", root,
    function ( _, _, x, y )
        guiSetText( textLabel, "X: " .. tostring( x ) .. ";  Y: ".. tostring( y ) )
    end
);
</syntaxhighlight>
</syntaxhighlight>
[[pl:onClientCursorMove]]
==See Also==
{{GUI_events}}
===Client event functions===
{{Client_event_functions}}

Latest revision as of 05:58, 12 July 2023

This event is called by the root element whenever the cursor is moved over the screen, by the player. It returns information about the world coordinates as well as the screen coordinates of where the player moved the cursor.

The difference between this event and onClientMouseMove, is that the latter is actually called by GUI elements. This is to prevent double calling of onClientCursorMove, as onClientCursorMove is always called.

Parameters

float cursorX, float cursorY, int absoluteX, int absoluteY, float worldX, float worldY, float worldZ
  • cursorX: the relative X coordinate of the mouse cursor. 0 = left side of the screen, 1 = right side.
  • cursorY: the relative Y coordinate of the mouse cursor. 0 = top of the screen, 1 = bottom.
  • absoluteX: the X coordinate of the mouse cursor, in pixels, measured from the left side of the screen.
  • absoluteY: the Y coordinate of the mouse cursor, in pixels, measured from the top of the screen.
  • worldX, worldY, worldZ: the 3D in-game world coordinates that the cursor is pointing at.

Source

The source of this event is the root element.

Example

This example creates a text label at the bottom of the screen which displays the mouse position in pixels. 

addEventHandler( "onClientResourceStart", resourceRoot,
    function ( )
        textLabel = guiCreateLabel( 0, .9, 1, .1, "X: -;  Y: -", true );
        guiLabelSetHorizontalAlign( textLabel, "center" );
    end
);

addEventHandler( "onClientCursorMove", root,
    function ( _, _, x, y )
        guiSetText( textLabel, "X: " .. tostring( x ) .. ";  Y: ".. tostring( y ) )
    end
);

See Also

Input

GUI


Client event functions



Retrieved from "https://wiki.multitheftauto.com/wiki/OnClientCursorMove?oldid=77164"