Difference between revisions of "API Panel.Collision.GetSingleAxis"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (9 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===[[API | | + | ====Class hierarchy==== |
| − | :[[API Panel| | + | [[API Panel|Panel]] |
| − | ::[[API Panel.Collision| | + | :[[API Panel.Collision|Collision]] |
| − | + | ::[[API Panel.Collision|GetSingleAxis]] | |
</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 | ||
| − | + | [[Variable Types|FLOAT]] ''X'' | |
| + | :Local or world-space X to return | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
| − | |||
| − | + | [[Variable Types|FLOAT]] ''Y'' | |
| + | :Local or world-space Y to return | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
| − | |||
| − | + | [[Variable Types|FLOAT]] ''Z'' | |
| + | :Local or world-space Z to return | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
| − | |||
| − | + | [[Variable Types|HANDLE]] ''TargetSpace'' | |
:The target space to calculate X,Y,Z in | :The target space to calculate X,Y,Z in | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| + | |||
==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 45: | Line 48: | ||
* 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.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)</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
FLOAT X
- Local or world-space X to return
- This parameter is returned back to the caller
FLOAT Y
- Local or world-space Y to return
- This parameter is returned back to the caller
FLOAT Z
- Local or world-space Z to return
- This parameter is returned back to the caller
HANDLE TargetSpace
- The target space to calculate X,Y,Z in
- The default value for this parameter is: 0
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.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)
No additional examples
