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: @@
-<sidebar>API Contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Sends the currently processing message to the target
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" class="mtx-class-macrohead" | '''Forward'''
-====Class hierarchy====
+|-
-[[API System|System]]
+| colspan="2" | Sends the currently processing message to the target&nbsp;
-:[[API System|Forward]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Target
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''Target''
+| colspan="2" | The component to forward the current message to&nbsp;
-:The component to forward the current message to
+|-
+| 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''
-==Return value==
+|}
-''This call does not return a value''
@@ Line 25: / 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