NewFromGlobal (PersistentObjectInfo function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (→Syntax terms) |
||
| Line 7: | Line 7: | ||
<tr><th>%persObjInfo</th><td>A <var>PersistentObjectInfo</var> object variable.</td></tr> | <tr><th>%persObjInfo</th><td>A <var>PersistentObjectInfo</var> object variable.</td></tr> | ||
<tr><th><var>[(PersistentObjectInfo)]</var></th> | <tr><th><var>[(PersistentObjectInfo)]</var></th> | ||
<td>For a shared function, this optional specification of the class in parentheses denotes a [[Notation conventions for methods#Shared methods|virtual constructor]]. See [[#Usage notes|"Usage notes"]], below, for more information about invoking | <td>For a shared function, this optional specification of the class in parentheses denotes a [[Notation conventions for methods#Shared methods|virtual constructor]]. See [[#Usage notes|"Usage notes"]], below, for more information about invoking <var>NewFromGlobal</var>.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>A string that identifies the name of the global variable whose information is returned to <var class="term">%persObjInfo</var>.</td></tr> | <td>A string that identifies the name of the global variable whose information is returned to <var class="term">%persObjInfo</var>.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
Revision as of 01:23, 23 August 2011
Get info about global object (PersistentObjectInfo class)
[Introduced in Sirius Mods 7.8]
Syntax
%persObjInfo = [%(PersistentObjectInfo):]NewFromGlobal( name)
Syntax terms
| %persObjInfo | A PersistentObjectInfo object variable. |
|---|---|
| [(PersistentObjectInfo)] | For a shared function, this optional specification of the class in parentheses denotes a virtual constructor. See "Usage notes", below, for more information about invoking NewFromGlobal. |
| string | A string that identifies the name of the global variable whose information is returned to %persObjInfo. |
Usage notes
- As described in "Virtual Constructor methods", NewFromGlobal can be invoked with
no method object, with an explicit class specification, or with an object variable of the class,
even if that object is Null:
%persObjInf = NewFromGlobal('PART') %persObjInf = %(PersistentObjectInfo):NewFromGlobal('PART') %persObjInf = %persObjInf:NewFromGlobal('PART')