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

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 18: Line 18:
  
 
[[Variable types|FLOAT]] ''X''
 
[[Variable types|FLOAT]] ''X''
 +
:Local or world-space X to return
 
:''This parameter is returned back to the caller''
 
:''This parameter is returned back to the caller''
:Local or world-space X to return
 
  
 
[[Variable types|FLOAT]] ''Y''
 
[[Variable types|FLOAT]] ''Y''
 +
:Local or world-space Y to return
 
:''This parameter is returned back to the caller''
 
:''This parameter is returned back to the caller''
:Local or world-space Y to return
 
  
 
[[Variable types|FLOAT]] ''Z''
 
[[Variable types|FLOAT]] ''Z''
 +
:Local or world-space Z to return
 
:''This parameter is returned back to the caller''
 
:''This parameter is returned back to the caller''
:Local or world-space Z to return
 
  
 
[[Variable types|HANDLE]] ''TargetSpace''
 
[[Variable types|HANDLE]] ''TargetSpace''
 
:The target space to calculate X,Y,Z in
 
:The target space to calculate X,Y,Z in
 
:''The default value for this parameter is: '''''0'''
 
:''The default value for this parameter is: '''''0'''
 +
  
 
==Return value==
 
==Return value==
Line 37: Line 38:
  
 
''<span style="color:red;">No additional information</span>''
 
''<span style="color:red;">No additional information</span>''
 
  
  

Revision as of 01:53, 12 May 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

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)

No additional information