Difference between revisions of "API Panel.Collision.GetMultiPos"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Returns the position to move Pos to so it does not collide with any other object - null if no collide | Returns the position to move Pos to so it does not collide with any other object - null if no collide | ||
<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|GetMultiPos]] | |
</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]] ''MoveAxis'' | |
:Contains the axis to move along on a collision | :Contains the axis to move along on a collision | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| + | |||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] |
Returns the position to move Pos to so it does not collide with any other object - null if no collide | Returns the position to move Pos to so it does not collide with any other object - null if no collide | ||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 30: | Line 33: | ||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetMultiPos(pos, moveaxis)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetMultiPos(pos, 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 any other object - null if no collide
Contents
Parameters
HANDLE Pos
- A component or position to focus the collision around
HANDLE MoveAxis
- Contains the axis to move along on a collision
- The default value for this parameter is: 0
Return value
Returns the position to move Pos to so it does not collide with any other object - 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.GetMultiPos(pos, moveaxis)
No additional examples
