API Component.GetInteractive: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetInteractive
Gets whether a component can interact with the mouse
- HANDLE	Target
The component to read the state from
- BOOL	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

Declare a variable 'result' of type BOOL

Add to a calculation icon:

result = ::Component.GetInteractive(target)

@@ Line 1: / Line 1: @@
-API contents
+{| class="mtx-class-macrotable wikitable"
-Gets whether a component can interact with the mouse
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetInteractive'''
+|-
+| colspan="2" | Gets whether a component can interact with the mouse&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Target
+|-
+| colspan="2" | The component to read the state from&nbsp;
+|-
+| 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''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Target''
+An interactive component responds to mouse clicks and other user interface events.
-:The component to read the state from
-:''The default value for this parameter is: '''''this'''
-===Return value===
+If a component is not interactive, it can not be clicked on by the mouse and will be ignored in mouse-click tests.
-[[Variable types|BOOL]]
-No additional information
-===Detailed description===
+==Examples==
-''No additional information''
+===Calling in a calculation===
-===Examples===
-====Calling in a calculation====
 * Declare a variable 'result' of type BOOL
-* Add to a calculation icon: result = ::Component.GetInteractive(target)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetInteractive(target)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation