API Panel.Collision.GetMultiAxis: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetMultiAxis
Tests whether an object collides with a position
- HANDLE	Pos
A component or position to focus the collision around
- 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.GetMultiAxis(pos, return_x, return_y, return_z, targetspace)

Detecting Collisions

Simple example showing how to detect for collisions between objects on the panel. An object moves back and forth between two fixed objects. Each time the moving object hits a static object it will change it's direction.

Collide

@@ 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" | '''GetMultiAxis'''
+|-
+| 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-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|GetMultiAxis]]
-</div>
-__TOC__
-==Parameters==
-[[Variable Types|HANDLE]] ''Pos''
-:A component or position to focus the collision around
-[[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 46: / Line 46: @@
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetMultiAxis(pos, return_x, return_y, return_z, targetspace)</pre>
-''<span style="color:red;">No additional examples</span>''
+===Detecting Collisions===
+Simple example showing how to detect for collisions between objects on the panel. An object moves back and forth between two fixed objects. Each time the moving object hits a static object it will change it's direction.
+{{Fcfile|Collide.fcfx|Collide}}

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation

Detecting Collisions