openclonk/docs/sdk/script/fn/SetColor.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>SetColor</title>
<category>Objects</category>
<subcat>Display</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>void</rtype>
<params>
<param>
<type>int</type>
<name>color</name>
<desc>New color for ColorByOwner areas.</desc>
</param>
</params>
</syntax>
<desc>Sets the ColorByOwner color of an object. This call corresponds to setting the owner using <funclink>SetOwner</funclink> to a player with color as the player color.</desc>
<examples>
<example>
<code><funclink>GetCursor</funclink>(0)-&gt;SetColor(<funclink>RGBa</funclink>(255, 255, 255, 127));</code>
<text>Colors the owner areas of the currently selected clonk of the first player white and half transparent.</text>
</example>
</examples>
<related>
<funclink>GetColor</funclink>
<funclink>SetClrModulation</funclink>
</related>
</func>
<author>Sven2</author><date>2002-05</date>
</funcs>