openclonk/docs/sdk/script/fn/EliminatePlayer.xml

37 lines
1.3 KiB
XML

<?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>