ch.sahits.game.openpatrician.model.ship

Interface IShip

All Known Subinterfaces:

ICog, IConvoy, ICrayer, IHolk, ISnaikka

All Known Implementing Classes:

Cog, Crayer, Holk, Ship, Snaikka

public interface IShip

Model of a ship

Author:

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

Property Summary

Properties

Type	Property and Description
javafx.beans.property.IntegerProperty	numberOfSailors

Method Summary

Methods

Modifier and Type	Method and Description
void	addPassenger(IPerson passanger) Move a passenger to the ship.
void	damage(Object damage) Damage the ship
int	getCapacity() Available capacity of the ship, this represent the free storage in barrels
com.google.common.base.Optional<ICaptain>	getCaptian() Retrieve the captain of the ship.
int	getDamage() Retrieve the damage of the ship in percentage [0,100]
int	getLoad() Deprecated.
javafx.beans.binding.IntegerBinding	getLoadBinding() Retrieve the amount of load in barrels that is loaded in actual wares (no wappen or crew)
Set<IWare>	getLoadedWares() Retrieve a list of all loaded wares
javafx.geometry.Point2D	getLocation() Retrieve the location of the ship.
int	getMaxNumberOfSailors() Retrieve the maximum of sailors that can be put on the ship.
int	getMinNumberOfSailors() Retrieve the minimum of sailors needed to operate the ship.
String	getName() Retrieve the name of the of the ship
int	getNumberOfSailors() Retrieve the number of sailors on the ship.
int	getOccupiedSpace()
IPlayer	getOwner() Retrieve the owner of the ship.
com.google.common.base.Optional<IPerson>	getPassenger() Retrieve the passenger on the ship.
EShipType	getShipType() Retrieve the type of the ship.
EShipUpgrade	getShipUpgradeLevel() Retrieve the upgrade level of the ship.
IShipWeaponsLocation	getShipWeaponsLocation()
int	getSize() Total capacity of the ship in barrels
int	getUpgradeSpaceReduction() Retrieve the reduction of the load capacity based on the upgrade level.
int	getValue() Retrieve the current value of the ship without its cargo
AmountablePrice<IWare>	getWare(IWare ware) Retrieve the amount of ware loaded
int	getWeaponAmount(IWeapon weaponType) Retrieve the amount of weapons on the ship
boolean	hasWeapons() check if weapons are on board
boolean	isAvailable() Indicate if the ship is available.
boolean	isPiratingShip() Flag indicating if the pirate flag is set.
boolean	isUpgradable() Check if the ship can be upgraded
void	leavePassanger() Passenger leave ship.
int	load(IWare ware, int amount, int avgPrice) Load the ware in the specified amount onto the ship.
void	move(IWeapon weaponType, int amount) Move weapons in or out.
javafx.beans.property.IntegerProperty	numberOfSailorsProperty()
void	repair() Repair the damage
void	setAvailable(boolean available) Set the available flag on the ship.
void	setCaptain(ICaptain captain) Set the captain on the ship
void	setLocation(javafx.geometry.Point2D location) Set the location of the ship.
void	setName(String name) Set the ships name
void	setNumberOfSailors(int nbSailors) Set the number of sailors.
void	setOccupiedSpace(int space)
void	setOwner(IPlayer player) Define the owner of the ship
int	unload(IWare ware, int amount) Unload the specified quantity of the ware.
void	upgrade() Upgrade the ship if it is upgradable

Property Detail

numberOfSailors

Method Detail

getSize

int getSize()

Total capacity of the ship in barrels

Returns:

getCapacity

int getCapacity()

Available capacity of the ship, this represent the free storage in barrels

Returns:

isUpgradable

boolean isUpgradable()

Check if the ship can be upgraded

Returns:

upgrade

void upgrade()

Upgrade the ship if it is upgradable

getName

String getName()

Retrieve the name of the of the ship

Returns:

setName

void setName(String name)

Set the ships name

Parameters:

name -

getLoadedWares

Set<IWare> getLoadedWares()

Retrieve a list of all loaded wares

Returns:

load

int load(IWare ware,
       int amount,
       int avgPrice)

Load the ware in the specified amount onto the ship. The amount uses the size specified by the ware

Parameters:

ware - to be loaded

amount - of items the ware

avgPrice - average price of one item of the ware

Returns:

amount actually loaded

unload

int unload(IWare ware,
         int amount)

Unload the specified quantity of the ware. The amount uses the size specified by the ware

Parameters:

ware - to be unloaded

amount - amount of items of ware to unload

Returns:

amount of the ware unloaded

getDamage

int getDamage()

Retrieve the damage of the ship in percentage [0,100]

Returns:

damage

void damage(Object damage)

Damage the ship

Parameters:

damage -

repair

void repair()

Repair the damage

getUpgradeSpaceReduction

int getUpgradeSpaceReduction()

Retrieve the reduction of the load capacity based on the upgrade level. The reduction is in barrel that reduces the initial size

Returns:

reduction in barrels

getLoad

@Deprecated
int getLoad()

Deprecated.

Retrieve the amount of load in barrels that is loaded in actual wares (no wappen or crew)

Returns:

amount of loaded wares in barrels

getLoadBinding

javafx.beans.binding.IntegerBinding getLoadBinding()

Retrieve the amount of load in barrels that is loaded in actual wares (no wappen or crew)

Returns:

amount of loaded wares in barrels

getWare

AmountablePrice<IWare> getWare(IWare ware)

Retrieve the amount of ware loaded

Parameters:

ware -

Returns:

hasWeapons

boolean hasWeapons()

check if weapons are on board

Returns:

getValue

int getValue()

Retrieve the current value of the ship without its cargo

Returns:

getNumberOfSailors

int getNumberOfSailors()

Retrieve the number of sailors on the ship.

Returns:

setNumberOfSailors

void setNumberOfSailors(int nbSailors)

Set the number of sailors.

Parameters:

nbSailors - .

numberOfSailorsProperty

javafx.beans.property.IntegerProperty numberOfSailorsProperty()

getMinNumberOfSailors

int getMinNumberOfSailors()

Retrieve the minimum of sailors needed to operate the ship.

Returns:

getMaxNumberOfSailors

int getMaxNumberOfSailors()

Retrieve the maximum of sailors that can be put on the ship. This amount depends on the ship type as well as the amount of load.

Returns:

getCaptian

com.google.common.base.Optional<ICaptain> getCaptian()

Retrieve the captain of the ship. There might not be a captain present.

Returns:

setCaptain

void setCaptain(ICaptain captain)

Set the captain on the ship

Parameters:

captain -

move

void move(IWeapon weaponType,
        int amount)

Move weapons in or out.

Parameters:

weaponType - SWORD | BOW | CROSSBOW | MUSKET

amount -

getWeaponAmount

int getWeaponAmount(IWeapon weaponType)

Retrieve the amount of weapons on the ship

Parameters:

weaponType - SWORD | BOW | CROSSBOW | MUSKET

Returns:

amount available on the ship

addPassenger

void addPassenger(IPerson passanger)

Move a passenger to the ship. The ship may only contain one passanger.

Parameters:

passanger -

leavePassanger

void leavePassanger()

Passenger leave ship.

getPassenger

com.google.common.base.Optional<IPerson> getPassenger()

Retrieve the passenger on the ship.

Returns:

optional wrapped around the passenger.

getLocation

javafx.geometry.Point2D getLocation()

Retrieve the location of the ship.

Returns:

setLocation

void setLocation(javafx.geometry.Point2D location)

Set the location of the ship.

Parameters:

location - of the ship

getOwner

IPlayer getOwner()

Retrieve the owner of the ship. The owner cannot be retrieved if the pirate flag is set.

Returns:

isPiratingShip

boolean isPiratingShip()

Flag indicating if the pirate flag is set. This means the owner can not be retrieved.

Returns:

getShipType

EShipType getShipType()

Retrieve the type of the ship.

Returns:

setOwner

void setOwner(IPlayer player)

Define the owner of the ship

Parameters:

player -

getShipUpgradeLevel

EShipUpgrade getShipUpgradeLevel()

Retrieve the upgrade level of the ship.

Returns:

getShipWeaponsLocation

IShipWeaponsLocation getShipWeaponsLocation()

isAvailable

boolean isAvailable()

Indicate if the ship is available. A ship may be unavailable during repair or upgrade.

Returns:

setAvailable

void setAvailable(boolean available)

Set the available flag on the ship.

Parameters:

available -

getOccupiedSpace

int getOccupiedSpace()

setOccupiedSpace

void setOccupiedSpace(int space)