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

From Flowcode Help
Jump to navigationJump to search
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Tests whether an object collides with a position
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetMultiAxis'''
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
| colspan="2" | Tests whether an object collides with a position&nbsp;
:[[API Panel.Collision|Collision]]
+
|-
::[[API Panel.Collision|GetMultiAxis]]
+
|-
</div>
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
__TOC__
+
| width="90%" | Pos
 
+
|-
==Parameters==
+
| colspan="2" | A component or position to focus the collision around&nbsp;
[[Variable Types|HANDLE]] ''Pos''
+
|-
:A component or position to focus the collision around
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
+
| width="90%" | X
[[Variable Types|FLOAT]] ''X''
+
|-
:Local or world-space X to return
+
| colspan="2" | Local or world-space X to return&nbsp;
:''This parameter is returned back to the caller''
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
[[Variable Types|FLOAT]] ''Y''
+
| width="90%" | Y
:Local or world-space Y to return
+
|-
:''This parameter is returned back to the caller''
+
| colspan="2" | Local or world-space Y to return&nbsp;
 
+
|-
[[Variable Types|FLOAT]] ''Z''
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
:Local or world-space Z to return
+
| width="90%" | Z
:''This parameter is returned back to the caller''
+
|-
 
+
| colspan="2" | Local or world-space Z to return&nbsp;
[[Variable Types|HANDLE]] ''TargetSpace''
+
|-
:The target space to calculate X,Y,Z in
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
:''The default value for this parameter is: '''''0'''
+
| width="90%" | TargetSpace
 
+
|-
 
+
| colspan="2" | The target space to calculate X,Y,Z in&nbsp;
==Return value==
+
|-
[[Variable Types|BOOL]]
+
| 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''
Returns true if the operation is a success, else false
+
|}
  
  

Revision as of 11:41, 16 January 2023

Fc9-comp-macro.png GetMultiAxis
Tests whether an object collides with a position 
Fc9-h32-icon.png - HANDLE Pos
A component or position to focus the collision around 
Fc9-f32-icon.png - FLOAT X
Local or world-space X to return 
Fc9-f32-icon.png - FLOAT Y
Local or world-space Y to return 
Fc9-f32-icon.png - FLOAT Z
Local or world-space Z to return 
Fc9-h32-icon.png - HANDLE TargetSpace
The target space to calculate X,Y,Z in 
Fc9-bool-icon.png - BOOL Return


Detailed description

No additional information


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.

FC6 Icon.png Collide