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

34 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>GetPlayerColor</title>
<category>Player</category>
<version>5.1 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>int</type>
<name>player</name>
<desc>Player to be checked</desc>
</param>
</params>
</syntax>
<desc>Determines the player color. The player color is used to identify various owned objects such as flags or clonks as well as his text messages.</desc>
<examples>
<example>
<code><funclink>Log</funclink>(&quot;&lt;c %x&gt;%s&lt;/c&gt; has a score of %d.&quot;, GetPlayerColor(0), <funclink>GetPlayerName</funclink>(0), <funclink>GetScore</funclink>(0));</code>
<text>Returns status information about the first player, highlighting the player's name in the player color.</text>
</example>
</examples>
<related>
<funclink>GetColor</funclink>
<funclink>SetColor</funclink>
</related>
</func>
<author>Sven2</author><date>2013-12</date>
</funcs>