API System.ReleaseEvent: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	ReleaseEvent
Releases a previously claimed an event message by name, returns true if released
- HANDLE	Target
The component that would usually recieve the event
- STRING	MsgName
The quoted class.name formatted name of the event to release
- BOOL	Return

Detailed description

Examples

Calling in a calculation

Declare a variable 'result' of type BOOL

Add to a calculation icon:

result = ::System.ReleaseEvent(target, "msgname")

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Releases a previously claimed an event message by name, returns true if released
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''ReleaseEvent'''
+|-
+| colspan="2" | Releases a previously claimed an event message by name, returns true if released&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" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API System|System]]
-:[[API System|ReleaseEvent]]
-</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
-==Return value==
-[[Variable types|BOOL]]
-Returns true if released
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 29: / Line 30: @@
 * Declare a variable 'result' of type BOOL
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ReleaseEvent(target, "msgname")</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation