ch.sahits.game.openpatrician.model.city

Interface IShipyard

All Known Implementing Classes:

ShipyardState

public interface IShipyard

Interface defining the model of the ship yard.

Author:

Andi Hotz, (c) Sahits GmbH, 2013 Created on Mar 9, 2013

Method Summary

Methods

Modifier and Type	Method and Description
void	addShipBuildingOrder(IShipDueDate dueDate) Update the state with a building order.
void	addShipBuildingOrder(IShipDueDate dueDate, com.google.common.base.Optional<TimedTask> task) Add an order for building a new ship to the list.
void	addShipRefitOrder(IShipDueDate dueDate, com.google.common.base.Optional<TimedTask> task) Add an order for refitting a ship to the list.
void	addShipRepairOrder(IShipDueDate dueDate, com.google.common.base.Optional<TimedTask> task) Add an order for repairing a ship to the list.
void	addShipToRepairList(IShipDueDate dueDate) Add a ship to the repair list.
void	addToRefitList(IShipDueDate dueDate)
int	calculateBuildTime(EShipType type) Calculate the build time for the ship of type.
int	calculateConstructionCosts(EShipType type) Calculate the labor costs for building a new ship of the indicated type.
int	calculateRefitCosts(EShipType type, int levels) Calculate the labor costs for the refit based on the ship type and how many levels should be upgraded.
int	calculateRefitTime(EShipType type) Calculate the time in days it takes for refitting.
int	calculateRepairCosts(int repairTime, int materialCosts) Calculate the repair costs.
int	calculateRepairMaterialCosts(IShip ship, int damage) Calculate the material costs for the repair.
int	calculateRepairTime(EShipType type) Calculate the repair time for the ship of type.
void	cancelRepair(IShip ship) Cancel the repair of the ship.
void	cancelShipBuildingOrder(org.joda.time.DateTime finish) Cancel the order of the building, finished on the given date.
EShipType[]	getBuildableShipTypes() Retrieve a list of all the types of ships this yard can build.
org.joda.time.DateTime	getBuildCompleteDate(EShipType type) Retrieve the date when the building of a new ship will be finished.
ICity	getCity() Retrieve the city the shipyard belongs to.
List<IShipDueDate>	getShipBuildingList() Retrieve an immutable list of the ships that are ordered to be built on this shipyard.
List<IShipDueDate>	getShipRepairList() Retrieve the list of all ships that are to be repaired.

Method Detail

getCity

ICity getCity()

Retrieve the city the shipyard belongs to.

Returns:

getShipBuildingList

List<IShipDueDate> getShipBuildingList()

Retrieve an immutable list of the ships that are ordered to be built on this shipyard.

Returns:

immutable list of ship due dates.

getBuildCompleteDate

org.joda.time.DateTime getBuildCompleteDate(EShipType type)

Retrieve the date when the building of a new ship will be finished.

Parameters:

type - of the ship to be built

Returns:

end date of the building

addShipBuildingOrder

void addShipBuildingOrder(IShipDueDate dueDate,
                        com.google.common.base.Optional<TimedTask> task)

Add an order for building a new ship to the list.

Parameters:

dueDate - when the ship is finished building

task - that is executed on completion.

addShipRepairOrder

void addShipRepairOrder(IShipDueDate dueDate,
                      com.google.common.base.Optional<TimedTask> task)

Add an order for repairing a ship to the list.

Parameters:

dueDate - when the ship is finished repairing

task - that is executed on completion.

addShipRefitOrder

void addShipRefitOrder(IShipDueDate dueDate,
                     com.google.common.base.Optional<TimedTask> task)

Add an order for refitting a ship to the list.

Parameters:

dueDate - when the ship is refitted

task - that is executed on completion.

addShipBuildingOrder

void addShipBuildingOrder(IShipDueDate dueDate)

Update the state with a building order. This method is used for synchronizing multiple instances of the same state in distributed systems (multiplayer). A task added in this manner belongs to another player and cannot be canceled.

Parameters:

dueDate - ship due date

cancelShipBuildingOrder

void cancelShipBuildingOrder(org.joda.time.DateTime finish)

Cancel the order of the building, finished on the given date.

Parameters:

finish - date

getShipRepairList

List<IShipDueDate> getShipRepairList()

Retrieve the list of all ships that are to be repaired.

Returns:

immutable list of all the repairing ships

addShipToRepairList

void addShipToRepairList(IShipDueDate dueDate)

Add a ship to the repair list. This method is used for synchronizing multiple instances of the same state in distributed systems (multiplayer). A task added in this manner belongs to another player and cannot be canceled.

Parameters:

dueDate - ship due date

cancelRepair

void cancelRepair(IShip ship)

Cancel the repair of the ship. No damage will be repaired

Parameters:

ship - which's repair order is to be canceled

addToRefitList

void addToRefitList(IShipDueDate dueDate)

calculateRepairCosts

int calculateRepairCosts(int repairTime,
                       int materialCosts)

Calculate the repair costs.

Parameters:

repairTime -

materialCosts -

Returns:

calculateRepairMaterialCosts

int calculateRepairMaterialCosts(IShip ship,
                               int damage)

Calculate the material costs for the repair.

Parameters:

ship -

damage -

Returns:

calculateRefitCosts

int calculateRefitCosts(EShipType type,
                      int levels)

Calculate the labor costs for the refit based on the ship type and how many levels should be upgraded.

Parameters:

type -

levels -

Returns:

calculateRefitTime

int calculateRefitTime(EShipType type)

Calculate the time in days it takes for refitting.

Parameters:

type - destination level

Returns:

time in days.

getBuildableShipTypes

EShipType[] getBuildableShipTypes()

Retrieve a list of all the types of ships this yard can build.

Returns:

calculateConstructionCosts

int calculateConstructionCosts(EShipType type)

Calculate the labor costs for building a new ship of the indicated type.

Parameters:

type - of the ship

Returns:

costs.

calculateBuildTime

int calculateBuildTime(EShipType type)

Calculate the build time for the ship of type.

Parameters:

type -

Returns:

calculateRepairTime

int calculateRepairTime(EShipType type)

Calculate the repair time for the ship of type.

Parameters:

type -

Returns: