rails.game.special
Class LocatedBonus

java.lang.Object
  rails.game.special.SpecialProperty
      rails.game.special.LocatedBonus

All Implemented Interfaces:

ConfigurableComponentI, Moveable, SpecialPropertyI

public class LocatedBonus
extends SpecialProperty

An object of class LocatedBonus represent extra income for the owning company, usually connected to certain map locations.

LocatedBonus objects are configured as Special Properties in CompanyManager.xml.

Author:

VosE

Nested Class Summary

Nested classes/interfaces inherited from interface rails.game.special.SpecialPropertyI

SpecialPropertyI.Priority

Field Summary

(package private) java.lang.String	locationCodes
(package private) java.util.List<MapHex>	locations
(package private) java.lang.String	name
(package private) int	value

Fields inherited from class rails.game.special.SpecialProperty

closingValue, conditionText, description, exercised, gameManager, holder, isORProperty, isSRProperty, lastIndex, log, originalCompany, permanent, priority, spMap, transferText, uniqueId, usableDuringOR, usableDuringSR, usableDuringTileLayingStep, usableDuringTokenLayingStep, usableIfOwnedByCompany, usableIfOwnedByPlayer, whenText

Fields inherited from interface rails.game.special.SpecialPropertyI

DEFAULT_PRIORITY

Fields inherited from interface rails.game.move.Moveable

AT_END

Constructor Summary

LocatedBonus()

Method Summary

void	configureFromXML(Tag tag) Instructs the component to configure itself from the provided XML element.
void	finishConfiguration(GameManagerI gameManager) This method is intended to be called for each configurable component, to perforn any initialisation activities that require any other components to be initialised first.
java.lang.String	getLocationNameString()
java.util.List<MapHex>	getLocations()
java.lang.String	getName()
int	getValue()
boolean	isExecutionable()
java.lang.String	toString()

Methods inherited from class rails.game.special.SpecialProperty

getByUniqueId, getClosingValue, getHelp, getHolder, getInfo, getOriginalCompany, getPriority, getTransferText, getUniqueId, init, isExercised, isORProperty, isSRProperty, isUsableDuringOR, isUsableDuringSR, isUsableDuringTileLayingStep, isUsableDuringTokenLayingStep, isUsableIfOwnedByCompany, isUsableIfOwnedByPlayer, moveTo, setCompany, setExercised, setExercised, setHolder, setPriority, setUsableDuringOR, setUsableDuringSR, setUsableDuringTileLayingStep, setUsableDuringTokenLayingStep, setUsableIfOwnedByCompany, setUsableIfOwnedByPlayer, toMenu

Methods inherited from class java.lang.Object

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

Field Detail

locationCodes

java.lang.String locationCodes

locations

java.util.List<MapHex> locations

name

java.lang.String name

value

int value

Constructor Detail

LocatedBonus

public LocatedBonus()

Method Detail

configureFromXML

public void configureFromXML(Tag tag)
                      throws ConfigurationException

Description copied from interface: ConfigurableComponentI

Instructs the component to configure itself from the provided XML element.

Specified by:

configureFromXML in interface ConfigurableComponentI

Overrides:

configureFromXML in class SpecialProperty

Throws:

ConfigurationException

finishConfiguration

public void finishConfiguration(GameManagerI gameManager)
                         throws ConfigurationException

Description copied from interface: ConfigurableComponentI

This method is intended to be called for each configurable component, to perforn any initialisation activities that require any other components to be initialised first. This includes creating any required relationships to other configured components and objects.

This method should be called where necessary after all XML file parsing has completed, so that all objects that need to be related to do exist.

Specified by:

finishConfiguration in interface ConfigurableComponentI

Overrides:

finishConfiguration in class SpecialProperty

Parameters:

gameManager - The 'parent' configurable component is passed to allow the 'child' to access any other object without the need to resort to static calls where possible.

Throws:

ConfigurationException

isExecutionable

public boolean isExecutionable()

getLocations

public java.util.List<MapHex> getLocations()

getLocationNameString

public java.lang.String getLocationNameString()

getName

public java.lang.String getName()

getValue

public int getValue()

toString

public java.lang.String toString()

Overrides:

toString in class SpecialProperty