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

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML Import to change Variable types into Variable Types)
Line 11: 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
  
  
 
==Return value==
 
==Return value==
[[Variable types|BOOL]]
+
[[Variable Types|BOOL]]
  
 
Returns true if the operation is a success, else false
 
Returns true if the operation is a success, else false

Revision as of 11:09, 10 June 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

Returns true if the operation is a success, else false


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