Field

```
public interface Field
```
The entire playing field for a match. A Field object can be used to get all of the information about the current state of the game.
A field has three dimensions: width, depth, and height. In the generated match videos, the perspective is from above, so WIDTH and DEPTH refer to the width and height of the video. But do not confuse depth with height; the y-coordinate returned by Locatable.getLocation() represents an entirely different dimension than the y-coordinate returned by Player.getHeight().

Author:

Finn

Field Summary

Fields
Modifier and Type	Field	Description
`static double`	`DEPTH`	The depth, or maximum y-coordinate, of the field.
`static int`	`MAX_FOOD`	The maximum food pieces that can exist on the field at a time.
`static int`	`TOTAL_TURNS`	The total number of turns in a match.
`static double`	`WIDTH`	The width, or maximum x-coordinate, of the field.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Set<Collision>`	`getCollisions()`	Returns a set of all of the collisions that occurred on the field on the previous turn.
`Set<Food>`	`getFood()`	Returns a set containing all of the food on the field.
`Food`	`getFood(Food.Type type)`	Returns the food piece on this field with the given type.
`MatchType`	`getMatchType()`	Returns the type of match being played on this field.
`Player`	`getPlayer(char symbol)`	Returns the player on this field with the given symbol.
`Set<Player>`	`getPlayers()`	Returns a set containing all players on the field.
`Team`	`getTeam(char symbol)`	Returns the team on this field with the given symbol.
`Team`	`getTeam(Player player)`	Returns the team for which the given player is playing.
`Set<Team>`	`getTeams()`	Returns a set containing all of the teams on the field.
`int`	`getTurnNumber()`	Returns the number of the current turn.

- Field Detail
  - DEPTH
```
static final double DEPTH
```
    The depth, or maximum y-coordinate, of the field.
    
    See Also:
    
    Constant Field Values
  - WIDTH
```
static final double WIDTH
```
    The width, or maximum x-coordinate, of the field.
    
    See Also:
    
    Constant Field Values
  - MAX_FOOD
```
static final int MAX_FOOD
```
    The maximum food pieces that can exist on the field at a time.
    
    See Also:
    
    Constant Field Values
  - TOTAL_TURNS
```
static final int TOTAL_TURNS
```
    The total number of turns in a match.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getTurnNumber
```
int getTurnNumber()
```
    Returns the number of the current turn. Note that turns are 1-indexed, so the first action that players will play will be on turn 1. The final turn will be the number TOTAL_TURNS.
    
    Returns:
    
    the current turn being played on this field
  - getMatchType
```
MatchType getMatchType()
```
    Returns the type of match being played on this field. This will not change between turns.
    
    Returns:
    
    the type of match being played on this field.
  - getTeams
```
Set<Team> getTeams()
```
    Returns a set containing all of the teams on the field. The teams on the field will not change between turns (though the properties of the teams may). Iteration over this set will always produce the same teams in the same order.
    
    Returns:
    
    all of the teams playing on the field
  - getTeam
```
Team getTeam(char symbol)
```
    Returns the team on this field with the given symbol. That is, Team.getSymbol() will return symbol for the returned team. If there is no team playing on this field that has the given symbol, this method returns null. The functionality of this method could be achieved by iterating over the set returned by getTeams(), but this method exists for convenience.
    
    Parameters:
    
    symbol - the identifying symbol of the desired team
    
    Returns:
    
    the team with the desired symbol, or null if none exists
  - getTeam
```
Team getTeam(Player player)
```
    Returns the team for which the given player is playing. For the returned team, Team.getPlayers() will return a set that contains the given player. If no such team exists (meaning that the player is not currently on the field), then this method returns null. The functionality of this method could be achieved by iterating over the set returned by getTeams(), but this method exists for convenience.
    
    Parameters:
    
    player - a player on the desired team
    
    Returns:
    
    the team on which the player is playing, or null if none exists
  - getPlayers
```
Set<Player> getPlayers()
```
    Returns a set containing all players on the field. The functionality of this method could be achieved by iterating over the set returned by getTeams(), and the set returned by Team.getPlayers() for each team, but this method exists for convenience.
    
    Returns:
    
    all of the players playing on this field
  - getPlayer
```
Player getPlayer(char symbol)
```
    Returns the player on this field with the given symbol. That is, Player.getSymbol() will return symbol for the returned player. If there is no player playing on this field that has the given symbol, this method returns null. The functionality of this method could be achieved by iterating over the set returned by getTeams(), but this method exists for convenience.
    
    Parameters:
    
    symbol - the identifying symbol of the desired player
    
    Returns:
    
    the player with the desired symbol, or null if none exists
  - getFood
```
Set<Food> getFood()
```
    Returns a set containing all of the food on the field. Note that this set will not contain food that is on a Table or in a player's Inventory; it includes only food that is on the ground or in the air.
    There are three ways for the size of this set to decrease: if a player picks up a food piece (moving the food into the player's inventory), if a player is struck by a flying food piece (despawning the food piece), or if a food piece passes over a table (moving the food onto the table).
    There are also two ways for the size of this set to increase: if a player throws a food piece (creating a new flying food piece), or if a new food piece is spawned (creating a new food piece on the ground). A new food piece is spawned on a turn if the total number of types of food on the field (including tables an inventories) is less than MAX_FOOD, and then only with probability Food.RESPAWN_RATE. Food pieces are spawned at a random, non-colliding position on the field.
    
    Returns:
    
    all of the food on the ground or in the air on this field
  - getFood
```
Food getFood(Food.Type type)
```
    Returns the food piece on this field with the given type. That is, Food.getType() will return type for the returned food piece. If there is no food piece on this field that has the given type, this method returns null. There will never be two food pieces of the same type on the field at a time, so this method returns the unique food piece with the desired type. Note that food on a Table or in a player's Inventory is ignored, so if food of this type is on a table or in a player's inventory, this method returns null. The functionality of this method could be achieved by iterating over the set returned by getFood(), but this method exists for convenience.
    
    Parameters:
    
    type - the type of the desired food piece
    
    Returns:
    
    the food piece with the desired type, or null if none exists
  - getCollisions
```
Set<Collision> getCollisions()
```
    Returns a set of all of the collisions that occurred on the field on the previous turn. This set will be empty if no collisions occurred on the previous turn. Note that this set will never contain the same collision objects on two different turns.
    
    Returns:
    
    all of the collisions from the previous turn

Interface Field

Field Summary

Method Summary

Field Detail

DEPTH

WIDTH

MAX_FOOD

TOTAL_TURNS

Method Detail

getTurnNumber

getMatchType

getTeams

getTeam

getTeam

getPlayers

getPlayer

getFood

getFood

getCollisions