UnitController

```
public interface UnitController
```
Each unit has associated an instance of this class. It allows the unit to interact with the environment.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`canEnlistAstronaut(Direction dir, int oxygen, CarePackage carePackage)` Returns if this unit can enlist an astronaut at a given direction, with a given quantity of oxygen, and equipped with a given carePackage (null if no care package).
`boolean`	`canPerformAction(ActionType action, Direction dir, int value)` Returns if a given action can be performed following the given direction with a particular numerical value (only used for JUMP action).
`boolean`	`canSenseLocation(Location loc)` Returns if the unit can sense target location.
`void`	`cleanBroadcastBuffer()` Erases all elements from the broadcast buffer.
`void`	`drawLineDebug(Location fromLoc, Location toLoc, int r, int g, int b)` Draws a segment on the map between a given pair of locations and with a given color scheme (in rgb-coordinates).
`void`	`drawPointDebug(Location loc, int r, int g, int b)` Draws a point on the map at a given location and with a given color scheme (in rgb-coordinates).
`void`	`enlistAstronaut(Direction dir, int oxygen, CarePackage carePackage)` Attempts to enlist an astronaut at a given direction, with a given quantity of oxygen, and equipped with a given carePackage (null if no care package).
`void`	`eraseBroadcastBuffer(int n)` Erases the first n elements from the broadcast buffer.
`AstronautInfo`	`getAstronautInfo()` Returns the information about this unit if this unit is an astronaut.
`int`	`getEnergyLeft()` Returns this unit's remaining energy.
`int`	`getEnergyUsed()` Returns the energy used by this unit so far.
`int`	`getID()` Returns the ID of this unit.
`Location`	`getLocation()` Returns the location of this unit.
`int`	`getMapHeight()` Returns the height of the map.
`int`	`getMapWidth()` Returns the width of the map.
`Team`	`getOpponent()` Returns this unit's opponent.
`StructureInfo`	`getParent()` Returns the parent of this unit.
`double`	`getPercentageOfEnergyLeft()` Returns the fraction of remaining energy over this unit's total energy.
`double`	`getPercentageOfEnergyUsed()` Returns the percentage of this unit's total energy used so far.
`double`	`getRandomDouble()` Returns a randomly generated double.
`int`	`getRound()` Returns current game round.
`StructureInfo`	`getStructureInfo()` Returns the information about this unit if this unit is a structure.
`Team`	`getTeam()` Returns this unit's team.
`StructureType`	`getType()` Returns the type of this unit if this unit is a structure.
`boolean`	`isDomed(Location loc)` Returns true if the location is covered by a Dome.
`boolean`	`isOutOfMap(Location loc)` Returns if the given location is outside the map.
`boolean`	`isStructure()` Returns if this unit is a structure or not.
`boolean`	`isTerraformed(Location loc)` Returns true if the location is terraformed.
`void`	`killSelf()` This method kills this unit.
`void`	`performAction(ActionType action, Direction dir, int value)` Performs a given action following the given direction with a particular numerical value.
`BroadcastInfo`	`pollBroadcast()` Returns the front element of the broadcast buffer and removes that element from the buffer.
`void`	`println(java.lang.Object o)` Prints an object o for debug purposes.
`AstronautInfo`	`senseAstronaut(Location loc)` Returns the information of the astronaut at a given location.
`AstronautInfo[]`	`senseAstronauts(float radiusSquared, Team team)` Returns an array with all other astronauts of a given team that can be sensed by this unit inside a given radius around it.
`CarePackage`	`senseCarePackage(Location loc)` Returns the information of the care package at a given location (null if none).
`CarePackageInfo[]`	`senseCarePackages(float radiusSquared)` Returns an array with the information of all care packages that can be sensed by this unit inside a given radius around it.
`MapObject`	`senseObjectAtLocation(Location loc)` Returns the information of the object at a given location.
`Location[]`	`senseObjects(MapObject mapObject, float radiusSquared)` Returns an array with all visible objects inside the map and inside a given radius.
`StructureInfo`	`senseStructure(Location loc)` Returns the information of the structure at a given location.
`StructureInfo[]`	`senseStructures(float radiusSquared, Team team)` Returns an array with all other structures of a given team that can be sensed by this unit inside a given radius around it.
`TileType`	`senseTileType(Location loc)` Returns the tile type (LAND, WATER or HOT_ZONE) at a given location.
`void`	`yield()` Halts this unit's execution until the next round.

- Method Detail
  - getAstronautInfo
```
AstronautInfo getAstronautInfo()
```
    Returns the information about this unit if this unit is an astronaut. Otherwise, it returns null. It costs 1 energy.
    
    Returns:
    
    the information about this unit if this unit is an astronaut.
  - getStructureInfo
```
StructureInfo getStructureInfo()
```
    Returns the information about this unit if this unit is a structure. Otherwise, it returns null. It costs 1 energy.
    
    Returns:
    
    the information about this unit if this unit is a structure.
  - isStructure
```
boolean isStructure()
```
    Returns if this unit is a structure or not. It costs 1 energy.
    
    Returns:
    
    if this unit is a structure or not.
  - getLocation
```
Location getLocation()
```
    Returns the location of this unit. It costs 1 energy.
    
    Returns:
    
    the location of this unit.
  - getTeam
```
Team getTeam()
```
    Returns this unit's team. It costs 1 energy.
    
    Returns:
    
    this unit's team.
  - getOpponent
```
Team getOpponent()
```
    Returns this unit's opponent. It costs 1 energy.
    
    Returns:
    
    this unit's opponent.
  - getType
```
StructureType getType()
```
    Returns the type of this unit if this unit is a structure. Otherwise, it returns null. It costs 1 energy.
    
    Returns:
    
    the type of this unit.
  - getMapHeight
```
int getMapHeight()
```
    Returns the height of the map. It costs 1 energy
    
    Returns:
    
    the height of the map.
  - getMapWidth
```
int getMapWidth()
```
    Returns the width of the map. It costs 1 energy.
    
    Returns:
    
    the width of the map.
  - getID
```
int getID()
```
    Returns the ID of this unit. It costs 1 energy.
    
    Returns:
    
    the ID of this unit.
  - getParent
```
StructureInfo getParent()
```
    Returns the parent of this unit. It costs 1 energy.
    
    Returns:
    
    the parent of this unit.
  - canSenseLocation
```
boolean canSenseLocation(Location loc)
```
    Returns if the unit can sense target location. It returns true if and only if the location is on the map, inside the unit's vision range, and if it has enough illumination. It receives a penalty if the given location is null. It costs 10 energy.
    
    Parameters:
    
    loc - Target location.
    
    Returns:
    
    if the unit can sense target location.
  - isOutOfMap
```
boolean isOutOfMap(Location loc)
```
    Returns if the given location is outside the map. There is a penalty if the given location is null. It costs 10 energy.
    
    Parameters:
    
    loc - Given location
    
    Returns:
    
    if the given location is outside the map.
  - senseObjectAtLocation
```
MapObject senseObjectAtLocation(Location loc)
```
    Returns the information of the object at a given location. It prioritizes neutral buildings, then if the tile is terraformed, then if the tile is domed, and lastly the tile type. It receives a penalty if the given location cannot be sensed by this unit. It costs 10 energy.
    
    Parameters:
    
    loc - Given location
    
    Returns:
    
    the information of the object at a given location.
  - senseObjects
```
Location[] senseObjects(MapObject mapObject,
                        float radiusSquared)
```
    Returns an array with all visible objects inside the map and inside a given radius. It receives a penalty if the given radius is negative. If the object is null, it returns all visible tiles. It costs 200 energy.
    
    Parameters:
    
    mapObject - Given object
    
    radiusSquared - Given radius (squared)
    
    Returns:
    
    an array with all visible objects inside the map and inside a given radius.
  - senseAstronaut
```
AstronautInfo senseAstronaut(Location loc)
```
    Returns the information of the astronaut at a given location. It returns null if there is no astronaut. It receives a penalty if the given location cannot be sensed by this unit. It costs 10 energy.
    
    Parameters:
    
    loc - Given location
    
    Returns:
    
    the information of the astronaut at a given location.
  - senseStructure
```
StructureInfo senseStructure(Location loc)
```
    Returns the information of the structure at a given location. It returns null if there is no structure. It receives a penalty if the given location cannot be sensed by this unit. It costs 10 energy.
    
    Parameters:
    
    loc - Given location
    
    Returns:
    
    the information of the structure at a given location.
  - senseAstronauts
```
AstronautInfo[] senseAstronauts(float radiusSquared,
                                Team team)
```
    Returns an array with all other astronauts of a given team that can be sensed by this unit inside a given radius around it. It receives a penalty if the radius is negative. If the team is null, it returns the astronauts of all teams. It costs 200 energy.
    
    Parameters:
    
    radiusSquared - Given radius (squared)
    
    team - Given team
    
    Returns:
    
    an array with all other astronauts of a given team that can be sensed by this unit inside a given radius around it.
  - senseStructures
```
StructureInfo[] senseStructures(float radiusSquared,
                                Team team)
```
    Returns an array with all other structures of a given team that can be sensed by this unit inside a given radius around it. It receives a penalty if the radius is negative. If the team is null, it returns the structures of all teams. It costs 200 energy.
    
    Parameters:
    
    radiusSquared - Given radius (squared)
    
    team - Given team
    
    Returns:
    
    an array with all other structures of a given team that can be sensed by this unit inside a given radius around it.
  - isTerraformed
```
boolean isTerraformed(Location loc)
```
    Returns true if the location is terraformed. It receives a penalty if the given location cannot be sensed by this unit. It costs 10 energy.
    
    Parameters:
    
    loc - Given location
    
    Returns:
    
    if the location is terraformed.
  - isDomed
```
boolean isDomed(Location loc)
```
    Returns true if the location is covered by a Dome. It receives a penalty if the given location cannot be sensed by this unit. It costs 10 energy.
    
    Parameters:
    
    loc - Given location
    
    Returns:
    
    if the location is covered by a Dome.
  - senseCarePackage
```
CarePackage senseCarePackage(Location loc)
```
    Returns the information of the care package at a given location (null if none). There is a penalty if the given location cannot be sensed. It costs 10 energy
    
    Parameters:
    
    loc - given location.
    
    Returns:
    
    the information of the care package at a given location.
  - senseCarePackages
```
CarePackageInfo[] senseCarePackages(float radiusSquared)
```
    Returns an array with the information of all care packages that can be sensed by this unit inside a given radius around it. It receives a penalty if the radius is negative. It costs 200 energy.
    
    Parameters:
    
    radiusSquared - Given radius (squared)
    
    Returns:
    
    an array with the information of all care packages that can be sensed by this unit inside a given radius around it.
  - senseTileType
```
TileType senseTileType(Location loc)
```
    Returns the tile type (LAND, WATER or HOT_ZONE) at a given location. It receives a penalty if the given location cannot be sensed by this unit. It costs 10 energy.
    
    Parameters:
    
    loc - Given location
    
    Returns:
    
    the tile type at a given location.
  - killSelf
```
void killSelf()
```
    This method kills this unit. It costs 1 energy.
  - canPerformAction
```
boolean canPerformAction(ActionType action,
                         Direction dir,
                         int value)
```
    Returns if a given action can be performed following the given direction with a particular numerical value (only used for JUMP action). Note that of these actions may not use both parameters (see Game Description). For example, MOVE only uses the direction, and therefore the numerical value is ignored. It costs 20 energy.
    
    Parameters:
    
    action - Action type.
    
    dir - Given direction (not used by BROADCAST action).
    
    value - Given numerical value (only used by JUMP action).
    
    Returns:
    
    if a given action can be performed following the given direction with a particular numerical value. Here's a list of when actions can be performed: JUMP: Value is between 1 and MAX_JUMP, the given direction is either NORTH, SOUTH, EAST or WEST and the resulting location is accessible. MOVE: The unit's movement cooldown is less than 1 and the resulting location is accessible. SABOTAGE: The resulting location contains either a structure (or a dome or a hyperjump) or an astronaut TERRAFORM: The resulting location is accessible, can be terraformed and is not yet terraformed. BUILD_SETTLEMENT: The astronaut has a SETTLEMENT package and the resulting location is passable and not occupied by a unit. BUILD_HYPERJUMP: The astronaut has a HYPERJUMP package and the resulting location is passable and does not contain another structure. BUILD_DOME:The astronaut has a DOME package and the resulting location is passable and does not contain another structure. RETRIEVE: The resulting location contains a package. BROADCAST: Always true. TRANSFER_OXYGEN: The resulting location contains a unit (either astronaut or non-neutral structure).
  - performAction
```
void performAction(ActionType action,
                   Direction dir,
                   int value)
```
    Performs a given action following the given direction with a particular numerical value. There is a penalty if the given action cannot be performed. Read canPerformAction for more information. It costs 20 energy.
    
    Parameters:
    
    action - Action type.
    
    dir - Given direction.
    
    value - Given numerical value.
  - canEnlistAstronaut
```
boolean canEnlistAstronaut(Direction dir,
                           int oxygen,
                           CarePackage carePackage)
```
    Returns if this unit can enlist an astronaut at a given direction, with a given quantity of oxygen, and equipped with a given carePackage (null if no care package). It costs 20 energy.
    
    Parameters:
    
    dir - Given direction
    
    oxygen - Given oxygen
    
    carePackage - Given care Package
    
    Returns:
    
    if this unit can build a unit of a given type at a given direction.
  - enlistAstronaut
```
void enlistAstronaut(Direction dir,
                     int oxygen,
                     CarePackage carePackage)
```
    Attempts to enlist an astronaut at a given direction, with a given quantity of oxygen, and equipped with a given carePackage (null if no care package). There is a penalty if this action cannot be performed. It costs 20 energy.
    
    Parameters:
    
    dir - Given direction
    
    oxygen - Given oxygen
    
    carePackage - Given care Package
  - pollBroadcast
```
BroadcastInfo pollBroadcast()
```
    Returns the front element of the broadcast buffer and removes that element from the buffer. It returns null if empty. It costs 10 energy.
    
    Returns:
    
    the front element of the broadcast buffer and removes that element from the buffer.
  - cleanBroadcastBuffer
```
void cleanBroadcastBuffer()
```
    Erases all elements from the broadcast buffer. It costs 10 energy.
  - eraseBroadcastBuffer
```
void eraseBroadcastBuffer(int n)
```
    Erases the first n elements from the broadcast buffer. There is a penalty if n is negative. It costs 10 energy.
    
    Parameters:
    
    n - Number of elements to be erased.
  - getRound
```
int getRound()
```
    Returns current game round. It costs 1 energy.
    
    Returns:
    
    current game round.
  - getEnergyUsed
```
int getEnergyUsed()
```
    Returns the energy used by this unit so far. It costs 1 energy.
    
    Returns:
    
    the energy used by this unit so far.
  - getEnergyLeft
```
int getEnergyLeft()
```
    Returns this unit's remaining energy. It costs 1 energy.
    
    Returns:
    
    this unit's remaining energy.
  - getPercentageOfEnergyLeft
```
double getPercentageOfEnergyLeft()
```
    Returns the fraction of remaining energy over this unit's total energy. It costs 1 energy.
    
    Returns:
    
    the fraction of remaining energy over this unit's total energy.
  - getPercentageOfEnergyUsed
```
double getPercentageOfEnergyUsed()
```
    Returns the percentage of this unit's total energy used so far. It costs 1 energy.
    
    Returns:
    
    the percentage of this unit's total energy used so far.
  - println
```
void println(java.lang.Object o)
```
    Prints an object o for debug purposes. It costs 20 energy.
    
    Parameters:
    
    o - given object.
  - drawPointDebug
```
void drawPointDebug(Location loc,
                    int r,
                    int g,
                    int b)
```
    Draws a point on the map at a given location and with a given color scheme (in rgb-coordinates). It receives a penalty if the location is null or if the color scheme is not valid. It costs 20 energy.
    
    Parameters:
    
    loc - Given location.
    
    r - r-coordinate
    
    g - g-coordinate
    
    b - b-coordinate
  - drawLineDebug
```
void drawLineDebug(Location fromLoc,
                   Location toLoc,
                   int r,
                   int g,
                   int b)
```
    Draws a segment on the map between a given pair of locations and with a given color scheme (in rgb-coordinates). It receives a penalty if any of the location are null or if the color scheme is not valid. It costs 20 energy.
    
    Parameters:
    
    fromLoc - First location.
    
    toLoc - Second location.
    
    r - r-coordinate
    
    g - g-coordinate
    
    b - b-coordinate
  - getRandomDouble
```
double getRandomDouble()
```
    Returns a randomly generated double. If this is the only random method used by both teams, all of their games with a fixed seed are identical. It costs 1 energy.
    
    Returns:
    
    a randomly generated double.
  - yield
```
void yield()
```
    Halts this unit's execution until the next round. It costs 1 energy.

Interface UnitController

Method Summary

Method Detail

getAstronautInfo

getStructureInfo

isStructure

getLocation

getTeam

getOpponent

getType

getMapHeight

getMapWidth

getID

getParent

canSenseLocation

isOutOfMap

senseObjectAtLocation

senseObjects

senseAstronaut

senseStructure

senseAstronauts

senseStructures

isTerraformed

isDomed

senseCarePackage

senseCarePackages

senseTileType

killSelf

canPerformAction

performAction

canEnlistAstronaut

enlistAstronaut

pollBroadcast

cleanBroadcastBuffer

eraseBroadcastBuffer

getRound

getEnergyUsed

getEnergyLeft

getPercentageOfEnergyLeft

getPercentageOfEnergyUsed

println

drawPointDebug

drawLineDebug

getRandomDouble

yield