Ship (OpenPatricianModel 0.8.0-RC1 API)

java.lang.Object
- ch.sahits.game.openpatrician.model.ship.impl.Ship

All Implemented Interfaces:

INavigableVessel, IShip

Direct Known Subclasses:

Cog, Crayer, Holk, Snaikka
```
public abstract class Ship
extends Object
implements IShip
```

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.IntegerProperty`	`numberOfSailors`
`javafx.beans.binding.BooleanBinding`	`passengerPresent` Binding indicating if a passenger is present.

Field Summary

Fields
Modifier and Type	Field and Description
`private AmountableProvider`	`amountableProvider`
`private boolean`	`available`
`private Optional<ICaptain>`	`captian`
`private int`	`distanceInKmForOneHealthPointReduction`
`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 org.apache.logging.log4j.Logger`	`logger`
`private LUIDProvider`	`luidProvider`
`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 IShipOwner`	`owner`
`private Optional<IPerson>`	`passenger`
`private javafx.beans.binding.BooleanBinding`	`passengerPresent`
`private int`	`passengerSpace`
`private boolean`	`pirateFlag`
`private DependentPropertyInitializer`	`propertyInitializer`
`private int`	`reductionLevel1`
`private int`	`reductionLevel2`
`protected EShipUpgrade`	`shipUpgradeLevel` State of the design standard level
`private IShipWeaponsLocation`	`shipWeaponsLocation`
`private int`	`size` Size in barrels
`private double`	`spacePerSailor` Amount of barrels space a sailor needs
`private double`	`topSpeed`
`private String`	`uuid`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Ship(Properties shipConfiguration)

Constructors
Modifier	Constructor and Description
`protected`	`Ship(Properties shipConfiguration)`

Method Summary

All Methods Instance Methods Concrete 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 LateIntegerBinding`	`createLoadBinding()`
`void`	`damage(int damage)` Damage the ship
`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
`double`	`getCurrentSpeed()` Current top speed of the ship.
`int`	`getDamage()` Retrieve the damage of the ship in percentage [0,100]
`int`	`getLoadableSpace()` Retrieve the total amount of space that is available to store stuff.
`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.
`IShipOwner`	`getOwner()` Retrieve the owner of the ship.
`boolean`	`getPirateFlag()` Indicate if the vessel has hissed the pirate flag (Jolly Roger) and the vessel therefore should be considered a pirate vessel.
`double`	`getTopSpeed()` Retrieve the speed of the vessel in kilometer per hour
`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 void`	`init()`
`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()`
`javafx.beans.binding.BooleanBinding`	`passengerPresentProperty()` Binding indicating if a passenger is present.
`void`	`setCaptain(ICaptain captain)` Set the captain on the ship
`void`	`setNumberOfSailors(int nbSailors)` Sets the value of the property numberOfSailors.
`void`	`setOwner(IShipOwner owner)` Define the owner of the ship
`void`	`togglePirateFlag()` Hiss or lower the pirate flag (Jolly Roger).
`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
getDistanceInKmForOneHealthPointReduction, getMinNumberOfSailors, getOccupiedSpace, getPassenger, getShipType, getShipUpgradeLevel, getShipWeaponsLocation, isAvailable, repair, setAvailable, setName, setOccupiedSpace, setShipWeaponsLocation

Methods inherited from interface ch.sahits.game.openpatrician.model.ship.INavigableVessel
getCaptian, getLocation, getName, getSize, getUuid, setLocation

- Property Detail
  - numberOfSailors
```
public javafx.beans.property.IntegerProperty numberOfSailorsProperty
```
    Specified by:
    
    numberOfSailorsProperty in interface IShip
    
    See Also:
    
    getNumberOfSailors(), setNumberOfSailors(int)
  - passengerPresent
```
public javafx.beans.binding.BooleanBinding passengerPresentProperty
```
    Specified by:
    
    passengerPresentProperty in interface IShip
- Field Detail
  - logger
```
private final org.apache.logging.log4j.Logger logger
```
  - spacePerSailor
```
@DependentValue(value="sailor.space.on.ship")
private double spacePerSailor
```
    Amount of barrels space a sailor needs
  - passengerSpace
```
@DependentValue(value="passenger.space.on.ship")
private int passengerSpace
```
  - distanceInKmForOneHealthPointReduction
```
private int distanceInKmForOneHealthPointReduction
```
  - luidProvider
```
@Autowired
private LUIDProvider luidProvider
```
  - 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.
  - topSpeed
```
private final double topSpeed
```
  - amountableProvider
```
@Autowired
private AmountableProvider amountableProvider
```
  - propertyInitializer
```
@Autowired
private DependentPropertyInitializer propertyInitializer
```
  - passengerPresent
```
private javafx.beans.binding.BooleanBinding passengerPresent
```
  - 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 Optional<ICaptain> captian
```
  - passenger
```
private 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 IShipOwner owner
```
  - available
```
private boolean available
```
  - occupiedSpace
```
private int occupiedSpace
```
    Space occupied by wares not owned by the owner
  - size
```
private final int size
```
    Size in barrels
  - reductionLevel1
```
private int reductionLevel1
```
  - reductionLevel2
```
private int reductionLevel2
```
  - uuid
```
private String uuid
```
  - pirateFlag
```
private boolean pirateFlag
```
- Constructor Detail
  - Ship
```
protected Ship(Properties shipConfiguration)
```
- Method Detail
  - init
```
@PostConstruct
private void init()
```
  - 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: INavigableVessel
    
    Retrieve a list of all loaded wares
    
    Specified by:
    
    getLoadedWares in interface INavigableVessel
    
    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 INavigableVessel
    
    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 INavigableVessel
    
    Parameters:
    
    ware - to be unloaded
    
    amount - amount of items of ware to unload
    
    Returns:
    
    amount of the ware unloaded
  - internalLoadCalculation
```
private int internalLoadCalculation()
```
  - getLoadBinding
```
public javafx.beans.binding.IntegerBinding getLoadBinding()
```
    Description copied from interface: INavigableVessel
    
    Retrieve the amount of load in barrels that is loaded in actual wares (no wappen or crew)
    
    Specified by:
    
    getLoadBinding in interface INavigableVessel
    
    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: INavigableVessel
    
    Retrieve the amount of ware loaded
    
    Specified by:
    
    getWare in interface INavigableVessel
    
    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 INavigableVessel
    
    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
    
    See Also:
    
    getNumberOfSailors(), setNumberOfSailors(int)
  - 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: INavigableVessel
    
    Retrieve the amount of weapons on the ship
    
    Specified by:
    
    getWeaponAmount in interface INavigableVessel
    
    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 IShipOwner getOwner()
```
    Description copied from interface: INavigableVessel
    
    Retrieve the owner of the ship. The owner cannot be retrieved if the pirate flag is set.
    
    Specified by:
    
    getOwner in interface INavigableVessel
    
    Returns:
  - setOwner
```
public void setOwner(IShipOwner owner)
```
    Description copied from interface: IShip
    
    Define the owner of the ship
    
    Specified by:
    
    setOwner in interface IShip
  - leavePassanger
```
public void leavePassanger()
```
    Passenger leave ship.
    
    Specified by:
    
    leavePassanger in interface IShip
  - getCapacity
```
public int getCapacity()
```
    Description copied from interface: INavigableVessel
    
    Available capacity of the ship, this represent the free storage in barrels
    
    Specified by:
    
    getCapacity in interface INavigableVessel
    
    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
  - createLoadBinding
```
private LateIntegerBinding createLoadBinding()
```
  - passengerPresentProperty
```
public javafx.beans.binding.BooleanBinding passengerPresentProperty()
```
    Description copied from interface: IShip
    
    Binding indicating if a passenger is present.
    
    Specified by:
    
    passengerPresentProperty in interface IShip
  - getDamage
```
public int getDamage()
```
    Description copied from interface: INavigableVessel
    
    Retrieve the damage of the ship in percentage [0,100]
    
    Specified by:
    
    getDamage in interface INavigableVessel
    
    Returns:
  - damage
```
public void damage(int damage)
```
    Description copied from interface: INavigableVessel
    
    Damage the ship
    
    Specified by:
    
    damage in interface INavigableVessel
  - getLoadableSpace
```
public int getLoadableSpace()
```
    Description copied from interface: INavigableVessel
    
    Retrieve the total amount of space that is available to store stuff. This is the total amount of space minus any space due to upgrades.
    
    Specified by:
    
    getLoadableSpace in interface INavigableVessel
    
    Returns:
  - getTopSpeed
```
public double getTopSpeed()
```
    Description copied from interface: INavigableVessel
    
    Retrieve the speed of the vessel in kilometer per hour
    
    Specified by:
    
    getTopSpeed in interface INavigableVessel
    
    Returns:
    
    speed of the vessel in kilometer per hour.
  - getPirateFlag
```
public boolean getPirateFlag()
```
    Description copied from interface: INavigableVessel
    
    Indicate if the vessel has hissed the pirate flag (Jolly Roger) and the vessel therefore should be considered a pirate vessel.
    
    Specified by:
    
    getPirateFlag in interface INavigableVessel
    
    Returns:
    
    true if the Jolly Roger is hissed.
  - togglePirateFlag
```
public void togglePirateFlag()
```
    Description copied from interface: INavigableVessel
    
    Hiss or lower the pirate flag (Jolly Roger).
    
    Specified by:
    
    togglePirateFlag in interface INavigableVessel
  - getCurrentSpeed
```
public double getCurrentSpeed()
```
    Description copied from interface: INavigableVessel
    
    Current top speed of the ship.
    
    Specified by:
    
    getCurrentSpeed in interface INavigableVessel
    
    Returns:
    
    speed of the vessel in kilometer per hour.

Class Ship

Property Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Property Detail

numberOfSailors

passengerPresent

Field Detail

logger

spacePerSailor

passengerSpace

distanceInKmForOneHealthPointReduction

luidProvider

shipUpgradeLevel

name

loadedWare

loadBinding

topSpeed

amountableProvider

propertyInitializer

passengerPresent

loadedWeapons

shipWeaponsLocation

initialValue

minNumberOfSailors

maxSailors

captian

passenger

fitness

nbSailors

location

owner

available

occupiedSpace

size

reductionLevel1

reductionLevel2

uuid

pirateFlag

Constructor Detail

Ship

Method Detail

init

getMaxNumberOfSailors

setCaptain

isUpgradable

upgrade

getLoadedWares

load

ensureCapacity

unload

internalLoadCalculation

getLoadBinding

clearLoadedWares

getWare

getNextFreeSide

getNextFreeSlot

hasWeapons

getValue

getNumberOfSailors

setNumberOfSailors

numberOfSailorsProperty

move

getWeaponAmount

addPassenger

getOwner

setOwner

leavePassanger

getCapacity

getUpgradeSpaceReduction

createLoadBinding

passengerPresentProperty

getDamage

damage

getLoadableSpace

getTopSpeed