File: SetPlrKnowledge.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,505 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>SetPlrKnowledge</title>
    <category>Player</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>int</rtype>
      <params>
        <param>
          <type>int</type>
          <name>player</name>
          <desc>Player which receives or loses the construction plan. If nil, the function is executed for all players.</desc>
        </param>
        <param>
          <type>id</type>
          <name>definition</name>
          <desc>Id of the definition for which the plan shall be given.</desc>
        </param>
        <param>
          <type>bool</type>
          <name>remove</name>
          <desc>If not <code>false</code>, the plan will be removed from the players knowledge.</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Gives a player a construction plan resp. removes the plan if remove is given.</desc>
    <examples>
      <example>
        <code>var i, id; <funclink>while</funclink> (id = <funclink>GetDefinition</funclink>(i++)) SetPlrKnowledge(nil, id);</code>
        <text>All players are given plans to all loaded objects.</text>
      </example>
    </examples>
    <related>
      <funclink>GetPlrKnowledge</funclink>
      <funclink>SetPlrMagic</funclink>
    </related>
  </func>
  <author>Sven2</author><date>2003-06</date>
</funcs>