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

43 lines
1.3 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>GBackSolid</title>
<category>Landscape</category>
<subcat>Material</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>x</name>
<desc>X coordinate. Offset in local calls.</desc>
</param>
<param>
<type>int</type>
<name>y</name>
<desc>Y coordinate. Offset in local calls.</desc>
</param>
</params>
</syntax>
<desc>Checks whether there is solid matter at the specified position in the landscape.</desc>
<examples>
<example>
<code>
while(obj-&gt;GBackSolid()) obj-&gt;<funclink>SetPosition</funclink>(obj-&gt;<funclink>GetX</funclink>(),obj-&gt;<funclink>GetY</funclink>()-1);</code>
<text>Moves an object to the surface or to the ground of a lake.</text>
</example>
</examples>
<related>
<funclink>GBackLiquid</funclink>
<funclink>GBackSemiSolid</funclink>
<funclink>GBackSky</funclink>
<funclink>GetMaterial</funclink>
</related>
</func>
<author>Günther</author><date>2002-04</date>
</funcs>