API System.EnableEvent: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	EnableEvent
Allows an event to be fired or removes the ability for an event to fire - this may be nested
- HANDLE	Target
The component that would usually recieve the event
- STRING	MsgName
The quoted class.name formatted name of the event to release
- BOOL	Enable
True to enable the event, false to disable
- NONE	Return

Detailed description

Examples

Calling in a calculation

Add to a calculation icon:

::System.EnableEvent(target, "msgname", false)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Allows an event to be fired or removes the ability for an event to fire - this may be nested
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''EnableEvent'''
+|-
+| colspan="2" | Allows an event to be fired or removes the ability for an event to fire - this may be nested&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Target
+|-
+| colspan="2" | The component that would usually recieve the event&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | MsgName
+|-
+| colspan="2" | The quoted class.name formatted name of the event to release&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Enable
+|-
+| colspan="2" | True to enable the event, false to disable&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-===Class hierarchy===
-:System
-::EnableEvent
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-''[[Variable types|HANDLE]] Target''
-:The component that would usually recieve the event
-''[[Variable types|STRING]] MsgName''
-:The quoted class.name formatted name of the event to release
-''[[Variable types|BOOL]] Enable''
-:True to enable the event, false to disable
-==Return value==
-''This call does not return a value''
-==Detailed description==
-''No additional information''
 ==Examples==
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::System.EnableEvent(target, "msgname", false)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation