ch.sahits.game.openpatrician.model.ship

Interface IShip

All Superinterfaces:

INavigableVessel

All Known Subinterfaces:

ICog, ICrayer, IHolk, ISnaikka

All Known Implementing Classes:

Cog, Crayer, Holk, Ship, Snaikka

public interface IShip
extends INavigableVessel

Model of a ship

Author:

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

Property Summary

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

Method Summary

Modifier and Type	Method and Description
void	addPassenger(IPerson passanger) Move a passenger to the ship.
int	getDistanceInKmForOneHealthPointReduction() Retrieve the distance in km the ship has to travel under normal conditions, for it's health to be reduced by one.
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.
int	getOccupiedSpace()
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	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
boolean	hasWeapons() check if weapons are on board
boolean	isAvailable() Indicate if the ship is available.
boolean	isUpgradable() Check if the ship can be upgraded
void	leavePassanger() Passenger leave 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	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	setName(String name) Set the ships name
void	setNumberOfSailors(int nbSailors) Set the number of sailors.
void	setOccupiedSpace(int space)
void	setOwner(IShipOwner player) Define the owner of the ship
void	setShipWeaponsLocation(IShipWeaponsLocation shipWeaponsLocation) Set the ships weapons location.
void	upgrade() Upgrade the ship if it is upgradable

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

damage, getCapacity, getCaptian, getCurrentSpeed, getDamage, getLoadableSpace, getLoadBinding, getLoadedWares, getLocation, getName, getNumberOfSailors, getOwner, getPirateFlag, getSize, getTopSpeed, getUuid, getWare, getWeaponAmount, load, setLocation, togglePirateFlag, unload

Property Detail

numberOfSailors

javafx.beans.property.IntegerProperty numberOfSailorsProperty

See Also:

setNumberOfSailors(int)

passengerPresent

javafx.beans.binding.BooleanBinding passengerPresentProperty

Binding indicating if a passenger is present.

Method Detail

isUpgradable

boolean isUpgradable()

Check if the ship can be upgraded

Returns:

upgrade

void upgrade()

Upgrade the ship if it is upgradable

setName

void setName(String name)

Set the ships name

Parameters:

name -

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

hasWeapons

boolean hasWeapons()

check if weapons are on board

Returns:

getValue

int getValue()

Retrieve the current value of the ship without its cargo

Returns:

setNumberOfSailors

void setNumberOfSailors(int nbSailors)

Set the number of sailors.

Parameters:

nbSailors - .

numberOfSailorsProperty

javafx.beans.property.IntegerProperty numberOfSailorsProperty()

See Also:

setNumberOfSailors(int)

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:

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 -

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

Optional<IPerson> getPassenger()

Retrieve the passenger on the ship.

Returns:

optional wrapped around the passenger.

getShipType

EShipType getShipType()

Retrieve the type of the ship.

Returns:

setOwner

void setOwner(IShipOwner 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)

passengerPresentProperty

javafx.beans.binding.BooleanBinding passengerPresentProperty()

Binding indicating if a passenger is present.

setShipWeaponsLocation

void setShipWeaponsLocation(IShipWeaponsLocation shipWeaponsLocation)

Set the ships weapons location.

Parameters:

shipWeaponsLocation -

getDistanceInKmForOneHealthPointReduction

int getDistanceInKmForOneHealthPointReduction()

Retrieve the distance in km the ship has to travel under normal conditions, for it's health to be reduced by one.

Returns:

number of km to be traveled.