Jump to content

API Component.GetSolid: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML Import to change Variable types into Variable Types
JonnyW (talk | contribs)
XML import of updated API docs
Line 1: Line 1:
<sidebar>API contents</sidebar>
<sidebar>API contents</sidebar>
Gets whether a component is checked in collision detections
Gets whether a component is checked in collision detections
Line 30: Line 32:
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetSolid(target)</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetSolid(target)</pre>


''<span style="color:red;">No additional information</span>''
''<span style="color:red;">No additional examples</span>''

Revision as of 09:58, 17 June 2013


<sidebar>API contents</sidebar> Gets whether a component is checked in collision detections

Class hierarchy

Component

GetSolid

Parameters

HANDLE Target

The component to read the state from
The default value for this parameter is: this


Return value

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
  • Add to a calculation icon:
    result = ::Component.GetSolid(target)

No additional examples