Difference between revisions of "API Panel.Collision.GetSinglePos"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
Returns the position to move Pos to so it does not collide with Test - null if no collide | Returns the position to move Pos to so it does not collide with Test - null if no collide | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Panel|Panel]] | ||
| + | :[[API Panel.Collision|Collision]] | ||
| + | ::[[API Panel.Collision|GetSinglePos]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==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|HANDLE]] ''MoveAxis'' | |
:The position whose axis will be moved along on collide | :The position whose axis will be moved along on collide | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| − | + | ||
| − | [[Variable | + | ==Return value== |
| + | [[Variable Types|HANDLE]] | ||
Returns the position to move Pos to so it does not collide with Test - null if no collide | Returns the position to move Pos to so it does not collide with Test - null if no collide | ||
| − | |||
| − | |||
| − | ===Examples | + | ==Detailed description== |
| − | + | ''<span style="color:red;">No additional information</span>'' | |
| + | |||
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
| − | * Add to a calculation icon: result = ::Panel.Collision.GetSinglePos(pos, test, moveaxis) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetSinglePos(pos, test, moveaxis)</pre> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Returns the position to move Pos to so it does not collide with Test - null if no collide
Contents
Parameters
HANDLE Pos
- A component or position to focus the collision around
HANDLE Test
- An object to test collisions with
HANDLE MoveAxis
- The position whose axis will be moved along on collide
- The default value for this parameter is: 0
Return value
Returns the position to move Pos to so it does not collide with Test - null if no collide
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Panel.Collision.GetSinglePos(pos, test, moveaxis)
No additional examples
