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

41 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>SetLandscapePixel</title>
<category>Landscape</category>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>x</name>
<desc>X position of the pixel to be set; relative coordinates in local calls</desc>
</param>
<param>
<type>int</type>
<name>y</name>
<desc>Y position of the pixel to be set; relative coordinates in local calls</desc>
</param>
<param>
<type>int</type>
<name>dwValue</name>
<desc>32 bit color value of the pixel</desc>
</param>
</params>
</syntax>
<desc>Sets a pixel in the landscape. Not available in the old 8 bit graphics system.</desc>
<examples>
<example>
<code>SetLandscapePixel(0, 0, <funclink>RGB</funclink>(185, 127, 0));</code>
<text>Colors the landscape pixel directly behind the calling object brown.</text>
</example>
</examples>
<related><funclink>RGB</funclink></related>
</func>
<author>Sven2</author><date>2002-04</date>
</funcs>