Jump to content

API Mouse.GetClickSide: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import
No edit summary
Line 1: Line 1:
<sidebar>API Contents</sidebar>
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Gets the side of the component clicked on, 0 to 5
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetClickSide'''
====Class hierarchy====
|-
[[API Mouse|Mouse]]
| colspan="2" | Gets the side of the component clicked on, 0 to 5&nbsp;
:[[API Mouse|GetClickSide]]
|-
</div>
|-
__TOC__
| 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''
==Parameters==
|}
''This function has no parameters''
 
 
==Return value==
[[Variable Types|BYTE]]
 
Returns the side of the component clicked on, 0 to 5





Revision as of 11:41, 16 January 2023

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


Detailed description

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

Face numbers

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).


Examples

Calling in a calculation

  • Declare a variable 'result' of type BYTE
  • Add to a calculation icon:
    result = ::Mouse.GetClickSide()

No additional examples