File: GetPlrMagic.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 (47 lines) | stat: -rw-r--r-- 1,710 bytes parent folder | download | duplicates (7)
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
45
46
47
<?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>GetPlrMagic</title>
    <category>Player</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>bool / id</rtype>
      <params>
        <param>
          <type>int</type>
          <name>player</name>
          <desc>Player whose magic knowledge you want to determine.</desc>
        </param>
        <param>
          <type>id</type>
          <name>id</name>
          <desc>With id specified the function returns <code>true</code>, if the specified player knows the specified spell. In this case index is ignored.</desc>
        </param>
        <param>
          <type>int</type>
          <name>index</name>
          <desc>With index specified the function returns the indicated spell from the player's list of known spells.</desc>
        </param>
      </params>
    </syntax>
    <desc>Determines magic spell knowledge of a player.</desc>
    <examples>
      <example>
        <code><funclink>if</funclink> (GetPlrMagic(0,Magic_Lightning))
	<funclink>Log</funclink>(&quot;Player %s can create lightnings&quot;,<funclink>GetPlayerName</funclink>(0));
				</code>
        <text>If player 0 knows the lightning spell, a message is displayed.</text>
      </example>
      <example>
        <code>var spell = GetPlrMagic(0,0,4);
<funclink>Log</funclink>(&quot;The fifth spell of the first player is %i&quot;,spell);
				</code>
        <text>Returns the id of the fifth spell of the first player.</text>
      </example>
    </examples>
  </func>
  <author>jwk</author><date>2002-06</date>
</funcs>