AIController

```
public interface AIController
```
The API for all AI interactions with the game. This API is unable to directly change any aspects of the game but it does serve as proxy between the AI and the user controlled Players.

Since:

2018-02-21

Version:

1.01.04

Author:

Joshua_Eddy

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`attack()` Performs an attack from the first `Country` to the second `Country` that was selected using `select(Country)`.
`void`	`clearSelected()` Clears the currently selected `Country`(s) from all the states.
`void`	`createBlockade(Country source, Country neighbour)` Creates a blockade that prevents the neighbour `Country` from transferring units to the source `Country`.
`void`	`forEachCountry(java.util.function.Consumer<Country> task)` Performs a `Consumer` function on all the `Country`s on the `Board`.
`void`	`forEachEnemyNeighbour(Country country, java.util.function.Consumer<Country> task)` Performs a `Consumer` task on every `Country` that is not owned by the `Player` owner of the specified `Country` and is a neighbour of that `Country`.
`void`	`forEachFriendlyCountry(Player player, java.util.function.Consumer<Country> task)` Performs a `Consumer` task on every `Country` that is owned by the specified `Player`.
`void`	`fortify()` Fortifies the second `Country` with one unit from the first `Country` to that was selected using `select(Country)`.
`Board`	`getBoard()` Retrieves the `Board`.
`Player`	`getCurrentPlayer()` Retrieves the current `Player`.
`java.util.Set<? extends Player>`	`getPlayers()` Retrieves all the `Player`s that are currently active in the game.
`Points`	`getPoints()` Retrieves all the point reward values for actions in the game.
`Unit`	`getUnitAbove(Unit unit)` Retrieves the `Unit` above the specified `Unit` in terms of strength.
`boolean`	`hasOpenLinkBetween(Country country, Country neighbour)` Retrieves whether the link between two `Country`s is open.
`boolean`	`isPathBetween(Country source, Country destination)` A pre-check for `fortify()`, this retrieves whether or not there is a valid path between two `Country`s owned by the same `Player`.
`void`	`reinforce()` Reinforces the `Country` selected using `select(Country)` with one unit.
`boolean`	`select(Country country)` Selects the `Country` from the current state.
`boolean`	`tradeUnit(Country country, Unit unit)` Converts as many of the `Unit`s from this `Army` into the `Unit` above in terms of strength.

- Method Detail
  - createBlockade
```
void createBlockade(Country source,
                    Country neighbour)
```
    Creates a blockade that prevents the neighbour Country from transferring units to the source Country. This also prevents attack from the neighbour however the source can still attack the neighbour. Blockades last 3 rounds.
    
    Parameters:
    
    source - The Country that is will be the source of the blockade.
    
    neighbour - The Country that is will be blocked from transferring units.
  - forEachCountry
```
void forEachCountry(java.util.function.Consumer<Country> task)
```
    Performs a Consumer function on all the Countrys on the Board.
    
    Parameters:
    
    task - Consumer of type Country.
  - reinforce
```
void reinforce()
```
    Reinforces the Country selected using select(Country) with one unit.
  - attack
```
void attack()
```
    Performs an attack from the first Country to the second Country that was selected using select(Country). This method also handles hiding an showing the UI elements of combat.
    
    This method will throw exceptions in the following scenarios:
    - The games current state is not 'Combat'.
    - There is not two countries selected using select(Country).
  - fortify
```
void fortify()
```
    Fortifies the second Country with one unit from the first Country to that was selected using select(Country).
    This method will throw exceptions in the following scenarios:
    - The games current state is not 'Fortify'.
    - There is not two countries selected using select(Country).
  - forEachFriendlyCountry
```
void forEachFriendlyCountry(Player player,
                            java.util.function.Consumer<Country> task)
```
    Performs a Consumer task on every Country that is owned by the specified Player.
    
    Parameters:
    
    player - Player
    
    task - Consumer
  - clearSelected
```
void clearSelected()
```
    Clears the currently selected Country(s) from all the states.
  - forEachEnemyNeighbour
```
void forEachEnemyNeighbour(Country country,
                           java.util.function.Consumer<Country> task)
```
    Performs a Consumer task on every Country that is not owned by the Player owner of the specified Country and is a neighbour of that Country.
    
    Parameters:
    
    country - Country
    
    task - Consumer
  - isPathBetween
```
boolean isPathBetween(Country source,
                      Country destination)
```
    A pre-check for fortify(), this retrieves whether or not there is a valid path between two Countrys owned by the same Player. If there is no Unit from the source Country that can traverse the path found this will return false;
    
    Parameters:
    
    source - The Country at the start of the path.
    
    destination - The Country at the end of the path.
    
    Returns:
    
    boolean
  - select
```
boolean select(Country country)
```
    Selects the Country from the current state.
    
    Parameters:
    
    country - Country to select.
    
    Returns:
    
    Whether or not the Country was selected.
  - tradeUnit
```
boolean tradeUnit(Country country,
                  Unit unit)
```
    Converts as many of the Units from this Army into the Unit above in terms of strength. If no Units were traded then this method will return false;
    
    Parameters:
    
    unit - Specified Unit to trade up.
    
    country - The Country containing the unit.
    
    Returns:
    
    Whether or not any Units were traded up.
  - hasOpenLinkBetween
```
boolean hasOpenLinkBetween(Country country,
                           Country neighbour)
```
    Retrieves whether the link between two Countrys is open.
    
    Parameters:
    
    country - The Country that is will be the source of the traversal.
    
    neighbour - The Country that is will be the destination of the traversal.
    
    Returns:
    
    Whether the link between two Countrys is open.
  - getCurrentPlayer
```
Player getCurrentPlayer()
```
    Retrieves the current Player.
    
    Returns:
    
    Current Player
  - getPlayers
```
java.util.Set<? extends Player> getPlayers()
```
    Retrieves all the Players that are currently active in the game.
    
    Returns:
    
    Set of Players
  - getPoints
```
Points getPoints()
```
    Retrieves all the point reward values for actions in the game.
    
    Returns:
    
    Points
  - getUnitAbove
```
Unit getUnitAbove(Unit unit)
```
    Retrieves the Unit above the specified Unit in terms of strength.
    
    Parameters:
    
    unit - The Unit above the specifed unit in terms of strength.
    
    Returns:
    
    Unit
  - getBoard
```
Board getBoard()
```
    Retrieves the Board.
    
    Returns:
    
    Board Returns the board.

Interface AIController

Method Summary

Method Detail

createBlockade

forEachCountry

reinforce

attack

fortify

forEachFriendlyCountry

clearSelected

forEachEnemyNeighbour

isPathBetween

select

tradeUnit

hasOpenLinkBetween

getCurrentPlayer

getPlayers

getPoints

getUnitAbove

getBoard