ch.sahits.game.openpatrician.model.ship.impl

Class Ship

java.lang.Object

ch.sahits.game.openpatrician.model.ship.impl.Ship

All Implemented Interfaces:

IShip

Direct Known Subclasses:

Cog, Crayer, Holk, Snaikka

public abstract class Ship
extends Object
implements IShip

Property Summary

Properties

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

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	available
private com.google.common.base.Optional<ICaptain>	captian
protected int	fitness Fitness of the ship.
private int	initialValue Initial value of the ship
private LateIntegerBinding	loadBinding Binding representing the current load.
private Map<IWare,AmountablePrice<IWare>>	loadedWare Store the wares loaded on the ship together with their amount.
private Map<IWeapon,Integer>	loadedWeapons
private javafx.geometry.Point2D	location
private int	maxSailors
private int	minNumberOfSailors
protected String	name Name of the ship
private javafx.beans.property.IntegerProperty	nbSailors
private int	occupiedSpace Space occupied by wares not owned by the owner
private IPlayer	owner
private com.google.common.base.Optional<IPerson>	passenger
private boolean	piratingShip
private int	reductionLevel1
private int	reductionLevel2
private static double	SAILOR_NEEDS_SPACE Amount of barrels space a sailor needs
protected EShipUpgrade	shipUpgradeLevel State of the design standard level
private IShipWeaponsLocation	shipWeaponsLocation
private int	size Size in barrels

Constructor Summary

Constructors

Modifier	Constructor and Description
(package private)	Ship(int initialValue, int minNumberOfSailors, int maxSailors) Constructor in place for backward compatability.
protected	Ship(Properties shipConfiguration)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPassenger(IPerson passanger) Move a passenger to the ship.
protected void	clearLoadedWares() Clear all loaded wares.
private int	ensureCapacity(int amount) Check if the amount can be loaded
int	getCapacity() Available capacity of the ship, this represent the free storage in barrels
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
int	getMaxNumberOfSailors() Retrieve the maximum of sailors that can be put on the ship.
private EShipSide	getNextFreeSide(IWeapon weapon) Retrieve the side of the next free slot where the weapon can be placed.
private int	getNextFreeSlot(IWeapon weapon, EShipSide side) Retrieve the next free slot for the weapon on the side.
int	getNumberOfSailors() Gets the value of the property numberOfSailors.
IPlayer	getOwner() Retrieve the owner of the ship.
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
private int	internalLoadCalculation()
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	setCaptain(ICaptain captain) Set the captain on the ship
void	setNumberOfSailors(int nbSailors) Sets the value of the property numberOfSailors.
int	unload(IWare ware, int amount) Unload the specified quantity of the ware.
void	upgrade() Upgrade the ship if it is upgradable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ch.sahits.game.openpatrician.model.ship.IShip

damage, getCaptian, getDamage, getLocation, getMinNumberOfSailors, getName, getOccupiedSpace, getPassenger, getShipType, getShipUpgradeLevel, getShipWeaponsLocation, getSize, isAvailable, isPiratingShip, repair, setAvailable, setLocation, setName, setOccupiedSpace, setOwner

Property Detail

numberOfSailors

Specified by:

numberOfSailorsProperty in interface IShip

Field Detail

SAILOR_NEEDS_SPACE

private static final double SAILOR_NEEDS_SPACE

Amount of barrels space a sailor needs

See Also:

Constant Field Values

shipUpgradeLevel

protected EShipUpgrade shipUpgradeLevel

State of the design standard level

name

protected String name

Name of the ship

loadedWare

private Map<IWare,AmountablePrice<IWare>> loadedWare

Store the wares loaded on the ship together with their amount. The amount is ware specific

loadBinding

private LateIntegerBinding loadBinding

Binding representing the current load.

loadedWeapons

private Map<IWeapon,Integer> loadedWeapons

shipWeaponsLocation

private IShipWeaponsLocation shipWeaponsLocation

initialValue

private final int initialValue

Initial value of the ship

minNumberOfSailors

private final int minNumberOfSailors

maxSailors

private final int maxSailors

captian

private com.google.common.base.Optional<ICaptain> captian

passenger

private com.google.common.base.Optional<IPerson> passenger

fitness

protected int fitness

Fitness of the ship. This is reduced as it is damaged

nbSailors

private javafx.beans.property.IntegerProperty nbSailors

location

private javafx.geometry.Point2D location

owner

private IPlayer owner

piratingShip

private boolean piratingShip

available

private boolean available

occupiedSpace

private int occupiedSpace

Space occupied by wares not owned by the owner

size

private int size

Size in barrels

reductionLevel1

private int reductionLevel1

reductionLevel2

private int reductionLevel2

Constructor Detail

Ship

protected Ship(Properties shipConfiguration)

Ship

Ship(int initialValue,
    int minNumberOfSailors,
    int maxSailors)

Constructor in place for backward compatability.

Parameters:

initialValue -

minNumberOfSailors -

maxSailors -

Method Detail

getMaxNumberOfSailors

public int getMaxNumberOfSailors()

Description copied from interface: IShip

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.

Specified by:

getMaxNumberOfSailors in interface IShip

Returns:

setCaptain

public void setCaptain(ICaptain captain)

Description copied from interface: IShip

Set the captain on the ship

Specified by:

setCaptain in interface IShip

isUpgradable

public boolean isUpgradable()

Description copied from interface: IShip

Check if the ship can be upgraded

Specified by:

isUpgradable in interface IShip

Returns:

upgrade

public void upgrade()

Description copied from interface: IShip

Upgrade the ship if it is upgradable

Specified by:

upgrade in interface IShip

getLoadedWares

public Set<IWare> getLoadedWares()

Description copied from interface: IShip

Retrieve a list of all loaded wares

Specified by:

getLoadedWares in interface IShip

Returns:

load

public 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 This method is not thread safe as it is only intended to be accessed by one thread at a time

Specified by:

load in interface IShip

Parameters:

ware - to be loaded

amount - of items the ware

avgPrice - average price of one item of the ware

Returns:

amount actually loaded

ensureCapacity

private int ensureCapacity(int amount)

Check if the amount can be loaded

Parameters:

amount -

Returns:

unload

public int unload(IWare ware,
         int amount)

Unload the specified quantity of the ware. The amount uses the size specified by the ware This method is not thread safe as it is only intended to be accessed by one thread at a time

Specified by:

unload in interface IShip

Parameters:

ware - to be unloaded

amount - amount of items of ware to unload

Returns:

amount of the ware unloaded

getLoad

@Deprecated
public int getLoad()

Deprecated.

Description copied from interface: IShip

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

Specified by:

getLoad in interface IShip

Returns:

amount of loaded wares in barrels

internalLoadCalculation

private int internalLoadCalculation()

getLoadBinding

public javafx.beans.binding.IntegerBinding getLoadBinding()

Description copied from interface: IShip

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

Specified by:

getLoadBinding in interface IShip

Returns:

amount of loaded wares in barrels

clearLoadedWares

protected void clearLoadedWares()

Clear all loaded wares. This method is only intended for testing

getWare

public AmountablePrice<IWare> getWare(IWare ware)

Description copied from interface: IShip

Retrieve the amount of ware loaded

Specified by:

getWare in interface IShip

Returns:

getNextFreeSide

private EShipSide getNextFreeSide(IWeapon weapon)

Retrieve the side of the next free slot where the weapon can be placed. check first port and then starboard. There is no free solt on either side, null will be returned.

Parameters:

weapon - to be placed

Returns:

EShipSide.PORT, EShipSide.STARBOARD or null

getNextFreeSlot

private int getNextFreeSlot(IWeapon weapon,
                  EShipSide side)

Retrieve the next free slot for the weapon on the side. The slots are checked from stern to bow. If there is no free slot a negative number will be returned

Parameters:

weapon - to be placed

side - to be checked EShipSide.PORT or EShipSide.STARBOARD

Returns:

slot index or negative number

hasWeapons

public boolean hasWeapons()

Description copied from interface: IShip

check if weapons are on board

Specified by:

hasWeapons in interface IShip

Returns:

getValue

public int getValue()

Description copied from interface: IShip

Retrieve the current value of the ship without its cargo

Specified by:

getValue in interface IShip

Returns:

getNumberOfSailors

public int getNumberOfSailors()

Gets the value of the property numberOfSailors.

Specified by:

getNumberOfSailors in interface IShip

Returns:

setNumberOfSailors

public void setNumberOfSailors(int nbSailors)

Sets the value of the property numberOfSailors.

Specified by:

setNumberOfSailors in interface IShip

Parameters:

nbSailors - .

numberOfSailorsProperty

public javafx.beans.property.IntegerProperty numberOfSailorsProperty()

Specified by:

numberOfSailorsProperty in interface IShip

move

public void move(IWeapon weaponType,
        int amount)

Description copied from interface: IShip

Move weapons in or out.

Specified by:

move in interface IShip

Parameters:

weaponType - SWORD | BOW | CROSSBOW | MUSKET

getWeaponAmount

public int getWeaponAmount(IWeapon weaponType)

Description copied from interface: IShip

Retrieve the amount of weapons on the ship

Specified by:

getWeaponAmount in interface IShip

Parameters:

weaponType - SWORD | BOW | CROSSBOW | MUSKET

Returns:

amount available on the ship

addPassenger

public void addPassenger(IPerson passanger)

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

Specified by:

addPassenger in interface IShip

Parameters:

passanger -

getOwner

public IPlayer getOwner()

Description copied from interface: IShip

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

Specified by:

getOwner in interface IShip

Returns:

leavePassanger

public void leavePassanger()

Passenger leave ship.

Specified by:

leavePassanger in interface IShip

getCapacity

public int getCapacity()

Description copied from interface: IShip

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

Specified by:

getCapacity in interface IShip

Returns:

getUpgradeSpaceReduction

public int getUpgradeSpaceReduction()

Description copied from interface: IShip

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

Specified by:

getUpgradeSpaceReduction in interface IShip

Returns:

reduction in barrels