ch.sahits.game.openpatrician.model

Interface IPlayer

All Superinterfaces:

ICitizen, ICreditor, IShipOwner

All Known Subinterfaces:

IAIPlayer, IHumanPlayer

All Known Implementing Classes:

AIPlayer, HumanPlayer, Player

public interface IPlayer
extends ICitizen, IShipOwner

Base player in the game.

Author:

Andi Hotz, (c) Sahits GmbH, 2011 Created on Jun 15, 2011

Method Summary

Modifier and Type	Method and Description
void	addSelectableVessel(INavigableVessel vessel) Add a selectable vessel to the list.
void	addShip(IShip ship) Add a new ship for the player
List<IBuilding>	findBuildings(ICity city) Find all buildings of the player in the city
<T extends IBuilding> List<T>	findBuildings(ICity city, Class<T> buildingClass) Find all buildings in the city that are some subtype of the indicated class
List<INavigableVessel>	findShips(ICity city) Find all ships in a city
ITradingOffice	findTradingOffice(ICity city) Find the trading office of the player in the city.
ICareer	getCareerLevel() Retrieve the career level, which is either defined by EMilitantCareer or EEconomicCareer.
ICompany	getCompany() Retrieve the company data
List<IShip>	getFleet() Get a list of all ships
IPersonalData	getPersonalData() Retrieve the personal data of the player
MapSegmentedImage	getSegmentedMap() Retrieve the segmented image map.
List<INavigableVessel>	getSelectableVessels() Provide a different view on the fleet by containing all the vessels that can be selected.
ISpouseData	getSpouseData() Retrieve the personal data of the players spouse.
boolean	isMale() Check if the player is male
void	removeSelectableVessel(INavigableVessel vessel) Remove a selectable vessel from the list.
void	removeShip(IShip ship) Remove a ship for the player
void	setSegmentedMap(MapSegmentedImage mapSegments) Set or unset the image for a segmented map (treasure or pirate hideout).
void	updateRank(ESocialRank rank) Update to the new social rank

Methods inherited from interface ch.sahits.game.openpatrician.model.ICitizen

getHometown, getLastName, getName, getRank

Methods inherited from interface ch.sahits.game.openpatrician.model.city.ICreditor

receiveSum

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

getLastName, getName

Method Detail

getPersonalData

IPersonalData getPersonalData()

Retrieve the personal data of the player

Returns:

getSpouseData

ISpouseData getSpouseData()

Retrieve the personal data of the players spouse.

Returns:

getCompany

ICompany getCompany()

Retrieve the company data

Returns:

getFleet

List<IShip> getFleet()

Get a list of all ships

Returns:

getSelectableVessels

List<INavigableVessel> getSelectableVessels()

Provide a different view on the fleet by containing all the vessels that can be selected.

Returns:

list of vessels that can be activated.

addSelectableVessel

void addSelectableVessel(INavigableVessel vessel)

Add a selectable vessel to the list.

Parameters:

vessel - to be added

removeSelectableVessel

void removeSelectableVessel(INavigableVessel vessel)

Remove a selectable vessel from the list.

Parameters:

vessel - to be removed.

findShips

List<INavigableVessel> findShips(ICity city)

Find all ships in a city

Parameters:

city -

Returns:

addShip

void addShip(IShip ship)

Add a new ship for the player

Parameters:

ship -

removeShip

void removeShip(IShip ship)

Remove a ship for the player

Parameters:

ship -

isMale

boolean isMale()

Check if the player is male

Returns:

findBuildings

List<IBuilding> findBuildings(ICity city)

Find all buildings of the player in the city

Parameters:

city -

Returns:

findTradingOffice

ITradingOffice findTradingOffice(ICity city)

Find the trading office of the player in the city. If there is no trading office null will be returned.

Parameters:

city -

Returns:

findBuildings

<T extends IBuilding> List<T> findBuildings(ICity city,
                                            Class<T> buildingClass)

Find all buildings in the city that are some subtype of the indicated class

Parameters:

city -

buildingClass -

Returns:

updateRank

void updateRank(ESocialRank rank)

Update to the new social rank

Parameters:

rank -

getCareerLevel

ICareer getCareerLevel()

Retrieve the career level, which is either defined by EMilitantCareer or EEconomicCareer.

Returns:

setSegmentedMap

void setSegmentedMap(MapSegmentedImage mapSegments)

Set or unset the image for a segmented map (treasure or pirate hideout).

Parameters:

mapSegments -

getSegmentedMap

MapSegmentedImage getSegmentedMap()

Retrieve the segmented image map.

Returns: