openclonk/docs/sdk/script/fn/GetProperties.xml

35 lines
986 B
XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>GetProperties</title>
<category>Objects</category>
<subcat>Properties</subcat>
<version>5.3 OC</version>
<syntax>
<rtype>array</rtype>
<params>
<param>
<type>proplist</type>
<name>object</name>
<desc>Object to request property from, <code>nil</code> in local calls.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Returns the names of all properties of <code>object</code>.</desc>
<examples>
<example>
<code>GetProperties({foo = 1, bar = 2}) == ["bar", "foo"]</code>
</example>
</examples>
<related>
<funclink>SetProperty</funclink>
<funclink>GetProperty</funclink>
</related>
</func>
<author>Günther</author><date>2012</date>
</funcs>