Difference between revisions of "API Component.SetSolid"

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Sets whether a component is checked in collision detections

HANDLE Target

The component to set the state for

The default value for this parameter is: this

BOOL Enabled

True to enable, false to disable

This call does not return a value

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.

No additional examples

@@ Line 1: / Line 1: @@
-wiki page name
+<sidebar>API Contents</sidebar>
-==ComponentSetSolid==
+Sets whether a component is checked in collision detections
-Sets whether a component is checked in collision detections
+<div style="width:25%; float:right" class="toc">
-----
+====Class hierarchy====
+[[API Component|Component]]
+:[[API Component|SetSolid]]
+</div>
+__TOC__
-===Parameters===
+==Parameters==
-''[[Variable types|HANDLE]] Target''
+[[Variable Types|HANDLE]] ''Target''
 :The component to set the state for
 :''The default value for this parameter is: '''''this'''
-''[[Variable types|BOOL]] Enabled''
+[[Variable Types|BOOL]] ''Enabled''
 :True to enable, false to disable
-===Return value===
+==Return value==
 ''This call does not return a value''
-===Detailed description===
-''No additional information''
-===Examples===
+==Detailed description==
-====Calling in a calculation:====
+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.
-* Add to a calculation icon: ::Component.SetSolid(target, true)
+==Examples==
+===Calling in a calculation===
+* Add to a calculation icon: <pre class="brush:[cpp]">::Component.SetSolid(target, true)</pre>
+''<span style="color:red;">No additional examples</span>''