GetObject (System function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Automatically generated page update)
 
m (copied content from PDF and updated to be system only)
Line 1: Line 1:
{{Template:System:GetObject subtitle}}
{{Template:System:GetObject subtitle}}
The <var>GetObject</var>shared method retrieves a copy of a specified <var>[[System_class#System-wide_objects|system-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>(System)</th>
<tr><th>%(System)</th>
<td>The class name in parentheses denotes a shared method. GetObject can also be invoked via a System object variable, which may be null.</td></tr>
<td>The class name in parentheses denotes a shared method. <var>GetObject</var> can also be invoked via a <var>[[System_class|system]]</var> object variable, which may be <var>null</var>.</td></tr>
<tr><th>string</th>
<tr><th>string</th>
<td><var>String</var> object</td></tr>
<td>The string name by which the <var>system-wide</var> object is identified.</td></tr>
<tr><th>oBJECT</th>
<tr><th>object</th>
<td><var>OBJECT</var> object</td></tr>
<td>The object variable to which the <var>system-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:System:GetObject footer}}
{{Template:System:GetObject footer}}

Revision as of 22:50, 19 March 2011

Get a system-wide object (System class)

The GetObjectshared method retrieves a copy of a specified system-wide object.

Syntax

[%number =] %(System):GetObject( string, object)

Syntax terms

%numberThe 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.
%(System) The class name in parentheses denotes a shared method. GetObject can also be invoked via a system object variable, which may be null.
string The string name by which the system-wide object is identified.
object The object variable to which the system-wide object is assigned.

Usage notes

Examples

See also