ClassName (Object function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Automatically generated page update)
 
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:Object:ClassName subtitle}}
{{Template:Object:ClassName subtitle}}


This page is [[under construction]].
This function returns the class name of the underlying object.
==Syntax==
==Syntax==
{{Template:Object:ClassName syntax}}
{{Template:Object:ClassName syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table>
<tr><th>%string</th><td>string</td></tr>
<tr><th>%string</th>
<td>The class name of the object referenced by <var class="term">object</var>.</td></tr>
 
<tr><th>object</th>
<tr><th>object</th>
<td>Object object</td></tr>
<td><var>Object</var> class object variable for which the class name is to be returned.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
<ul>
<li>The class name returned is the class of the object variable assigned to the <var>Object</var> class object variable, not the outermost (highest level extension) class. For example, if a variable <code>%foo is object foo</code> is assigned to variable <code>%obj is object object</code>, <var>%obj:classname</var> would return <code>Foo</code>, even if the underlying object was of class <var>Foobar</var> which extended <var>Foo</var>.</li>
</ul>
==Examples==
==Examples==
The following displays the class of the object referenced by <var>Object</var> class variable <var class="term">%something</var>:<p class="code">...
%something    is object object
...
printText {~=%something:className}
</p>
==See also==
==See also==
{{Template:Object:ClassName footer}}
{{Template:Object:ClassName footer}}

Latest revision as of 19:17, 7 August 2014

Class name of object (Object class)

[Introduced in Sirius Mods 8.1]


This function returns the class name of the underlying object.

Syntax

%string = object:ClassName

Syntax terms

%string The class name of the object referenced by object.
object Object class object variable for which the class name is to be returned.

Usage notes

  • The class name returned is the class of the object variable assigned to the Object class object variable, not the outermost (highest level extension) class. For example, if a variable %foo is object foo is assigned to variable %obj is object object, %obj:classname would return Foo, even if the underlying object was of class Foobar which extended Foo.

Examples

The following displays the class of the object referenced by Object class variable %something:

... %something is object object ... printText {~=%something:className}

See also