Difference between revisions of "API Panel.Collision.TestSingle"

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Tests whether an object collides with a position
+
|-
 
+
| 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;" | '''TestSingle'''
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
| colspan="2" | Tests whether an object collides with a position&nbsp;
:[[API Panel.Collision|Collision]]
+
|-
::[[API Panel.Collision|TestSingle]]
+
|-
</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;
 
+
|-
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
==Return value==
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
[[Variable Types|BOOL]]
+
|}
 
 
Returns true if the operation is a success, else false
 
  
  

Revision as of 11:41, 16 January 2023

Fc9-comp-macro.png TestSingle
Tests whether an object collides with a position 
Fc9-h32-icon.png - HANDLE Pos
A component or position to focus the collision around 
Fc9-h32-icon.png - HANDLE Test
An object to test collisions with 
Fc9-bool-icon.png - BOOL Return


Detailed description

No additional information


Examples

Calling in a calculation

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

No additional examples