API System.ClaimEvent: Difference between revisions
m Text replacement - "width="10%" align="center" style="background-color:#D8C9D8;" align="center"" to "width="10%" align="center" class="mtx-class-macrohead"" |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| Line 2: | Line 2: | ||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ClaimEvent''' | ||
|- | |- | ||
| colspan="2" | Claims an event message by name, returns true if claimed | | colspan="2" | Claims an event message by name, returns true if claimed | ||
Latest revision as of 14:11, 13 July 2026
|
ClaimEvent |
| Claims an event message by name, returns true if claimed | |
 - HANDLE
|
Target |
| The component that would usually recieve the event | |
 - STRING
|
MsgName |
| The quoted class.name formatted name of the event to claim | |
 - BOOL
|
Return |
Detailed description
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::System.ClaimEvent(target, "msgname")