File: Hostile.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 (45 lines) | stat: -rw-r--r-- 1,510 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
<?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>Hostile</title>
    <category>Player</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>bool</rtype>
      <params>
        <param>
          <type>int</type>
          <name>player1</name>
          <desc>First player</desc>
        </param>
        <param>
          <type>int</type>
          <name>player2</name>
          <desc>Second player</desc>
        </param>
        <param>
          <type>bool</type>
          <name>check_one_way</name>
          <desc>If <code>true</code>, checks only if player1 is hostile towards player2 but not in reverse.</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Determines whether two players are enemies. Two players will be opposed if at least one of them has declared hostility towards the other.</desc>
    <examples>
      <example>
        <code>protected func RejectEntrance(object other)
{
	<funclink>return</funclink> !<funclink>Hostile</funclink>(<funclink>GetOwner</funclink>(), <funclink>GetOwner</funclink>(other));
}</code>
        <text>The object can only be collected by friendly players.</text>
      </example>
    </examples>
    <related><funclink>SetHostility</funclink></related>
  </func>
  <author>Sven2</author><date>2001-11</date>
  <author>Clonkonaut</author><date>2008-04</date>
</funcs>