Jump to content

API Component.GetSolid: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import
No edit summary
Line 1: Line 1:
<sidebar>API Contents</sidebar>
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Gets whether a component is checked in collision detections
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetSolid'''
====Class hierarchy====
|-
[[API Component|Component]]
| colspan="2" | Gets whether a component is checked in collision detections&nbsp;
:[[API Component|GetSolid]]
|-
</div>
|-
__TOC__
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" | Target
==Parameters==
|-
[[Variable Types|HANDLE]] ''Target''
| colspan="2" | The component to read the state from&nbsp;
:The component to read the state from
|-
:''The default value for this parameter is: '''''this'''
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
==Return value==
[[Variable Types|BOOL]]
 
Returns true if the operation is a success, else false





Revision as of 11:41, 16 January 2023

GetSolid
Gets whether a component is checked in collision detections 
- HANDLE Target
The component to read the state from 
- BOOL Return


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