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

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
 
(18 intermediate revisions by 4 users not shown)
Line 1: Line 1:
wiki page name
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
==Panel.CollisionGetMultiAxis==
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetMultiAxis'''
 +
|-
 +
| colspan="2" | Tests whether an object collides with a position 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Pos
 +
|-
 +
| colspan="2" | A component or position to focus the collision around 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | Local or world-space X to return 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | Local or world-space Y to return 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Z
 +
|-
 +
| colspan="2" | Local or world-space Z to return 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | TargetSpace
 +
|-
 +
| colspan="2" | The target space to calculate X,Y,Z in 
 +
|-
 +
| 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''
 +
|}
  
Tests whether an object collides with a position
 
----
 
  
===Parameters===
+
==Detailed description==
''[[Variable types|HANDLE]] Pos''
 
:A component or position to focus the collision around
 
  
''[[Variable types|FLOAT]] X''
 
:''This parameter is returned back to the caller''
 
:Local or world-space X to return
 
  
''[[Variable types|FLOAT]] Y''
 
:''This parameter is returned back to the caller''
 
:Local or world-space Y to return
 
  
''[[Variable types|FLOAT]] Z''
+
==Examples==
:''This parameter is returned back to the caller''
+
===Calling in a calculation===
:Local or world-space Z to return
+
* Declare a variable 'result' of type BOOL
 
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetMultiAxis(pos, return_x, return_y, return_z, targetspace)</pre>
''[[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]]
 
  
No additional information
+
===Detecting Collisions===
  
===Detailed description===
+
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.
''No additional information''
 
  
===Examples===
+
{{Fcfile|Collide.fcfx|Collide}}
====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)
 

Latest revision as of 11:55, 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

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