API Panel.Collision.GetSingleAxis: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetSingleAxis
Tests whether an object collides with a position
- HANDLE	Pos
A component or position to focus the collision around
- HANDLE	Test
An object to test collisions with
- FLOAT	X
Local or world-space X to return
- FLOAT	Y
Local or world-space Y to return
- FLOAT	Z
Local or world-space Z to return
- HANDLE	TargetSpace
The target space to calculate X,Y,Z in
- BOOL	Return

Detailed description

Examples

Calling in a calculation

Declare a variable 'result' of type BOOL

Add to a calculation icon:

result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Tests whether an object collides with a position
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetSingleAxis'''
+|-
+| colspan="2" | Tests whether an object collides with a position&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-f32-icon.png]] - FLOAT
+| width="90%" | X
+|-
+| colspan="2" | Local or world-space X to return&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | Y
+|-
+| colspan="2" | Local or world-space Y to return&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | Z
+|-
+| colspan="2" | Local or world-space Z to return&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | TargetSpace
+|-
+| colspan="2" | The target space to calculate X,Y,Z in&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Panel|Panel]]
-:[[API Panel.Collision|Collision]]
-::[[API Panel.Collision|GetSingleAxis]]
-</div>
-__TOC__
-==Parameters==
-[[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|FLOAT]] ''X''
-:Local or world-space X to return
-:''This parameter is returned back to the caller''
-[[Variable types|FLOAT]] ''Y''
-:Local or world-space Y to return
-:''This parameter is returned back to the caller''
-[[Variable types|FLOAT]] ''Z''
-:Local or world-space Z to return
-:''This parameter is returned back to the caller''
-[[Variable types|HANDLE]] ''TargetSpace''
-:The target space to calculate X,Y,Z in
-:''The default value for this parameter is: '''''0'''
-==Return value==
-[[Variable types|BOOL]]
-Returns true if the operation is a success, else false
+==Detailed description==
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 48: / Line 50: @@
 * Declare a variable 'result' of type BOOL
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation