API Component.SetInteractive: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetInteractive
Sets whether a component can interact with the mouse
- HANDLE	Target
The component to set the state for
- BOOL	Enabled
True to enable, false to disable
- NONE	Return

Detailed description

An interactive component responds to mouse clicks and other user interface events.

If a component is not interactive, it can not be clicked on by the mouse and will be ignored in mouse-click tests.

Examples

Calling in a calculation

Add to a calculation icon:

::Component.SetInteractive(target, true)

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Sets whether a component can interact with the mouse
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" class="mtx-class-macrohead" | '''SetInteractive'''
-====Class hierarchy====
+|-
-[[API Component|Component]]
+| colspan="2" | Sets whether a component can interact with the mouse&nbsp;
-:[[API Component|SetInteractive]]
+|-
-</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 set the state for&nbsp;
-:The component to set the state for
+|-
-:''The default value for this parameter is: '''''this'''
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Enabled
-[[Variable Types|BOOL]] ''Enabled''
+|-
-:True to enable, false to disable
+| colspan="2" | True to enable, false to disable&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
-==Return value==
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-''This call does not return a value''
+|}
@@ Line 31: / Line 31: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Component.SetInteractive(target, true)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation