Difference between revisions of "API Component.GetSolid"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
(21 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <sidebar>API Contents</sidebar> | |
− | + | Gets whether a component is checked in collision detections | |
− | + | <div style="width:25%; float:right" class="toc"> | |
− | + | ====Class hierarchy==== | |
+ | [[API Component|Component]] | ||
+ | :[[API Component|GetSolid]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''Target'' | |
:The component to read the state from | :The component to read the state from | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
− | |||
− | |||
− | + | ==Return value== | |
+ | [[Variable Types|BOOL]] | ||
+ | |||
+ | Returns true if the operation is a success, else false | ||
+ | |||
− | + | ==Detailed description== | |
− | + | A solid component can collide with other solid objects on the panel. If an object is not solid, it will be ignored in collision tests. | |
− | + | ||
− | + | ==Examples== | |
+ | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
− | * Add to a calculation icon: result = ::Component.GetSolid(target) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetSolid(target)</pre> |
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets whether a component is checked in collision detections
Contents
Parameters
HANDLE Target
- The component to read the state from
- The default value for this parameter is: this
Return value
Returns true if the operation is a success, else false
Detailed description
A solid component can collide with other solid objects on the panel. If an object is not solid, it will be ignored in collision tests.
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Component.GetSolid(target)
No additional examples