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

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import API auto-gen)
Line 1: Line 1:
 
wiki page name
 
wiki page name
==Panel.CollisionGetSingleAxis==
+
Tests whether an object collides with a position
  
Tests whether an object collides with a position
 
----
 
  
 
===Parameters===
 
===Parameters===
Line 37: Line 35:
  
 
===Examples===
 
===Examples===
====Calling in a calculation:====
+
====Calling in a calculation====
 
* Declare a variable 'result' of type BOOL
 
* 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)
 
* Add to a calculation icon: result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)

Revision as of 15:34, 10 May 2013

wiki page name Tests whether an object collides with a position


Parameters

HANDLE Pos

A component or position to focus the collision around

HANDLE Test

An object to test collisions with

FLOAT X

This parameter is returned back to the caller
Local or world-space X to return

FLOAT Y

This parameter is returned back to the caller
Local or world-space Y to return

FLOAT Z

This parameter is returned back to the caller
Local or world-space Z to return

HANDLE TargetSpace

The target space to calculate X,Y,Z in
The default value for this parameter is: 0

Return value

BOOL

No additional information

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.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)