API System.Forward: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	Forward
Sends the currently processing message to the target
- HANDLE	Target
The component to forward the current message to
- NONE	Return

Detailed description

This call passes the currently processing event to the Target component. It is useful for components that behave as a redirection component. To perform the reverse action - claiming an event from a component use System.ClaimEvent.

Examples

Calling in a calculation

Add to a calculation icon:
```
::System.Forward(target)
```

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
-<sidebar>API Contents</sidebar>
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-Sends the currently processing message to the target
+| width="90%" class="mtx-class-macrohead" | '''Forward'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Sends the currently processing message to the target&nbsp;
-====Class hierarchy====
+|-
-[[API System|System]]
+|-
-:[[API System|Forward]]
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-</div>
+| width="90%" | Target
-__TOC__
+|-
+| colspan="2" | The component to forward the current message to&nbsp;
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''Target''
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
-:The component to forward the current message to
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-==Return value==
-''This call does not return a value''
 ==Detailed description==
-''<span style="color:red;">No additional information</span>''
+This call passes the currently processing event to the ''Target'' component. It is useful for components that behave as a redirection component. To perform the reverse action - claiming an event from a component use [[API System.ClaimEvent|System.ClaimEvent]].
@@ Line 27: / Line 24: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::System.Forward(target)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation