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

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 3: Line 3:
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API Panel|Panel]]
+
====Class hierarchy====
 +
[[API Panel|Panel]]
 
:[[API Panel.Collision|Collision]]
 
:[[API Panel.Collision|Collision]]
 
::[[API Panel.Collision|TestSingle]]
 
::[[API Panel.Collision|TestSingle]]
Line 10: Line 11:
  
 
==Parameters==
 
==Parameters==
''[[Variable types|HANDLE]] Pos''
+
[[Variable types|HANDLE]] ''Pos''
 
:A component or position to focus the collision around
 
:A component or position to focus the collision around
  
''[[Variable types|HANDLE]] Test''
+
[[Variable types|HANDLE]] ''Test''
 
:An object to test collisions with
 
:An object to test collisions with
  
Line 19: Line 20:
 
[[Variable types|BOOL]]
 
[[Variable types|BOOL]]
  
No additional information
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
Line 28: Line 32:
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.TestSingle(pos, test)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.TestSingle(pos, test)</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:08, 11 May 2013

<sidebar>API contents</sidebar> Tests whether an object collides with a position

Class hierarchy

Panel

Collision
TestSingle

Parameters

HANDLE Pos

A component or position to focus the collision around

HANDLE Test

An object to test collisions with

Return value

BOOL

No additional information


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 information