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

35 lines
1.2 KiB
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>MaterialName</title>
<category>Landscape</category>
<subcat>Material</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>string</rtype>
<params>
<param>
<type>int</type>
<name>material_index</name>
<desc>Index of the material of which you want to know the name.</desc>
</param>
</params>
</syntax>
<desc>Returns the internal (technical) name of a material.</desc>
<examples>
<example>
<code><funclink>GetCursor</funclink>(0)-&gt;<funclink>Message</funclink>(&quot;You clonk is standing on %s.&quot;, MaterialName(<funclink>GetCursor</funclink>(0)-&gt;<funclink>GetMaterial</funclink>(0, 12)));</code>
<text>Displays on what type of material the first player's selected clonk is standing.</text>
</example>
</examples>
<related>
<funclink>Material</funclink>
<funclink>GetMaterial</funclink>
</related>
</func>
<author>Sven2</author><date>2001-11</date>
</funcs>