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

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
wiki page name
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
==Panel.CollisionTestSingle==
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TestSingle'''
 +
|-
 +
| colspan="2" | Tests whether an object collides with a position 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Pos
 +
|-
 +
| colspan="2" | A component or position to focus the collision around 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Test
 +
|-
 +
| colspan="2" | An object to test collisions with 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
Tests whether an object collides with a position
 
−
----
 
  
−
===Parameters===
+
==Detailed description==
−
''[[Variable types|HANDLE]] Pos''
 
−
:A component or position to focus the collision around
 
  
−
''[[Variable types|HANDLE]] Test''
 
−
:An object to test collisions with
 
  
−
===Return value===
 
−
[[Variable types|BOOL]]
 
  
−
No additional information
+
==Examples==
−
 
+
===Calling in a calculation===
−
===Detailed description===
 
−
''No additional information''
 
−
 
 
−
===Examples===
 
−
====Calling in a calculation:====
 
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
−
* Add to a calculation icon: result = ::Panel.Collision.TestSingle(pos, test)
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.TestSingle(pos, test)</pre>

Latest revision as of 11:55, 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

Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon: 
    result = ::Panel.Collision.TestSingle(pos, test)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Panel.Collision.TestSingle&oldid=30208"