File: SetFoW.xml

package info (click to toggle)
openclonk 8.1-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 169,520 kB
  • sloc: cpp: 180,479; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 145; sh: 101; javascript: 34
file content (44 lines) | stat: -rw-r--r-- 1,289 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<?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>