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

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
(XML import of API documentation)
Line 1: Line 1:
  
  
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Tests whether an object collides with a position
 
Tests whether an object collides with a position
  

Revision as of 14:27, 9 August 2013


<sidebar>API Contents</sidebar> Tests whether an object collides with a position

Class hierarchy

Panel

Collision
GetSingleAxis

Parameters

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
This parameter is returned back to the caller

FLOAT Y

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

FLOAT Z

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

HANDLE TargetSpace

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


Return value

BOOL

Returns true if the operation is a success, else false


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)

No additional examples