API Panel.Collision.GetSingleAxis: Difference between revisions
XML import API auto-gen |
XML import of API auto-gen |
||
| Line 37: | Line 37: | ||
====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: <pre class="brush:[C]">result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)</pre> | ||
Revision as of 15:35, 10 May 2013
<sidebar>API contents</sidebar> 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
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)