GetObject (Subsystem function): Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
m (copied content from PDF and updated to be subsystem only) |
||
| Line 1: | Line 1: | ||
{{Template:Subsystem:GetObject subtitle}} | {{Template:Subsystem:GetObject subtitle}} | ||
The <var>GetObject</var>shared method retrieves a copy of a specified <var>[[Subsystem_class#System-wide_objects|subsystem-wide]]</var> object. | |||
==Syntax== | ==Syntax== | ||
| Line 5: | Line 6: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th><td>number</td></tr> | <tr><th>%number</th><td>The generation number associated with name. This is a positive integer (initially set to 1) that increases by one each time the name object is updated. gen is set to 0 if the method encounters a problem and cannot retrieve the object.</td></tr> | ||
<tr><th>(Subsystem)</th> | <tr><th>%(Subsystem)</th> | ||
<td>The class name in parentheses denotes a shared method. GetObject can also be invoked via a | <td>The class name in parentheses denotes a shared method. <var>GetObject</var> can also be invoked via a <var>[[Subsystem_class|subsystem]]</var> object variable, which may be <var>null</var>.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td><var> | <td>The string name by which the <var>subsystem-wide</var> object is identified.</td></tr> | ||
<tr><th> | <tr><th>object</th> | ||
<td><var> | <td>The object variable to which the <var>subsystem-wide</var> object is assigned.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li><var>GetObject</var> is available from <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 6.7. | |||
</ul> | |||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
{{Template:Subsystem:GetObject footer}} | {{Template:Subsystem:GetObject footer}} | ||
Revision as of 22:50, 19 March 2011
Get a subsystem object (Subsystem class)
The GetObjectshared method retrieves a copy of a specified subsystem-wide object.
Syntax
[%number =] %(Subsystem):GetObject( string, object)
Syntax terms
| %number | The generation number associated with name. This is a positive integer (initially set to 1) that increases by one each time the name object is updated. gen is set to 0 if the method encounters a problem and cannot retrieve the object. |
|---|---|
| %(Subsystem) | The class name in parentheses denotes a shared method. GetObject can also be invoked via a subsystem object variable, which may be null. |
| string | The string name by which the subsystem-wide object is identified. |
| object | The object variable to which the subsystem-wide object is assigned. |
Usage notes
- GetObject is available from "Sirius Mods" Version 6.7.