API Panel.Collision.GetSingleAxis: Difference between revisions
XML Import to change Variable types into Variable Types |
XML import of updated API docs |
||
| 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 | ||
| Line 49: | Line 51: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)</pre> | ||
''<span style="color:red;">No additional | ''<span style="color:red;">No additional examples</span>'' | ||
Revision as of 09:58, 17 June 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
- 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
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