Difference between revisions of "API Panel.Collision.GetSinglePos"
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 | + | [[Variable Types|HANDLE]] ''Pos'' |
:A component or position to focus the collision around | :A component or position to focus the collision around | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''Test'' |
:An object to test collisions with | :An object to test collisions with | ||
| − | [[Variable | + | [[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''' | ||
| Line 23: | Line 23: | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[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 | ||
Revision as of 11:09, 10 June 2013
<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 information
