API Panel.Collision.GetSinglePos: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetSinglePos
Returns the position to move Pos to so it does not collide with Test - null if no collide
- 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
- HANDLE	Return

Detailed description

Examples

Calling in a calculation

Declare a variable 'result' of type HANDLE

Add to a calculation icon:

result = ::Panel.Collision.GetSinglePos(pos, test, moveaxis)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Returns the position to move Pos to so it does not collide with Test - null if no collide
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetSinglePos'''
+|-
+| colspan="2" | Returns the position to move Pos to so it does not collide with Test - null if no collide&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Pos
+|-
+| colspan="2" | A component or position to focus the collision around&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Test
+|-
+| colspan="2" | An object to test collisions with&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | MoveAxis
+|-
+| colspan="2" | The position whose axis will be moved along on collide&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Pos''
-:A component or position to focus the collision around
-''[[Variable types|HANDLE]] Test''
-:An object to test collisions with
-''[[Variable types|HANDLE]] MoveAxis''
-:The position whose axis will be moved along on collide
-:''The default value for this parameter is: '''''0'''
-===Return value===
+==Examples==
-[[Variable types|HANDLE]]
+===Calling in a calculation===
-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)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetSinglePos(pos, test, moveaxis)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation