File: GetTeamByIndex.xml

package info (click to toggle)
openclonk 8.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 169,656 kB
  • sloc: cpp: 180,484; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 148; sh: 101; javascript: 34
file content (37 lines) | stat: -rw-r--r-- 1,496 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
<?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 &lt; <funclink>GetTeamCount</funclink>(); i++)
  <funclink>Log</funclink>(&quot;Welcome in the game, players from team %s&quot;, <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>