Package ch.sahits.game.openpatrician.model.city.guild

Interface IMediterreanMap

All Known Implementing Classes:

MediterreanSeaMap

public interface IMediterreanMap

Model for the mediterrean map with all the explored spots and discovered cities.

Author:

Andi Hotz, (c) Sahits GmbH, 2016 Created on Nov 06, 2016

Method Summary

Modifier and Type	Method	Description
void	addTradeAgreement(IPlayer player, ITradeAgreement agreement)	Add a trade agreement for a player.
boolean	exploreSpot(IPlayer player, javafx.geometry.Point2D coordinates)	Player explored a spot and may have detected a trading spot.
java.util.Map<javafx.geometry.Point2D,IMediterreanCity>	getDiscoveredTradingSpots()	Retrieve a map of all discovered trading spot locations along with their names.
java.util.List<javafx.geometry.Point2D>	getExploredLocations(IPlayer player)	Retrieve a list of all discovered location for a player.
java.util.List<ITradeAgreement>	getTradeAgreements(IPlayer player)	Retreive the trade agreements for a specific player.

Method Detail

exploreSpot

boolean exploreSpot(IPlayer player,
                    javafx.geometry.Point2D coordinates)

Player explored a spot and may have detected a trading spot. Trading spots can be detected in a certain radius of the explored spot.

Parameters:

player - that does the exploring

coordinates - location that is explored

Returns:

true if a new trading spot was discovered.

getDiscoveredTradingSpots

java.util.Map<javafx.geometry.Point2D,IMediterreanCity> getDiscoveredTradingSpots()

Retrieve a map of all discovered trading spot locations along with their names.

Returns:

map of coordinates and names of trading spots in the mediterrenian.

getExploredLocations

java.util.List<javafx.geometry.Point2D> getExploredLocations(IPlayer player)

Retrieve a list of all discovered location for a player.

Parameters:

player - for which the location should be retrieved.

Returns:

list of all disovered locations.

addTradeAgreement

void addTradeAgreement(IPlayer player,
                       ITradeAgreement agreement)

Add a trade agreement for a player.

Parameters:

player - for whom to add an agreement

agreement - to be added.

getTradeAgreements

java.util.List<ITradeAgreement> getTradeAgreements(IPlayer player)

Retreive the trade agreements for a specific player.

Parameters:

player - for which the agreement should be looked up.

Returns:

list of trade agreements.