ch.sahits.game.openpatrician.model.people

Interface IInformant

All Superinterfaces:

IPerson, ITavernPerson

All Known Implementing Classes:

InformantState

public interface IInformant
extends ITavernPerson

Provide the information the informant is willing to sell. The bits of information are optional, but one bit is always present.

Author:

Andi Hotz, (c) Sahits GmbH, 2013 Created on Jan 24, 2013

Property Summary

Properties inherited from interface ch.sahits.game.openpatrician.model.people.ITavernPerson

isPresentProperty

Method Summary

Modifier and Type	Method and Description
Optional<MapSegmentedImage>	getMapSectionPart(IPlayer player) The informant may also hold a map part for the player.
String	getName() Retreive the name of the informant
Optional<ch.sahits.datastructure.GenericPair<String,ICity>>	getPirateLocation() Possible information about the location of a pirate.
int	getPrice(IPlayer player) Get the price of the information.
Optional<ch.sahits.datastructure.GenericPair<ICity,IWare>>	getWareNeeded() Possible information about in which city which ware is needed.
Optional<ch.sahits.datastructure.GenericPair<ICity,IWare>>	getWareSurplus() Possible information about in which city which ware is available in surplus.
boolean	isShowMapIfAvailable()
void	setName(String name)
void	setNeededWare(ICity city, IWare ware) Set the information about the needed ware in the city.
void	setPirateLocation(ISeaPirate pirate, ICity city) Set the location of the pirate.
void	setPrice(int price)
void	setShowMapIfAvailable(boolean showMapIfAvailable)
void	setWareSurplus(ICity city, IWare ware) Set the information about the surplus ware in the city

Methods inherited from interface ch.sahits.game.openpatrician.model.people.ITavernPerson

arrive, getArrivalDate, getMaxDaysAbsent, getMaxDaysPresent, getNumberOfDaysSinceArrival, isPresent, isPresentProperty, leave, setCity

Method Detail

getPrice

int getPrice(IPlayer player)

Get the price of the information.

Parameters:

player - requesting the price

Returns:

getName

String getName()

Retreive the name of the informant

Returns:

getWareNeeded

Optional<ch.sahits.datastructure.GenericPair<ICity,IWare>> getWareNeeded()

Possible information about in which city which ware is needed.

Returns:

getWareSurplus

Optional<ch.sahits.datastructure.GenericPair<ICity,IWare>> getWareSurplus()

Possible information about in which city which ware is available in surplus.

Returns:

getPirateLocation

Optional<ch.sahits.datastructure.GenericPair<String,ICity>> getPirateLocation()

Possible information about the location of a pirate.

Returns:

setNeededWare

void setNeededWare(ICity city,
                   IWare ware)

Set the information about the needed ware in the city.

Parameters:

city -

ware -

setWareSurplus

void setWareSurplus(ICity city,
                    IWare ware)

Set the information about the surplus ware in the city

Parameters:

city -

ware -

setPirateLocation

void setPirateLocation(ISeaPirate pirate,
                       ICity city)

Set the location of the pirate.

Parameters:

pirate -

city -

getMapSectionPart

Optional<MapSegmentedImage> getMapSectionPart(IPlayer player)

The informant may also hold a map part for the player.

Parameters:

player - requesting player

Returns:

isShowMapIfAvailable

boolean isShowMapIfAvailable()

setShowMapIfAvailable

void setShowMapIfAvailable(boolean showMapIfAvailable)

setPrice

void setPrice(int price)

setName

void setName(String name)