API Panel.Collision.GetSingleAxis

From Flowcode Help
Revision as of 21:52, 12 May 2013 by Admin (talk | contribs) (XML import)
Jump to navigationJump to search

<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 information