IMap (OpenPatricianModel 0.6.0 API)

All Known Implementing Classes:

GameMap
```
public interface IMap
```
Interface defining the map that defines the game plan

Author:

Andi Hotz, (c) Sahits GmbH, 2011 Created on Sep 9, 2011

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`buildSettlement(ICity city, IPlayer player)` Add the settlement for the player.
`ICity`	`findCity(javafx.geometry.Point2D location)` Find the city at the given coordinates.
`ICity`	`findCity(String cityName)` Find a city by its name.
`List<ICity>`	`getCities()` Retrieve an unmodifiable list of all the cities in the map
`List<ICity>`	`getCities(IPlayer player)` Retrieve an unmodifiable list of all the cities in the map also including the once only visible to the player.
`javafx.geometry.Dimension2D`	`getDimension()` Retrieve the map dimensions
`List<IFutureTowns>`	`getFutureTowns()`
`List<ILandBridge>`	`getLandbridges()`
`String`	`getMapBWImagePath()` Retrieve the path for the black and white variant of the map.
`String`	`getMapImagePath()` Retrieve the path for the map image without the cities added.
`int`	`getNumberCities()` Retrieve the number of cities that are on the map.
`double`	`getNumberOfPixelPerKilometer()` Retrieve the scale of the map by providing a number to convert one kilometer into a number of pixels.
`List<PirateNest>`	`getPirateNests()`
`void`	`settlementBecomesTown(ICity city)` A founded settlement is complete and becomes a town.

- Method Detail
  - getNumberCities
```
int getNumberCities()
```
    Retrieve the number of cities that are on the map.
    
    Returns:
  - getCities
```
List<ICity> getCities()
```
    Retrieve an unmodifiable list of all the cities in the map
    
    Returns:
  - getCities
```
List<ICity> getCities(IPlayer player)
```
    Retrieve an unmodifiable list of all the cities in the map also including the once only visible to the player.
    
    Returns:
  - findCity
```
ICity findCity(String cityName)
```
    Find a city by its name.
    
    Parameters:
    
    cityName -
    
    Returns:
  - getDimension
```
javafx.geometry.Dimension2D getDimension()
```
    Retrieve the map dimensions
    
    Returns:
    
    dimesion
  - getMapImagePath
```
String getMapImagePath()
```
    Retrieve the path for the map image without the cities added.
    
    Returns:
  - getMapBWImagePath
```
String getMapBWImagePath()
```
    Retrieve the path for the black and white variant of the map.
    
    Returns:
  - getFutureTowns
```
List<IFutureTowns> getFutureTowns()
```
  - getLandbridges
```
List<ILandBridge> getLandbridges()
```
  - getPirateNests
```
List<PirateNest> getPirateNests()
```
  - buildSettlement
```
void buildSettlement(ICity city,
                     IPlayer player)
```
    Add the settlement for the player. A settlement is a new town to be founded and cannot yet be traded with. It is only reachable for the player.
    
    Parameters:
    
    city - to be founded
    
    player - for which this city is reachable
  - settlementBecomesTown
```
void settlementBecomesTown(ICity city)
```
    A founded settlement is complete and becomes a town. Thereby it is reachable for anyone.
    
    Parameters:
    
    city - that became a town
  - getNumberOfPixelPerKilometer
```
double getNumberOfPixelPerKilometer()
```
    Retrieve the scale of the map by providing a number to convert one kilometer into a number of pixels.
    
    Returns:
  - findCity
```
ICity findCity(javafx.geometry.Point2D location)
```
    Find the city at the given coordinates.
    
    Parameters:
    
    location - of the supposed city.
    
    Returns:
    
    instance of the city or null if at the coordinates there is no city.

Interface IMap

Method Summary

Method Detail

getNumberCities

getCities

getCities

findCity

getDimension

getMapImagePath

getMapBWImagePath

getFutureTowns

getLandbridges

getPirateNests

buildSettlement

settlementBecomesTown

getNumberOfPixelPerKilometer

findCity