UnitController

```
public interface UnitController
```
Class associated to a given unit that contains all methods to give orders (like attacking, moving, etc.), or to get information about the current board state.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`attack(Location loc)` Orders this unit to attack the given location.
`void`	`buildFarm(Direction dir)` Orders this unit to build a farm following the given direciton.
`boolean`	`canAttack()` Returns if this unit can attack this turn.
`boolean`	`canAttack(Location loc)` Returns if this unit can attack the given location.
`boolean`	`canBuildFarm(Direction dir)` Returns if the unit can build a farm following the given direction.
`boolean`	`canDeposit()` Returns true if this unit can deposit food on an adjacent base or market.
`boolean`	`canDonate(int amount)` Returns if this unit can donate the given amount of toilet paper for the vaccine development.
`boolean`	`canGatherFood()` Returns if this unit can gather the food in a 3x3 area around this unit.
`boolean`	`canMove()` Returns if this unit can move this turn.
`boolean`	`canMove(Direction direction)` Returns if this unit can move following the given direction.
`boolean`	`canPerformPCR()` Returns if this unit can perform a PCR test.
`boolean`	`canSenseLocation(Location loc)` Returns if the given location is inside this unit's vision range.
`boolean`	`canSpawn(UnitType type, Direction dir)` Returns if this unit can spawn a unit of the given type following the given direction.
`void`	`deposit()` Orders this unit to deposit food on an adjacent base or market.
`void`	`donate(int amount)` Donates the desired amount for the vaccine development.
`void`	`drawLine(Location loc1, Location loc2, int r, int g, int b)` Draws a line of a given color between the given locations.
`void`	`drawPoint(Location loc, int r, int g, int b)` Draws a point of a given color at a given location.
`void`	`gatherFood()` Orders this unit to gather food in a 3x3 area around it.
`int`	`getEnergyLeft()` Returns the amount of remaining energy.
`int`	`getEnergyUsed()` Returns the amount of energy used so far this turn.
`int`	`getFoodCarried()` Returns the food carried by this unit.
`UnitInfo`	`getInfo()` Returns the information about this unit.
`Location`	`getInitialLocation(Team team)` Returns the initial location of a given team.
`Location`	`getLocation()` Returns the location of this unit.
`Team`	`getOpponent()` Returns the opposing team.
`double`	`getPercentageOfEnergyLeft()` Returns the percentage of energy used so far this turn.
`double`	`getPercentageOfEnergyUsed()` Returns the percentage of remaining energy.
`int`	`getRound()` Returns the current round number.
`Team`	`getTeam()` Returns this unit's team.
`int`	`getToiletPaper()` Returns the amount of toilet paper available for the team.
`UnitType`	`getType()` Retruns this unit's type.
`Location[]`	`getVisibleLocations()` Returns an array with all visible locations inside the map.
`Location[]`	`getVisibleLocations(int radiusSquared)` Returns an array of all visible locations inside a given radius (squared) and inside the map.
`boolean`	`isAccessible(Location loc)` Returns if this unit can acces the given location.
`boolean`	`isCity(Location loc)` Returns if there's a city at the given location.
`boolean`	`isInfected()` Returns if this unit has symptoms of the virus.
`boolean`	`isObstructed(Location loc1, Location loc2)` Returns if there is any obstacle such that its interior intersects the segment between the given locations.
`boolean`	`isOutOfMap(Location loc)` Returns if a given location is out of the map.
`boolean`	`isStronglyInfected(Location loc)` Returns if the given location is strongly infected.
`void`	`move(Direction direction)` Orders this unit to move following the given direction.
`boolean`	`performPCR()` Returns the result of the PCR test.
`void`	`println(java.lang.Object o)` Writes the given object for debugging purposes.
`int`	`read(int i)` Returns the value written at the given location of the communication array.
`Location[]`	`senseCities()` Returns an array with the location of all visible cities.
`Location[]`	`senseCities(int radiusSquared)` Returns an array with the location of all visible cities inside a given radius around this unit.
`FarmInfo`	`senseFarmAtLocation(Location loc)` Returns the information about the farm at the given location.
`FarmInfo[]`	`senseFarms()` Returns an array with the information about all farms which are visible by this unit.
`FarmInfo[]`	`senseFarms(int radiusSquared)` Returns an array with the information about all visible farms inside a given radius (squared) around this unit.
`Location[]`	`senseObstacles()` Returns an array with the location of all visible obstacles.
`Location[]`	`senseObstacles(int radiusSquared)` Returns an array with the location of all visible obstacles inside a given radius around this unit.
`UnitInfo`	`senseUnitAtLocation(Location loc)` Returns the information about the unit at the given location.
`UnitInfo[]`	`senseUnits()` Returns an array with the information of all visible units.
`UnitInfo[]`	`senseUnits(int radiusSquared)` Returns an array with the information of all visible units inside a given radius around this unit.
`UnitInfo[]`	`senseUnits(int radiusSquared, Team team, boolean complementary, boolean includeNeutral)` Returns an array with the information of all visible units of a given team inside a given radius around this unit.
`UnitInfo[]`	`senseUnits(Team team)` Returns an array with the information of all visible units of a given team.
`UnitInfo[]`	`senseUnits(Team team, boolean complementary, boolean includeNeutral)` Returns an array with the information of all visible units of a given team.
`void`	`spawn(UnitType type, Direction dir)` Orders this unit to spawn a unit of a given type following the given direction.
`int`	`toiletPaperDonated()` Returns the amount of toilet paper donated for the vaccine development.
`boolean`	`vaccinated()` Returns if this unit is vaccinated or not.
`void`	`write(int i, int val)` Writes a given value at a given location of the communication array.
`void`	`yield()` Ends the turn.

- Method Detail
  - getInfo
```
UnitInfo getInfo()
```
    Returns the information about this unit. It costs 10 energy.
    
    Returns:
    
    the information about this unit.
  - getLocation
```
Location getLocation()
```
    Returns the location of this unit. It costs 5 energy.
    
    Returns:
    
    the location of this unit.
  - getTeam
```
Team getTeam()
```
    Returns this unit's team. It costs 5 energy.
    
    Returns:
    
    this unit's team.
  - getOpponent
```
Team getOpponent()
```
    Returns the opposing team. It costs 5 energy.
    
    Returns:
    
    the opposing team.
  - getInitialLocation
```
Location getInitialLocation(Team team)
```
    Returns the initial location of a given team. It costs 10 energy.
    
    Parameters:
    
    team - Given team.
    
    Returns:
    
    the initial location of a given team.
  - isInfected
```
boolean isInfected()
```
    Returns if this unit has symptoms of the virus. It costs 1 energy.
    
    Returns:
    
    if this unit has symptoms of the virus.
  - canPerformPCR
```
boolean canPerformPCR()
```
    Returns if this unit can perform a PCR test. It returns true if and only if the team has the necessary amount of toilet paper. It costs 1 energy.
    
    Returns:
    
    if this unit can perform a PCR test.
  - performPCR
```
boolean performPCR()
```
    Returns the result of the PCR test. There's penalty the unit couldn't perform the test. It costs 10 energy.
    
    Returns:
    
    the result of the PCR test.
  - getFoodCarried
```
int getFoodCarried()
```
    Returns the food carried by this unit. It costs 1 energy.
    
    Returns:
    
    the food carried by this unit.
  - canDonate
```
boolean canDonate(int amount)
```
    Returns if this unit can donate the given amount of toilet paper for the vaccine development. Returns true if and only if the team has the required toilet paper and the unit is not under construction. It costs 1 energy.
    
    Parameters:
    
    amount - Given amount.
    
    Returns:
    
    if this unit can donate the given amount of toilet paper for the vaccine development.
  - donate
```
void donate(int amount)
```
    Donates the desired amount for the vaccine development. There's a penalty if the team doesn't have the necessary resources. It costs 10 energy.
    
    Parameters:
    
    amount - Desired amount.
  - toiletPaperDonated
```
int toiletPaperDonated()
```
    Returns the amount of toilet paper donated for the vaccine development. It costs 1 energy.
    
    Returns:
    
    the amount of toilet paper donated for the vaccine development.
  - vaccinated
```
boolean vaccinated()
```
    Returns if this unit is vaccinated or not. Returns true if and only if this unit's team successfully created a vaccine for the virus. It costs 1 energy.
    
    Returns:
    
    if this unit is vaccinated or not.
  - canMove
```
boolean canMove()
```
    Returns if this unit can move this turn. It returns true if and only if this unit is not under construction, is not a structure and has less than 1 movement cooldown. It costs 10 energy.
    
    Returns:
    
    if this unit can move this turn.
  - canAttack
```
boolean canAttack()
```
    Returns if this unit can attack this turn. It returns true if and only this unit is not under construction, is not a structure, and has less than 1 attack cooldown. It costs 10 energy.
    
    Returns:
    
    if this unit can attack this turn.
  - canMove
```
boolean canMove(Direction direction)
```
    Returns if this unit can move following the given direction. There's a penalty if the given direction is null. It costs 5 energy.
    
    Parameters:
    
    direction - Given direction.
    
    Returns:
    
    if this unit can move following the given direction.
  - move
```
void move(Direction direction)
```
    Orders this unit to move following the given direction. There's a penalty if the unit cannot do so. It costs 20 energy.
    
    Parameters:
    
    direction - Given direction.
  - isObstructed
```
boolean isObstructed(Location loc1,
                     Location loc2)
```
    Returns if there is any obstacle such that its interior intersects the segment between the given locations. If any of the locations is out of the map or if there is only obstacles at its endpoints it returns false. There's penalty if any of the given locations are outside of this unit's vision range. It costs 10 energy.
    
    Parameters:
    
    loc1 - First location.
    
    loc2 - Second location.
    
    Returns:
    
    if there is any obstacle such that its interior intersects the segment between the given locations.
  - canAttack
```
boolean canAttack(Location loc)
```
    Returns if this unit can attack the given location. If the location is out of range or out of the map it returns false. There's penalty if the given location is null. It costs 10 energy.
    
    Parameters:
    
    loc - Given location.
    
    Returns:
    
    if this unit can attack the given location.
  - attack
```
void attack(Location loc)
```
    Orders this unit to attack the given location. There's penalty if the unit cannot do so. It costs 20 energy.
    
    Parameters:
    
    loc - Given location.
  - canSenseLocation
```
boolean canSenseLocation(Location loc)
```
    Returns if the given location is inside this unit's vision range. There's penalty if the given location is null. It costs 5 energy.
    
    Parameters:
    
    loc - Given location.
    
    Returns:
    
    if the given location is inside this unit's vision range.
  - senseFarmAtLocation
```
FarmInfo senseFarmAtLocation(Location loc)
```
    Returns the information about the farm at the given location. There's penalty if the given location is out of vision range, out of the map or if it is null. In these situations and when there's no farm it returns null. It costs 10 energy.
    
    Parameters:
    
    loc - Given location.
    
    Returns:
    
    the information about the farm at the given location.
  - isCity
```
boolean isCity(Location loc)
```
    Returns if there's a city at the given location. There's penalty if the given location is null or out of vision range. In these situations or when the given location is out of the map it returns false. It costs 10 energy.
    
    Parameters:
    
    loc - Posicio objectiu.
    
    Returns:
    
    if there's a city at the given location.
  - isOutOfMap
```
boolean isOutOfMap(Location loc)
```
    Returns if a given location is out of the map. There's penalty if the given location is null or out of vision range. It costs 5 energy.
    
    Parameters:
    
    loc - Given location.
    
    Returns:
    
    if a given location is out of the map.
  - getVisibleLocations
```
Location[] getVisibleLocations(int radiusSquared)
```
    Returns an array of all visible locations inside a given radius (squared) and inside the map. There's penalty if the given radius is negative. It costs 200 energy.
    
    Parameters:
    
    radiusSquared - Given radius (squared).
    
    Returns:
    
    an array of all visible locations inside a given radius (squared).
  - senseUnitAtLocation
```
UnitInfo senseUnitAtLocation(Location loc)
```
    Returns the information about the unit at the given location. If there's no unit it returns null. There's penalty if the given location is null or out of the map. It costs 10 energy.
    
    Parameters:
    
    loc - Given location.
    
    Returns:
    
    the information about the unit at the given location.
  - senseFarms
```
FarmInfo[] senseFarms(int radiusSquared)
```
    Returns an array with the information about all visible farms inside a given radius (squared) around this unit. There's penalty if the given radius is negative. It costs 200 energy.
    
    Parameters:
    
    radiusSquared - Given radius (squared).
    
    Returns:
    
    an array with the information about all visible farms inside a given radius (squared) around this unit.
  - senseFarms
```
FarmInfo[] senseFarms()
```
    Returns an array with the information about all farms which are visible by this unit. It costs 200 energy.
    
    Returns:
    
    an array with the information about all farms which are visible by this unit.
  - senseCities
```
Location[] senseCities(int radiusSquared)
```
    Returns an array with the location of all visible cities inside a given radius around this unit. There's penalty if the given radius is negative. It costs 200 energy.
    
    Parameters:
    
    radiusSquared - Given radius (squared).
    
    Returns:
    
    an array with the location of all visible cities inside a given radius around this unit.
  - senseCities
```
Location[] senseCities()
```
    Returns an array with the location of all visible cities. It costs 200 energy.
    
    Returns:
    
    an array with the location of all visible cities. It costs 200 energy.
  - senseObstacles
```
Location[] senseObstacles(int radiusSquared)
```
    Returns an array with the location of all visible obstacles inside a given radius around this unit. There's penalty if the radius is negative. It costs 200 energy.
    
    Parameters:
    
    radiusSquared - Given radius (squared).
    
    Returns:
    
    an array with the location of all visible obstacles inside a given radius around this unit.
  - senseObstacles
```
Location[] senseObstacles()
```
    Returns an array with the location of all visible obstacles. It costs 200 energy.
    
    Returns:
    
    an array with the location of all visible obstacles.
  - senseUnits
```
UnitInfo[] senseUnits(int radiusSquared)
```
    Returns an array with the information of all visible units inside a given radius around this unit. There's penalty if the given radius is negative. It costs 200 energy.
    
    Parameters:
    
    radiusSquared - Given radius (squared).
    
    Returns:
    
    an array with the information about all visible units inside a given radius around this unit.
  - senseUnits
```
UnitInfo[] senseUnits(int radiusSquared,
                      Team team,
                      boolean complementary,
                      boolean includeNeutral)
```
    Returns an array with the information of all visible units of a given team inside a given radius around this unit. There's penalty if the radius is negative or if the team is null. It costs 200 energy. Retorna un array amb l'informacio de totes les unitats d'un equip donat, visibles en un radi (al quadrat) donat al voltant de la unitat associada a aquest controlador. Hi ha penalitzacio si es passa un radi negatiu. Si es passa un equip null es tornen les unitats de tots els equips que satisfacin els criteris anteriors. Costa 200 d'energia.
    
    Parameters:
    
    radiusSquared - Given radius (squared).
    
    team - Given team (squared).
    
    radiusSquared - Given radius (squared).
    
    team - Given team.
    
    complementary - If true, it returns the units that are not from the given team instead.
    
    includeNeutral - If false, it does not include neutral units.
    
    Returns:
    
    an array with the information of all visible units of a given team inside a given radius around this unit. /** Returns an array with the information of all visible units of a given team inside a given radius around this unit. There's penalty if the radius is negative or if the team is null. It costs 200 energy.
  - senseUnits
```
UnitInfo[] senseUnits(Team team,
                      boolean complementary,
                      boolean includeNeutral)
```
    Returns an array with the information of all visible units of a given team. It costs 200 energy.
    
    Parameters:
    
    team - Given team.
    
    complementary - If true, it returns the units that are not from the given team instead.
    
    includeNeutral - If false, it does not include neutral units.
    
    Returns:
    
    an array with the information of all visible units of a given team.
  - senseUnits
```
UnitInfo[] senseUnits()
```
    Returns an array with the information of all visible units. It costs 200 energy.
    
    Returns:
    
    an array with the information of all visible units.
  - senseUnits
```
UnitInfo[] senseUnits(Team team)
```
    Returns an array with the information of all visible units of a given team. It costs 200 units.
    
    Parameters:
    
    team - Given team.
    
    Returns:
    
    an array with the information of all visible units of a given team.
  - getVisibleLocations
```
Location[] getVisibleLocations()
```
    Returns an array with all visible locations inside the map. It costs 200 energy.
    
    Returns:
    
    an array with all visible locations.
  - canSpawn
```
boolean canSpawn(UnitType type,
                 Direction dir)
```
    Returns if this unit can spawn a unit of the given type following the given direction. It returns true if and only if this unit can create the desired type, it is not under construction, the team has the required amount of toilet paper, and the adjacent location following the given direction is accessible by the given unit type. There's penalty if the given direction or type are null. It costs 20 energy.
    
    Parameters:
    
    type - Given type.
    
    dir - Given direction.
    
    Returns:
    
    if this unit can spawn a unit of the given type following the given direction.
  - spawn
```
void spawn(UnitType type,
           Direction dir)
```
    Orders this unit to spawn a unit of a given type following the given direction. There's penalty if it cannot do so. It costs 20 energy.
    
    Parameters:
    
    type - Given type.
    
    dir - Given direction.
  - canBuildFarm
```
boolean canBuildFarm(Direction dir)
```
    Returns if the unit can build a farm following the given direction. Returns true if and only if the unit is an essential worker that is not in construction, if there is not a farm, city or structure at the adjacent location following the given direction, and if the team has the required amount of toilet paper to build the farm. There's penalty if the direction given is null. It costs 10 energy..
    
    Parameters:
    
    dir - Given direction.
    
    Returns:
    
    if the unit can build a farm following the given direction.
  - buildFarm
```
void buildFarm(Direction dir)
```
    Orders this unit to build a farm following the given direciton. There's penalty if the unit cannot do so. It costs 20 energy.
    
    Parameters:
    
    dir - Given direction.
  - getType
```
UnitType getType()
```
    Retruns this unit's type. It costs 5 energy.
    
    Returns:
    
    this unit's type.
  - canGatherFood
```
boolean canGatherFood()
```
    Returns if this unit can gather the food in a 3x3 area around this unit. It returns true if and only if this unit is an essential worker and is not under construction. It costs 10 energy.
    
    Returns:
    
    if this unit can gather the food in a 3x3 area around this unit.
  - gatherFood
```
void gatherFood()
```
    Orders this unit to gather food in a 3x3 area around it. There's penalty if the unit cannot do so. It costs 10 energy.
  - canDeposit
```
boolean canDeposit()
```
    Returns true if this unit can deposit food on an adjacent base or market. It returns true if and only if this unit is an essential worker that is not under construction and has an adjacent market or base of the same team. It costs 10 energy.
    
    Returns:
    
    if this unit can deposit food on an adjacent base or market.
  - deposit
```
void deposit()
```
    Orders this unit to deposit food on an adjacent base or market. There's penalty if the unit cannot do so. It costs 20 energy.
  - isAccessible
```
boolean isAccessible(Location loc)
```
    Returns if this unit can acces the given location. This method returns true if and only if the given location is on the map and is accessible by this unit type (it doesn't take into account if this location has already a unit on top of it). There's penalty if the given location is null or outside of the vision range of this unit. It costs 10 energy.
    
    Parameters:
    
    loc - Given location.
    
    Returns:
    
    if this unit can acces the given location.
  - isStronglyInfected
```
boolean isStronglyInfected(Location loc)
```
    Returns if the given location is strongly infected. There's penalty if the given location is null or outside of the vision range of this unit. It costs 5 energy.
    
    Parameters:
    
    loc - Given location.
    
    Returns:
    
    if the given location is strongly infected.
  - getRound
```
int getRound()
```
    Returns the current round number. It costs 1 energy.
    
    Returns:
    
    the current round number.
  - getEnergyUsed
```
int getEnergyUsed()
```
    Returns the amount of energy used so far this turn. It costs 1 energy.
    
    Returns:
    
    the amount of energy used so far this turn.
  - getEnergyLeft
```
int getEnergyLeft()
```
    Returns the amount of remaining energy. It costs 1 energy.
    
    Returns:
    
    the amount of remaining energy.
  - getPercentageOfEnergyLeft
```
double getPercentageOfEnergyLeft()
```
    Returns the percentage of energy used so far this turn. It costs 1 energy.
    
    Returns:
    
    the percentage of energy used so far this turn.
  - getPercentageOfEnergyUsed
```
double getPercentageOfEnergyUsed()
```
    Returns the percentage of remaining energy. It costs 1 energy.
    
    Returns:
    
    the percentage of remaining energy.
  - write
```
void write(int i,
           int val)
```
    Writes a given value at a given location of the communication array. There's penalty if the given location is out of range. It costs 1 energy.
    
    Parameters:
    
    i - Array location.
    
    val - Value.
  - read
```
int read(int i)
```
    Returns the value written at the given location of the communication array. It costs 1 energy.
    
    Parameters:
    
    i - Array location.
    
    Returns:
    
    the value written at the given location of the communication array.
  - println
```
void println(java.lang.Object o)
```
    Writes the given object for debugging purposes. It costs 10 energy.
    
    Parameters:
    
    o - Object.
  - drawPoint
```
void drawPoint(Location loc,
               int r,
               int g,
               int b)
```
    Draws a point of a given color at a given location. Costs 10 energy.
    
    Parameters:
    
    loc - Given location.
    
    r - r-Coordinate of the color.
    
    b - b-Coordinate of the color.
    
    g - g-Coordinate of the color.
  - drawLine
```
void drawLine(Location loc1,
              Location loc2,
              int r,
              int g,
              int b)
```
    Draws a line of a given color between the given locations. It costs 10 energy.
    
    Parameters:
    
    loc1 - First location.
    
    loc2 - Second location.
    
    r - r-Coordinate of the color.
    
    b - b-Coordinate of the color.
    
    g - g-Coordinate of the color.
  - getToiletPaper
```
int getToiletPaper()
```
    Returns the amount of toilet paper available for the team. It costs 1 energy.
    
    Returns:
    
    the amount of toilet paper available for the team.
  - yield
```
void yield()
```
    Ends the turn. It costs 0 energy.

Interface UnitController

Method Summary

Method Detail

getInfo

getLocation

getTeam

getOpponent

getInitialLocation

isInfected

canPerformPCR

performPCR

getFoodCarried

canDonate

donate

toiletPaperDonated

vaccinated

canMove

canAttack

canMove

move

isObstructed

canAttack

attack

canSenseLocation

senseFarmAtLocation

isCity

isOutOfMap

getVisibleLocations

senseUnitAtLocation

senseFarms

senseFarms

senseCities

senseCities

senseObstacles

senseObstacles

senseUnits

senseUnits

senseUnits

senseUnits

senseUnits

getVisibleLocations

canSpawn

spawn

canBuildFarm

buildFarm

getType

canGatherFood

gatherFood

canDeposit

deposit

isAccessible

isStronglyInfected

getRound

getEnergyUsed

getEnergyLeft

getPercentageOfEnergyLeft

getPercentageOfEnergyUsed

write

read

println

drawPoint

drawLine

getToiletPaper

yield