Difference between revisions of "API Panel.Collision.TestSingle"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
(10 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Tests whether an object collides with a position | Tests whether an object collides with a position | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
− | ===Class hierarchy=== | + | ====Class hierarchy==== |
− | + | [[API Panel|Panel]] | |
− | : | + | :[[API Panel.Collision|Collision]] |
− | :: | + | ::[[API Panel.Collision|TestSingle]] |
</div> | </div> | ||
__TOC__ | __TOC__ | ||
==Parameters== | ==Parameters== | ||
− | + | [[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'' | |
:An object to test collisions with | :An object to test collisions with | ||
+ | |||
==Return value== | ==Return value== | ||
− | [[Variable | + | [[Variable Types|BOOL]] |
+ | |||
+ | Returns true if the operation is a success, else false | ||
− | |||
==Detailed description== | ==Detailed description== | ||
− | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
+ | |||
==Examples== | ==Examples== | ||
Line 29: | 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 examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Tests whether an object collides with a position
Contents
Parameters
HANDLE Pos
- A component or position to focus the collision around
HANDLE Test
- An object to test collisions with
Return value
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 examples