Jump to content

API Panel.Collision.GetSinglePos: 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;"
Returns the position to move Pos to so it does not collide with Test - null if no collide
|-
 
| 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;" | '''GetSinglePos'''
====Class hierarchy====
|-
[[API Panel|Panel]]
| colspan="2" | Returns the position to move Pos to so it does not collide with Test - null if no collide&nbsp;
:[[API Panel.Collision|Collision]]
|-
::[[API Panel.Collision|GetSinglePos]]
|-
</div>
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
__TOC__
| width="90%" | Pos
 
|-
==Parameters==
| colspan="2" | A component or position to focus the collision around&nbsp;
[[Variable Types|HANDLE]] ''Pos''
|-
:A component or position to focus the collision around
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" | Test
[[Variable Types|HANDLE]] ''Test''
|-
:An object to test collisions with
| colspan="2" | An object to test collisions with&nbsp;
 
|-
[[Variable Types|HANDLE]] ''MoveAxis''
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
:The position whose axis will be moved along on collide
| width="90%" | MoveAxis
:''The default value for this parameter is: '''''0'''
|-
 
| colspan="2" | The position whose axis will be moved along on collide&nbsp;
 
|-
==Return value==
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
[[Variable Types|HANDLE]]
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
Returns the position to move Pos to so it does not collide with Test - null if no collide





Revision as of 11:41, 16 January 2023

GetSinglePos
Returns the position to move Pos to so it does not collide with Test - null if no collide 
- HANDLE Pos
A component or position to focus the collision around 
- HANDLE Test
An object to test collisions with 
- HANDLE MoveAxis
The position whose axis will be moved along on collide 
- HANDLE Return


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Panel.Collision.GetSinglePos(pos, test, moveaxis)

No additional examples