API Mouse.GetPosition2D: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetPosition2D
Gets the X/Y position of the mouse in screen coords
- LONG	X
Pixel screen coordinate from the left of the panel area
- LONG	Y
Pixel screen coordinate from the top of the panel area
- NONE	Return

Detailed description

This gets the X/Y position in screen units relative to the top left corner of the panel the mouse is over. If the mouse is not over a panel the last known position is used.

Note that the coordinates returned from this call are not 3D coordinates.

Examples

Calling in a calculation

Declare a variable 'result' of type HANDLE

Add to a calculation icon:

result = ::Mouse.GetPosition2D(return_x, return_y)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets the X/Y position of the mouse in screen coords
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetPosition2D'''
+|-
+| colspan="2" | Gets the X/Y position of the mouse in screen coords&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | X
+|-
+| colspan="2" | Pixel screen coordinate from the left of the panel area&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | Y
+|-
+| colspan="2" | Pixel screen coordinate from the top of the panel area&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Mouse|Mouse]]
-:[[API Mouse|GetPosition2D]]
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-[[Variable types|LONG]] ''X''
+This gets the X/Y position in screen units relative to the top left corner of the panel the mouse is over. If the mouse is not over a panel the last known position is used.
-:''This parameter is returned back to the caller''
-:Pixel screen coordinate from the left of the panel area
-[[Variable types|LONG]] ''Y''
-:''This parameter is returned back to the caller''
-:Pixel screen coordinate from the top of the panel area
-==Return value==
+Note that the coordinates returned from this call are ''not'' 3D coordinates.
-[[Variable types|HANDLE]]
-Returns the X/Y position of the mouse in screen coords
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 31: / Line 33: @@
 * Declare a variable 'result' of type HANDLE
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetPosition2D(return_x, return_y)</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation