openclonk/docs/sdk/script/fn/GetBackTexture.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>GetBackTexture</title>
<category>Landscape</category>
<subcat>Material</subcat>
<version>7.0 OC</version>
<syntax>
<rtype>string</rtype>
<params>
<param>
<type>int</type>
<name>x</name>
<desc>X coordinate at which to check the background texture. Offset in local calls.</desc>
</param>
<param>
<type>int</type>
<name>y</name>
<desc>Y coordinate at which to check the background texture. Offset in local calls.</desc>
</param>
</params>
</syntax>
<desc>Returns the name of the texture used for the background material at the given position. The background material is the material that a pixel is replaced with when it is digged away or blasted free.</desc>
<examples>See <funclink>GetTexture</funclink>.</examples>
<related>
<funclink>GetTexture</funclink>
<funclink>GetAverageTextureColor</funclink>
</related>
</func>
<date>2015-07</date>
</funcs>