Package ch.sahits.game.openpatrician.model.sea

Interface IBlockade

  • All Known Implementing Classes:
    Blockade
    public interface IBlockade
    State of a single blockade.
    Author:
    Andi Hotz, (c) Sahits GmbH, 2016 Created on Apr 14, 2016

    • Method Detail

      • getAssemblyDate

        java.time.LocalDateTime getAssemblyDate()
        Date when the convoy is assembled to travel to the city to be blockaded.
        Returns:
        date when the fleet is assembled for the blockade

      • getEndBlockade

        java.time.LocalDateTime getEndBlockade()
        End date of the blockade.
        Returns:
        date when the blockade ends

      • getBlockadeConvoy

        IConvoy getBlockadeConvoy()
        Retrieve the blockade convoy
        Returns:
        convoy fleet executing the blockade

      • getShips

        java.util.List<IShip> getShips​(IPlayer player)
        Retrieve the ships of a certain player.
        Parameters:
        player - for which to retrieve the ships
        Returns:
        List of ships of the player in the blockade convoy

      • getShips

        java.util.List<IShip> getShips()
        Retrieve all ships for the blockade.
        Returns:
        list of ships in the convoy.

      • getPlayersWithRequestedShips

        java.util.List<IPlayer> getPlayersWithRequestedShips()
        Retrieve a list of players which have requested a ship
        Returns:
        list of player who should provide ships for the blockade convoy

      • getNumberOfRequestedShips

        int getNumberOfRequestedShips​(IPlayer player)
        Retrieve the number of ships that are requested.
        Parameters:
        player - for whom to retrieve the number of requested ships
        Returns:
        number of requested ships from player

      • addShips

        void addShips​(IPlayer player,
              java.util.List<IShip> shipList)
        Add a number of ships for a player to the blockade.
        Parameters:
        player - for whom to add ships to the blockade convoy
        shipList - list of ships to be added

      • setConvoy

        void setConvoy​(IConvoy convoy)
        Set the convoy.
        Parameters:
        convoy - for the blockade

      • getShipsToAuction

        java.util.List<IShip> getShipsToAuction()
        List containing ships that were captured during the blockade mission, that will be auctioned at the end.
        Returns:
        list of ships that are auctioned after blockade end.