ReturnObject and ReturnInfoObject (Daemon subroutines): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Syntax terms) |
||
| Line 13: | Line 13: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%(Daemon)</th> | <tr><th>%(Daemon)</th> | ||
<td>The class name in parentheses denotes a shared method. | <td>The class name in parentheses denotes a shared method. <var>ReturnObject</var> and <var>ReturnInfoObject</var> can also be invoked via a <var>Daemon</var> object variable, which may be null.</td></tr> | ||
<tr><th>%outputObj</th> | <tr><th>%outputObj</th> | ||
<td>The object returned from the daemon method object in the last Run method invocation. '''%outputObj''' must be deep copyable, as described in [[Copying objects]].</td></tr> | <td>The object returned from the daemon method object in the last Run method invocation. '''%outputObj''' must be deep copyable, as described in [[Copying objects]].</td></tr> | ||
Revision as of 21:18, 1 March 2011
Specify objects returned to the master thread (Daemon class)
ReturnObject is a member of the Daemon class
These shared methods specify the output objects to be returned to the master thread. The difference between ReturnObject and ReturnInfoObject is that the former returns the value of the (unnamed) third argument of the Run function, while the latter returns the value of the named Info object of the Run function.
The ReturnInfoObject method was added in Sirius Mods Version 6.8.
Syntax
%(Daemon):ReturnObject( outputObj)
%(Daemon):ReturnInfoObject( outputObj)
Syntax terms
| %(Daemon) | The class name in parentheses denotes a shared method. ReturnObject and ReturnInfoObject can also be invoked via a Daemon object variable, which may be null. |
|---|---|
| %outputObj | The object returned from the daemon method object in the last Run method invocation. %outputObj must be deep copyable, as described in Copying objects. |
Usage notes
- ReturnObject and ReturnInfoObject can only be issued on daemon threads.
- You can invoke ReturnObject and ReturnInfoObject as many times as you want for a single Run call. Each subsequent invocation replaces the object from the previous invocation of the same method.
- You can invoke ReturnObject even if Run has no output parameter, and you can invoke ReturninfoObject even if Run has no Info parameter. However, a class mismatch between the ReturnObject argument and the output argument in Run, or between the ReturnInfoObject argument and the Info argument in Run, causes request cancellation in the master thread at the time the daemon finishes and Run is about to return.