ListOfObjects (Subsystem function): Difference between revisions
Jump to navigation
Jump to search
m (syntax terms) |
m (not wide at all) |
||
| Line 1: | Line 1: | ||
{{Template:Subsystem:ListOfObjects subtitle}} | {{Template:Subsystem:ListOfObjects subtitle}} | ||
The <var>ListOfObjects</var> method returns a <var>[[Stringlist class|Stringlist]]</var> containing information about <var>[[Subsystem_class#System-wide_objects|subsystem | The <var>ListOfObjects</var> method returns a <var>[[Stringlist class|Stringlist]]</var> containing information about <var>[[Subsystem_class#System-wide_objects|subsystem]]</var> objects. <var>ListOfObjects</var> is a shared method. | ||
==Syntax== | ==Syntax== | ||
| Line 10: | Line 10: | ||
<td>The class name in parentheses denotes a shared method. <var>ListOfObjects</var> can also be invoked via a <var>[[Subsystem_class|subsystem]]</var> object variable, which may be <var>null</var>.</td></tr> | <td>The class name in parentheses denotes a shared method. <var>ListOfObjects</var> can also be invoked via a <var>[[Subsystem_class|subsystem]]</var> object variable, which may be <var>null</var>.</td></tr> | ||
<tr><th>nameW</th> | <tr><th>nameW</th> | ||
<td>An optional identifying string which may include wildcard characters. Descriptions of the <var> | <td>An optional identifying string which may include wildcard characters. Descriptions of the <var>subsystem</var> objects whose names match the <var class="term">nameW</var> pattern(s) are returned to the <var class="term">%sl</var> <var>Stringlist</var>. | ||
<p>This argument defaults to an asterisk (<code>*</code>), that is, all <var>system-wide</var> objects, and its eligible wildcard characters are shown below:</p> | <p>This argument defaults to an asterisk (<code>*</code>), that is, all <var>system-wide</var> objects, and its eligible wildcard characters are shown below:</p> | ||
<ul><li><code>*</code> Matches any group of 0 or more characters | <ul><li><code>*</code> Matches any group of 0 or more characters | ||
Revision as of 05:00, 25 March 2011
List of subsystem objects (Subsystem class)
The ListOfObjects method returns a Stringlist containing information about subsystem objects. ListOfObjects is a shared method.
Syntax
%sl = %(Subsystem):ListOfObjects[( [subsysW], [nameW])]
Syntax terms
| %sl | The Stringlist variable that contains the data about the objects selected according to the nameW and subsysW patterns. |
|---|---|
| %(Subsystem) | The class name in parentheses denotes a shared method. ListOfObjects can also be invoked via a subsystem object variable, which may be null. |
| nameW | An optional identifying string which may include wildcard characters. Descriptions of the subsystem objects whose names match the nameW pattern(s) are returned to the %sl Stringlist.
This argument defaults to an asterisk (
|
| subsysW | An optional string, which may include wildcard characters, that identifies the associated subsystem of the objects whose descriptions are returned. This argument defaults to an asterisk (*), that is, all subsystems, and its eligible wildcard characters are the same as those for nameW, above. |
Usage notes
- All errors result in request cancellation.
- The Subsystem class ListOfGlobals method applies to the subsys argument only; it ignores the current subsystem context.
- The items placed on the target Stringlist are put there in no particular order.
- ListOfObjects is available in "Sirius Mods" Version 6.7 and later.