Class PlayerList

Description
Description | Descendents | Vars | Methods (details)

Class PlayerList.

PlayerList implements list of players in a game.

Located in /PlayerList.php (line 21) 

TList
   |
   --PlayerList
Direct descendents
Description | Descendents | Vars | Methods (details)
Class Description
Team Class Team.
Method Summary
Description | Descendents | Vars | Methods (details)
void addPlayer (Player $player)
Player|bool getPlayer (int $index)
Player|bool getPlayerByIndex (int $index)
Variables
Description | Descendents | Vars (details) | Methods (details)

Inherited Variables

Inherited from TList

TList::$count
 TList::$list
Methods
Description | Descendents | Vars Methods (details)
addPlayer (line 28)

Adds a player to the list.

  • access: public
void addPlayer (Player $player)
  • Player $player: the player we wish to add
Redefined in descendants as:
getPlayer (line 39)

Returns a player at the specified offset.

  • return: the player at the index or false if the index is out of the range
  • access: public
Player|bool getPlayer (int $index)
  • int $index: an index of the player
getPlayerByIndex (line 50)

Returns a player with the index property equal to the one defined.

  • return: false if no player has been found
  • access: public
Player|bool getPlayerByIndex (int $index)
  • int $index: player's index

Inherited Methods

Inherited From TList

TList::__construct()
TList::addItem()
TList::clear()
TList::current()
TList::getCount()
TList::getItem()
TList::key()
TList::next()
TList::rewind()
TList::valid()

Documentation generated on Mon, 11 May 2009 16:43:37 +0200 by phpDocumentor 1.4.1