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

36 lines
1008 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>GetProperty</title>
<category>Objects</category>
<subcat>Properties</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>any</rtype>
<params>
<param>
<type>string</type>
<name>key</name>
<desc>Requested property.</desc>
<optional />
</param>
<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 property <code>key</code> of <code>object</code>.</desc>
<related>
<funclink>SetProperty</funclink>
<funclink>GetProperties</funclink>
</related>
</func>
<author>Günther</author><date>2009-05</date>
</funcs>