forked from Mirrors/openclonk
38 lines
1.5 KiB
XML
38 lines
1.5 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>GetTeamByIndex</title>
|
|
<category>Teams</category>
|
|
<version>5.1 OC</version>
|
|
<syntax>
|
|
<rtype>int</rtype>
|
|
<params>
|
|
<param>
|
|
<type>int</type>
|
|
<name>index</name>
|
|
<desc>Index into the list of teams.</desc>
|
|
</param>
|
|
</params>
|
|
</syntax>
|
|
<desc>Returns the indicated team number. This function guarantees that for values from 0 to GetTeamCount()-1 a valid team number will be returned (notice that there may be "gaps" between team numbers in case some team have been removed from the game). This makes it easier to process all teams in a loop.</desc>
|
|
<examples>
|
|
<example>
|
|
<code><funclink>for</funclink>(var i = 0; i < <funclink>GetTeamCount</funclink>(); i++)
|
|
<funclink>Log</funclink>("Welcome in the game, players from team %s", <funclink>GetTeamName</funclink>(GetTeamByIndex(i)));</code>
|
|
<text>Welcomes all players in the log file.</text>
|
|
</example>
|
|
</examples>
|
|
<related>
|
|
<emlink href="scenario/Teams.html">Teams</emlink>
|
|
<funclink>GetTeamColor</funclink>
|
|
<funclink>GetTeamName</funclink>
|
|
<funclink>GetPlayerTeam</funclink>
|
|
<funclink>GetTeamCount</funclink>
|
|
</related>
|
|
</func>
|
|
<author>Clonkonaut</author><date>2008-04</date>
|
|
</funcs>
|