Difference between revisions of "API System.ClaimEvent"

Revision as of 11:42, 16 January 2023

	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

No additional information

Add to a calculation icon:

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

No additional examples

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Claims an event message by name, returns true if claimed
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClaimEvent'''
-====Class hierarchy====
+|-
-[[API System|System]]
+| colspan="2" | Claims an event message by name, returns true if claimed&nbsp;
-:[[API System|ClaimEvent]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Target
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''Target''
+| colspan="2" | The component that would usually recieve the event&nbsp;
-:The component that would usually recieve the event
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-[[Variable Types|STRING]] ''MsgName''
+| width="90%" | MsgName
-:The quoted class.name formatted name of the event to claim
+|-
+| colspan="2" | The quoted class.name formatted name of the event to claim&nbsp;
+|-
-==Return value==
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
-[[Variable Types|BOOL]]
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-Returns true if claimed