API Panel.Collision.TestTable: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Tests whether an object collides with the table top, returns Z distance to move to rest on the table | Tests whether an object collides with the table top, returns Z distance to move to rest on the table | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Panel | |||
::Collision | |||
:::TestTable | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] Pos'' | ''[[Variable types|HANDLE]] Pos'' | ||
:A component or position to focus the collision around | :A component or position to focus the collision around | ||
==Return value== | |||
[[Variable types|FLOAT]] | [[Variable types|FLOAT]] | ||
Returns Z distance to move to rest on the table | Returns Z distance to move to rest on the table | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type FLOAT | * Declare a variable 'result' of type FLOAT | ||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.TestTable(pos)</pre> | ||
Revision as of 16:20, 11 May 2013
<sidebar>API contents</sidebar> Tests whether an object collides with the table top, returns Z distance to move to rest on the table
Class hierarchy
- Panel
- Collision
- TestTable
- Collision
Parameters
HANDLE Pos
- A component or position to focus the collision around
Return value
Returns Z distance to move to rest on the table
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type FLOAT
- Add to a calculation icon:
result = ::Panel.Collision.TestTable(pos)