Difference between revisions of "API Panel.Collision.GetMultiPos"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<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
  
Line 11: Line 11:
  
 
==Parameters==
 
==Parameters==
[[Variable types|HANDLE]] ''Pos''
+
[[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''
+
[[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'''
Line 20: Line 20:
  
 
==Return value==
 
==Return value==
[[Variable types|HANDLE]]
+
[[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
Line 34: Line 34:
 
* 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 information</span>''
+
''<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

Class hierarchy

Panel

Collision
GetMultiPos

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

HANDLE

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