NewFromGlobal (PersistentObjectInfo function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Syntax terms) |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 6: | Line 6: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<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>This optional specification of the class in parentheses denotes a [[Notation conventions for methods#Constructors|virtual constructor]]. See [[#Usage notes| | <td>This optional specification of the class in parentheses denotes a [[Notation conventions for methods#Constructors|virtual constructor]]. See [[#Usage notes|Usage notes]], below, for more information about invoking <var>NewFromGlobal</var>.</td></tr> | ||
<tr><th> | <tr><th>name</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> | ||
| Line 14: | Line 14: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>As described in [[Object variables#Virtual Constructor methods| | <li>As described in [[Object variables#Virtual Constructor methods|Virtual Constructor methods]], <var>NewFromGlobal</var> can be invoked with | ||
no method object, with an explicit class specification, or with an object variable of the class, | no method object, with an explicit class specification, or with an object variable of the class, | ||
even if that object is <var>Null</var>: | even if that object is <var>Null</var>: | ||
| Line 26: | Line 26: | ||
==Examples== | ==Examples== | ||
For an example, see the <var>Name</var> method [[Name (PersistentObjectInfo function)#Examples|Examples]]. | |||
==See also== | ==See also== | ||
{{Template:PersistentObjectInfo:NewFromGlobal footer}} | {{Template:PersistentObjectInfo:NewFromGlobal footer}} | ||
Latest revision as of 19:16, 27 August 2014
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):] | This optional specification of the class in parentheses denotes a virtual constructor. See Usage notes, below, for more information about invoking NewFromGlobal. |
| name | 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')
Examples
For an example, see the Name method Examples.