API Panel.Collision.GetSingleAxis: Difference between revisions

Revision as of 16:23, 11 May 2013

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

Panel

Collision

GetSingleAxis

A component or position to focus the collision around

HANDLE Test

An object to test collisions with

This parameter is returned back to the caller

Local or world-space X to return

This parameter is returned back to the caller

Local or world-space Y to return

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

No additional information

No additional information

Add to a calculation icon:

result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)

@@ Line 2: / Line 2: @@
 Tests whether an object collides with a position
+<div style="width:25%; float:right" class="toc">
+===Class hierarchy===
+:Panel
+::Collision
+:::GetSingleAxis
+</div>
+__TOC__
-===Parameters===
+==Parameters==
 ''[[Variable types|HANDLE]] Pos''
 :A component or position to focus the collision around
@@ Line 26: / Line 33: @@
 :''The default value for this parameter is: '''''0'''
-===Return value===
+==Return value==
 [[Variable types|BOOL]]
 No additional information
-===Detailed description===
+==Detailed description==
 ''No additional information''
-===Examples===
+==Examples==
-====Calling in a calculation====
+===Calling in a calculation===
 * Declare a variable 'result' of type BOOL
-* Add to a calculation icon: <pre class="brush:[C]">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>