forked from Mirrors/openclonk
26 lines
1.1 KiB
XML
26 lines
1.1 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>GetTeamCount</title>
|
|
<category>Teams</category>
|
|
<version>5.1 OC</version>
|
|
<syntax>
|
|
<rtype>int</rtype>
|
|
<params />
|
|
</syntax>
|
|
<desc>Returns the number of teams currently in the game.</desc>
|
|
<remark>As players may join and leave a game at runtime, there can be "gaps" in player indexing, meaning player numbers may skip certain values. GetPlayerCount returns the actual number of players, not the index of the last player plus one. To process all joined players you need special handling (see example) - you cannot simply run from index 0 to GetPlayerCount() - 1. See the example for <funclink>GetTeamByIndex</funclink>.</remark>
|
|
<related>
|
|
<emlink href="scenario/Teams.html">Teams</emlink>
|
|
<funclink>GetTeamColor</funclink>
|
|
<funclink>GetTeamName</funclink>
|
|
<funclink>GetPlayerTeam</funclink>
|
|
<funclink>GetTeamByIndex</funclink>
|
|
</related>
|
|
</func>
|
|
<author>Clonkonaut</author><date>2008-04</date>
|
|
</funcs>
|