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

45 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>SetFoW</title>
<category>Player</category>
<subcat>View</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>void</rtype>
<params>
<param>
<type>bool</type>
<name>enabled</name>
<desc>If <code>true</code>, the fog of war is activated, if <code>false</code>, deactivated.</desc>
</param>
<param>
<type>int</type>
<name>player</name>
<desc>Player number.</desc>
</param>
</params>
</syntax>
<desc>Switches the fog of war for one player on or off.</desc>
<examples>
<example>
<code>var i = 0;
<funclink>for</funclink> (var plrnum = <funclink>GetPlayerCount</funclink> (); plrnum; i++)
if (<funclink>GetPlayerName</funclink> (i)) {
plrnum--;
SetFoW (false, i);
}</code>
<text>Deactivates fog of war for all players.</text>
</example>
</examples>
<related>
<funclink>SetPlrView</funclink>
<funclink>SetLightRange</funclink>
</related>
</func>
<author>Günther</author><date>2002-11</date>
</funcs>