API Mouse.GetClickSide: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetClickSide
Gets the side of the component clicked on, 0 to 5
- BYTE	Return

This call retrieves the face of the bounding box intersected by the mouse. This is always the closest face to the screen.

The faces of the bounding box are ordered according to the following table:

Each face, when added to the opposite face on the cube, adds up to 5 (so each YZ face = 1 + 4 = 5).

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets the side of the component clicked on, 0 to 7
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetClickSide'''
+|-
+| colspan="2" | Gets the side of the component clicked on, 0 to 5&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-===Class hierarchy===[[API |API ]]
-:[[API Mouse|Mouse]]
-::GetClickSide
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-''This function has no parameters''
+This call retrieves the face of the bounding box intersected by the mouse. This is always the closest face to the screen.
-==Return value==
+[[file:SIMAPI Mouse.GetPosition Faces.svg|thumb|none|Face numbers]]
-[[Variable types|BYTE]]
+The faces of the bounding box are ordered according to the following table:
+{|
+|-
+!Face
+!Position
+|-
+|0
+|XY plane, Z=-1
+|-
+|1
+|YZ plane, X=-1
+|-
+|2
+|XZ plane, Y=-1
+|-
+|3
+|XZ plane, Y=1
+|-
+|4
+|YZ plane, X=1
+|-
+|5
+|XY plane, Z=1
+|}
+Each face, when added to the opposite face on the cube, adds up to 5 (so each YZ face = 1 + 4 = 5).
-Returns the side of the component clicked on, 0 to 7
-==Detailed description==
-''No additional information''
 ==Examples==