File: EliminatePlayer.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 (36 lines) | stat: -rw-r--r-- 1,351 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
<?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>EliminatePlayer</title>
    <category>Player</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>bool</rtype>
      <params>
        <param>
          <type>int</type>
          <name>player</name>
          <desc>Number of the player to be eliminated.</desc>
        </param>
        <param>
          <type>bool</type>
          <name>remove_direct</name>
          <desc>Eliminates the player as fast as possible, skipping the usual waiting time (in which the player is e.g. still counted for <funclink>GetPlayerCount</funclink>). There is nonetheless a delay of a few frames.</desc>
        </param>
      </params>
    </syntax>
    <desc>Eliminates a player. The round counts as 'lost' for all eliminated players.</desc>
    <examples>
      <example>
        <code>if (!<funclink>FindObject</funclink>(Find_ID(Flag), Find_Owner(0))) EliminatePlayer(0);</code>
        <text>The first player is eliminated if he has no more flags.</text>
      </example>
    </examples>
    <related><funclink>GameOver</funclink></related>
  </func>
  <author>Sven2</author><date>2001-11</date>
  <author>Clonkonaut</author><date>2015-11</date>
</funcs>