GameManager

java.lang.Object
- shared.model.GameManager

Direct Known Subclasses:

ClientGameManager, ServerGameManager
```
public class GameManager
extends java.lang.Object
```
The game manager class acts as a facade between the player/game objects and the ServerProxy/UI

Author:

matthewcarlson, garrettegan

Field Summary

Fields
Modifier and Type	Field and Description
`protected Bank`	`gameBank`
`protected int`	`gameID`
`protected GameState`	`gameState`
`protected java.lang.String`	`gameTitle`
`protected GameActionLog`	`log`
`protected MapModel`	`map`
`protected OfferedTrade`	`offeredTrade`
`protected int`	`playerCanMoveRobber`
`protected int[]`	`playerColors`
`protected java.util.List<Player>`	`players`
`protected int`	`version`
`protected VictoryPointManager`	`victoryPointManager`
`protected ChatBox`	`waterCooler`

Constructor Summary

Constructors
Constructor and Description

GameManager()
Constructor for the game manager

GameManager(java.lang.String name, int id)
Creates a game manager with the specified id

Constructors
Constructor and Description
`GameManager()` Constructor for the game manager
`GameManager(java.lang.String name, int id)` Creates a game manager with the specified id

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`AddPlayer(java.lang.String name, CatanColor color, boolean isHuman)` Adds a player to the game
`int`	`AddPlayer(java.lang.String name, CatanColor color, boolean isHuman, int playerID)` Adds a players to the game
`PlayerInfo[]`	`allCurrentPlayers()`
`void`	`BuildCity(int playerIndex, Coordinate location)` Attempts to build a road
`void`	`BuildRoad(int playerIndex, Coordinate start, Coordinate end, boolean free)` Attempts to build a road
`void`	`BuildSettlement(int playerIndex, Coordinate location, boolean free)` Attempts to build a road
`DevCardType`	`BuyDevCard(int playerIndex)` Attempts to buy a dev card
`boolean`	`canAcceptTrade(int playerIndex)` Can do method for whether a player can accept an article
`boolean`	`CanBuildCity(int playerIndex)` Checks if a player can build a city
`boolean`	`CanBuildCity(int playerIndex, Coordinate location)` Checks to see if a player can build a city
`boolean`	`CanBuildRoad(int playerIndex)` Just checks if a player can build a road
`boolean`	`CanBuildRoad(int playerIndex, Coordinate start, Coordinate end)` Checks to see if a player can build a road at a location
`boolean`	`CanBuildSettlement(int playerIndex)` Checks if a player can build the settlement
`boolean`	`CanBuildSettlement(int playerIndex, Coordinate location)` checks to see if a player can build a settlement
`boolean`	`CanBuyDevCard(int playerIndex)` Checks to see if a player can buy a dev card
`boolean`	`canChat(int playerIndex)` Check if player can chat
`boolean`	`CanDiscardCards(int playerIndex, ResourceType type, int amount)` See if a player can discard cards
`boolean`	`CanFinishTurn()` Checks whether the current player can finish their turn
`boolean`	`CanFinishTurn(int playerIndex)` Checks whether a player can finish their turn
`boolean`	`CanMaritimeTrade(int playerIndex)` Can do method for determining whether a player can maritime trade
`boolean`	`CanOfferTrade(int playerIndex)`
`boolean`	`CanPlaceRobber(int playerIndex)` Checks to see if a player can place the robber
`boolean`	`CanPlayDevCard(int playerIndex, DevCardType type)` Determines whenter player can play card
`boolean`	`CanPlayerPlay(int playerIndex)` Checks to see if it's a player's turn
`boolean`	`CanRollNumber(int playerIndex)` Checks to see if a player can roll their number
`boolean`	`CanUseMonopoly(int playerIndex)` Checks to see if a player can play a monopoly card
`boolean`	`CanUseMonument(int playerIndex)` Check to see if they have the momument card
`boolean`	`CanUseRoadBuilder(int playerIndex)` Checks if a player can use the road builder?
`boolean`	`CanUseSoldier(int playerIndex)` Checks if a player can play a solider card
`boolean`	`CanUseYearOfPlenty(int playerIndex)` Checks to see if the player can use a year of plenty picture
`void`	`CurrentPlayerChat(java.lang.String message)` When the player chats currently playing
`int`	`CurrentPlayersTurn()` Gets the player index of the current player
`GameRound`	`CurrentState()` Returns the current round of the game
`void`	`DiceRoll(int diceRoll)` Handles the roll of a die
`void`	`FinishTurn()` Ends the current player's turn
`int`	`getBankResourceCount(ResourceType resourceType)` Returns the number of the requested type of resource held by the bank
`ChatBox`	`getChat()` Returns the chat
`protected Player`	`GetCurrentPlayer()` Gets the current player
`java.lang.String`	`getCurrentPlayerName()`
`GameActionLog`	`getGameActionLog()` Returns the log
`int`	`GetGameID()` Returns the ID of the game
`java.lang.String`	`GetGameTitle()` Returns the game's title
`int`	`getNumberPlayers()` Gets the current number of players
`protected Player`	`GetPlayer(int playerIndex)` Gets the specified player
`CatanColor`	`getPlayerColorByIndex(int playerIndex)`
`protected int`	`GetPlayerIDbyIndex(int playerIndex)` Gets a player's ID
`int`	`getPlayerIndexByColor(CatanColor color)` Gets the player index by color
`java.lang.String`	`getPlayerNameByIndex(int playerIndex)`
`int`	`getTradeRatio(int playerIndex, ResourceType type)` Gets the trade ratio for a given resource for a player
`int`	`GetVersion()` Returns the current version
`VictoryPointManager`	`getVictoryPointManager()` Returns the VictoryPointManager
`boolean`	`hasGameStarted()` Check whether the game has started
`protected void`	`LogAction(int playerIndex, java.lang.String message)` Logs a action into the state log
`protected boolean`	`NeedToDiscardAfterRoll()` Determines if there is a player with over 7 cards
`int`	`NumberActivePlayers()` The number of players in a game
`void`	`payDayForDayz()` Testing function
`void`	`placeRobber(int playerIndex)` Places the robber
`void`	`playDevCard(int playerIndex, DevCardType type)` Plays a dev card
`void`	`PlayerChat(int playerIndex, java.lang.String message)` Chats for the specified player
`int`	`playerDevCardCount(int playerIndex)` Gets the total number of dev cards for a player
`int`	`playerDevCardCount(int playerIndex, DevCardType type)` Gets the number of devCards for the current player
`private boolean`	`PlayerHasADevCard(int playerIndex, DevCardType type)` Checks if a player has at least one dev card of the type
`int`	`playerPieceCount(int playerIndex, PieceType type)` Gets the number of pieces for the current player
`int`	`playerResourceCount(int playerIndex, ResourceType type)` Gets the number of resources for the player
`void`	`removeTradeOffer()` Removes any trade offers, if any exist
`void`	`reset()` Resets a game to default state
`int`	`RollDice()`
`void`	`SetPlayers(java.util.List<Player> players)` Sets the players
`void`	`setTradeOffer(OfferedTrade offeredTrade)` Sets the trade offer when one is made, it doesn't need to notify because this is already checked in the client
`void`	`StartGame()` Starts the game

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - gameID
```
protected int gameID
```
  - gameTitle
```
protected java.lang.String gameTitle
```
  - gameState
```
protected GameState gameState
```
  - gameBank
```
protected Bank gameBank
```
  - players
```
protected java.util.List<Player> players
```
  - victoryPointManager
```
protected VictoryPointManager victoryPointManager
```
  - waterCooler
```
protected ChatBox waterCooler
```
  - offeredTrade
```
protected OfferedTrade offeredTrade
```
  - log
```
protected GameActionLog log
```
  - map
```
protected MapModel map
```
  - version
```
protected int version
```
  - playerColors
```
protected int[] playerColors
```
  - playerCanMoveRobber
```
protected int playerCanMoveRobber
```
- Constructor Detail
  - GameManager
```
public GameManager()
```
    Constructor for the game manager
  - GameManager
```
public GameManager(java.lang.String name,
                   int id)
```
    Creates a game manager with the specified id
    
    Parameters:
    
    name - the title of the game
    
    id -
- Method Detail
  - reset
```
public void reset()
```
    Resets a game to default state
  - AddPlayer
```
public int AddPlayer(java.lang.String name,
                     CatanColor color,
                     boolean isHuman,
                     int playerID)
              throws ModelException
```
    Adds a players to the game
    
    Parameters:
    
    name - The name of the player
    
    color - The piece color
    
    isHuman - True if human, else AI
    
    playerID - The id of the player
    
    Returns:
    
    the player index
    
    Throws:
    
    ModelException - Thrown if the player can't be added
  - AddPlayer
```
public int AddPlayer(java.lang.String name,
                     CatanColor color,
                     boolean isHuman)
              throws ModelException
```
    Adds a player to the game
    
    Parameters:
    
    name -
    
    Returns:
    
    the player index number
    
    Throws:
    
    ModelException - if there are too many players already in the game or if that color has been used
  - SetPlayers
```
public void SetPlayers(java.util.List<Player> players)
```
    Sets the players
    
    Parameters:
    
    players -
  - getNumberPlayers
```
public int getNumberPlayers()
```
    Gets the current number of players
    
    Returns:
  - allCurrentPlayers
```
public PlayerInfo[] allCurrentPlayers()
```
    Returns:
  - getPlayerNameByIndex
```
public java.lang.String getPlayerNameByIndex(int playerIndex)
```
    Parameters:
    
    playerIndex -
  - GetPlayerIDbyIndex
```
protected int GetPlayerIDbyIndex(int playerIndex)
```
    Gets a player's ID
    
    Parameters:
    
    playerIndexReceiving -
    
    Returns:
    
    -1 if player is not found
  - getCurrentPlayerName
```
public java.lang.String getCurrentPlayerName()
```
  - getPlayerIndexByColor
```
public int getPlayerIndexByColor(CatanColor color)
```
    Gets the player index by color
    
    Parameters:
    
    color -
    
    Returns:
    
    -1 if not found
  - getPlayerColorByIndex
```
public CatanColor getPlayerColorByIndex(int playerIndex)
```
  - playerResourceCount
```
public int playerResourceCount(int playerIndex,
                               ResourceType type)
```
    Gets the number of resources for the player
    
    Parameters:
    
    playerIndex -
    
    type -
    
    Returns:
  - playerDevCardCount
```
public int playerDevCardCount(int playerIndex,
                              DevCardType type)
```
    Gets the number of devCards for the current player
    
    Parameters:
    
    playerIndex -
    
    type -
    
    Returns:
  - playerDevCardCount
```
public int playerDevCardCount(int playerIndex)
```
    Gets the total number of dev cards for a player
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - playerPieceCount
```
public int playerPieceCount(int playerIndex,
                            PieceType type)
```
    Gets the number of pieces for the current player
    
    Parameters:
    
    playerIndex -
    
    type -
    
    Returns:
  - NumberActivePlayers
```
public int NumberActivePlayers()
```
    The number of players in a game
    
    Returns:
  - setTradeOffer
```
public void setTradeOffer(OfferedTrade offeredTrade)
```
    Sets the trade offer when one is made, it doesn't need to notify because this is already checked in the client
    
    Parameters:
    
    offeredTrade -
  - removeTradeOffer
```
public void removeTradeOffer()
```
    Removes any trade offers, if any exist
  - GetVersion
```
public int GetVersion()
```
    Returns the current version
    
    Returns:
  - RollDice
```
public int RollDice()
             throws ModelException
```
    Returns:
    
    the number rolled
    
    Throws:
    
    ModelException - if we aren't in the rolling phase
    
    See Also:
    
    Sauce
  - NeedToDiscardAfterRoll
```
protected boolean NeedToDiscardAfterRoll()
```
    Determines if there is a player with over 7 cards
    
    Returns:
  - LogAction
```
protected void LogAction(int playerIndex,
                         java.lang.String message)
```
    Logs a action into the state log
    
    Parameters:
    
    playerIndex -
    
    message -
  - DiceRoll
```
public void DiceRoll(int diceRoll)
              throws ModelException
```
    Handles the roll of a die
    
    Parameters:
    
    roll -
    
    Throws:
    
    ModelException
  - BuildRoad
```
public void BuildRoad(int playerIndex,
                      Coordinate start,
                      Coordinate end,
                      boolean free)
               throws ModelException
```
    Attempts to build a road
    
    Parameters:
    
    playerIndex -
    
    Throws:
    
    ModelException - if the player doesn't have the resources
  - BuildSettlement
```
public void BuildSettlement(int playerIndex,
                            Coordinate location,
                            boolean free)
                     throws ModelException
```
    Attempts to build a road
    
    Parameters:
    
    playerIndex -
    
    Throws:
    
    ModelException - if the player doesn't have the resources
  - BuildCity
```
public void BuildCity(int playerIndex,
                      Coordinate location)
               throws ModelException
```
    Attempts to build a road
    
    Parameters:
    
    playerIndex -
    
    Throws:
    
    ModelException - if the player doesn't have the resources
    
    MapException - if the Location doesn't exist
  - BuyDevCard
```
public DevCardType BuyDevCard(int playerIndex)
                       throws ModelException
```
    Attempts to buy a dev card
    
    Parameters:
    
    playerIndex - 0 to 3
    
    Throws:
    
    ModelException - if the player doesn't have the resources
  - playDevCard
```
public void playDevCard(int playerIndex,
                        DevCardType type)
                 throws ModelException
```
    Plays a dev card
    
    Parameters:
    
    playerIndex -
    
    type -
    
    Throws:
    
    ModelException
  - getTradeRatio
```
public int getTradeRatio(int playerIndex,
                         ResourceType type)
```
    Gets the trade ratio for a given resource for a player
    
    Parameters:
    
    playerIndex -
    
    Returns:
    
    never more than 4 or less than 2
  - placeRobber
```
public void placeRobber(int playerIndex)
                 throws ModelException
```
    Places the robber
    
    Parameters:
    
    playerIndex -
    
    location -
    
    Throws:
    
    ModelException
  - CanPlayerPlay
```
public boolean CanPlayerPlay(int playerIndex)
```
    Checks to see if it's a player's turn
    
    Parameters:
    
    playerIndex - 0 to 3
    
    Returns:
    
    if possible
  - CanDiscardCards
```
public boolean CanDiscardCards(int playerIndex,
                               ResourceType type,
                               int amount)
```
    See if a player can discard cards
    
    Parameters:
    
    playerIndex - 0 to 3
    
    type - the type of the resource
    
    amount - number to discard
    
    Returns:
  - CanRollNumber
```
public boolean CanRollNumber(int playerIndex)
```
    Checks to see if a player can roll their number
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - CanBuildRoad
```
public boolean CanBuildRoad(int playerIndex,
                            Coordinate start,
                            Coordinate end)
```
    Checks to see if a player can build a road at a location
    
    Parameters:
    
    playerIndex - 0-3
    
    location - the edge's location
    
    end -
    
    Returns:
    
    true if possible
  - CanBuildRoad
```
public boolean CanBuildRoad(int playerIndex)
```
    Just checks if a player can build a road
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - CanBuildSettlement
```
public boolean CanBuildSettlement(int playerIndex,
                                  Coordinate location)
```
    checks to see if a player can build a settlement
    
    Parameters:
    
    playerIndex -
    
    location - the vertex
    
    Returns:
  - CanBuildSettlement
```
public boolean CanBuildSettlement(int playerIndex)
```
    Checks if a player can build the settlement
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - CanBuildCity
```
public boolean CanBuildCity(int playerIndex,
                            Coordinate location)
```
    Checks to see if a player can build a city
    
    Parameters:
    
    playerIndex - 0 to 3
    
    location - the vertex
    
    Returns:
  - CanBuildCity
```
public boolean CanBuildCity(int playerIndex)
```
    Checks if a player can build a city
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - CanOfferTrade
```
public boolean CanOfferTrade(int playerIndex)
```
    Parameters:
    
    playerIndex -
    
    Returns:
  - canAcceptTrade
```
public boolean canAcceptTrade(int playerIndex)
```
    Can do method for whether a player can accept an article
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - payDayForDayz
```
public void payDayForDayz()
```
    Testing function
  - CanMaritimeTrade
```
public boolean CanMaritimeTrade(int playerIndex)
```
    Can do method for determining whether a player can maritime trade
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - CanFinishTurn
```
public boolean CanFinishTurn(int playerIndex)
```
    Checks whether a player can finish their turn
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - CanFinishTurn
```
public boolean CanFinishTurn()
```
    Checks whether the current player can finish their turn
    
    Returns:
    
    true or false
  - CanBuyDevCard
```
public boolean CanBuyDevCard(int playerIndex)
```
    Checks to see if a player can buy a dev card
    
    Parameters:
    
    playerIndex - 0 to 3
    
    Returns:
    
    true if possible, always false if not the players turn
  - canChat
```
public boolean canChat(int playerIndex)
```
    Check if player can chat
    
    Parameters:
    
    playerIndex -
    
    Returns:
    
    true if we aren't waiting for players
  - PlayerHasADevCard
```
private boolean PlayerHasADevCard(int playerIndex,
                                  DevCardType type)
```
    Checks if a player has at least one dev card of the type
    
    Parameters:
    
    playerIndex -
    
    type -
    
    Returns:
  - CanUseYearOfPlenty
```
public boolean CanUseYearOfPlenty(int playerIndex)
```
    Checks to see if the player can use a year of plenty picture
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - CanUseRoadBuilder
```
public boolean CanUseRoadBuilder(int playerIndex)
```
    Checks if a player can use the road builder?
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - CanUseSoldier
```
public boolean CanUseSoldier(int playerIndex)
```
    Checks if a player can play a solider card
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - CanUseMonopoly
```
public boolean CanUseMonopoly(int playerIndex)
```
    Checks to see if a player can play a monopoly card
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - CanUseMonument
```
public boolean CanUseMonument(int playerIndex)
```
    Check to see if they have the momument card
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - CanPlayDevCard
```
public boolean CanPlayDevCard(int playerIndex,
                              DevCardType type)
```
    Determines whenter player can play card
    
    Parameters:
    
    playerIndex -
    
    type -
    
    Returns:
  - CanPlaceRobber
```
public boolean CanPlaceRobber(int playerIndex)
```
    Checks to see if a player can place the robber
    
    Parameters:
    
    playerIndex -
    
    Returns:
  - CurrentPlayerChat
```
public void CurrentPlayerChat(java.lang.String message)
```
    When the player chats currently playing
    
    Parameters:
    
    message -
  - PlayerChat
```
public void PlayerChat(int playerIndex,
                       java.lang.String message)
```
    Chats for the specified player
    
    Parameters:
    
    playerIndex - 0-3
    
    message -
  - StartGame
```
public void StartGame()
```
    Starts the game
  - FinishTurn
```
public void FinishTurn()
                throws ModelException
```
    Ends the current player's turn
    
    Throws:
    
    ModelException
  - CurrentPlayersTurn
```
public int CurrentPlayersTurn()
```
    Gets the player index of the current player
    
    Returns:
    
    0 to 3
  - GetPlayer
```
protected Player GetPlayer(int playerIndex)
                    throws ModelException
```
    Gets the specified player
    
    Parameters:
    
    playerIndex - 0 to 3
    
    Returns:
    
    Throws:
    
    ModelException
  - GetCurrentPlayer
```
protected Player GetCurrentPlayer()
                           throws ModelException
```
    Gets the current player
    
    Returns:
    
    the player
    
    Throws:
    
    ModelException
  - CurrentState
```
public GameRound CurrentState()
```
    Returns the current round of the game
    
    Returns:
  - hasGameStarted
```
public boolean hasGameStarted()
```
    Check whether the game has started
    
    Returns:
  - GetGameTitle
```
public java.lang.String GetGameTitle()
```
    Returns the game's title
    
    Returns:
  - GetGameID
```
public int GetGameID()
```
    Returns the ID of the game
    
    Returns:
  - getGameActionLog
```
public GameActionLog getGameActionLog()
```
    Returns the log
    
    Returns:
    
    the log
  - getChat
```
public ChatBox getChat()
```
    Returns the chat
    
    Returns:
    
    the chat
  - getVictoryPointManager
```
public VictoryPointManager getVictoryPointManager()
```
    Returns the VictoryPointManager
    
    Returns:
    
    the VictoryPointManager
  - getBankResourceCount
```
public int getBankResourceCount(ResourceType resourceType)
```
    Returns the number of the requested type of resource held by the bank
    
    Parameters:
    
    resourceType -
    
    Returns:

Class GameManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

gameID

gameTitle

gameState

gameBank

players

victoryPointManager

waterCooler

offeredTrade

log

map

version

playerColors

playerCanMoveRobber

Constructor Detail

GameManager

GameManager

Method Detail

reset

AddPlayer

AddPlayer

SetPlayers

getNumberPlayers

allCurrentPlayers

getPlayerNameByIndex

GetPlayerIDbyIndex

getCurrentPlayerName

getPlayerIndexByColor

getPlayerColorByIndex

playerResourceCount

playerDevCardCount

playerDevCardCount

playerPieceCount

NumberActivePlayers

setTradeOffer

removeTradeOffer

GetVersion

RollDice

NeedToDiscardAfterRoll

LogAction

DiceRoll

BuildRoad

BuildSettlement

BuildCity

BuyDevCard

playDevCard

getTradeRatio

placeRobber

CanPlayerPlay

CanDiscardCards

CanRollNumber

CanBuildRoad

CanBuildRoad

CanBuildSettlement

CanBuildSettlement

CanBuildCity

CanBuildCity

CanOfferTrade

canAcceptTrade

payDayForDayz

CanMaritimeTrade

CanFinishTurn

CanFinishTurn

CanBuyDevCard

canChat

PlayerHasADevCard

CanUseYearOfPlenty

CanUseRoadBuilder

CanUseSoldier

CanUseMonopoly

CanUseMonument

CanPlayDevCard

CanPlaceRobber

CurrentPlayerChat

PlayerChat