game.events
Class AbstractSquareEvent

java.lang.Object
  |
  +--game.events.AbstractEvent
        |
        +--game.events.AbstractSquareEvent

All Implemented Interfaces:

Event

Direct Known Subclasses:

ControlLocationEvent, IsFoggedEvent, IsVisibleEvent, SettledEvent, SingleVisitEvent, UnitCountEvent, UnitPresentEvent

public abstract class AbstractSquareEvent

extends AbstractEvent

Class to represent an event affecting a square or a series of squares.

Constructor Summary

AbstractSquareEvent()
Constructor.

Method Summary

void	addLocation(Location value) Add a location.
void	addLocation(java.lang.String value) Add a location by name.
void	addRange(Range value) Add a range.
boolean	hasOccurred() Check to see if the event has happened.
protected abstract boolean	success(Square square) Method to check whether this square succeeds, must be overridden by extending classes.
java.lang.String	toString() Implementation of the Object method.

Methods inherited from class game.events.AbstractEvent

activate, addActivateEvent, addBulletin, addDisplay, addEnableTechnology, addEventAction, addGiveResearch, addRemoveEvent, addRemoveFeature, addSaveCondition, addSaveCondition, addUnits, autocenter, cancel, getAfterTurn, getCivilization, getCivilizationName, getName, getNegative, isCancelled, isCurrent, performActions, setAfter, setCancelCondition, setCancelTurn, setCenterView, setCenterView, setCivilization, setInactive, setName, setNegative

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSquareEvent

public AbstractSquareEvent()

Constructor.

Method Detail

addLocation

public void addLocation(Location value)

Add a location.

addLocation

public void addLocation(java.lang.String value)

Add a location by name.

Parameters:

value - the name of the location to add.

addRange

public void addRange(Range value)

Add a range.

success

protected abstract boolean success(Square square)

Method to check whether this square succeeds, must be overridden by extending classes.

Parameters:

square - the square to check.

hasOccurred

public boolean hasOccurred()

Check to see if the event has happened.

Returns:

true if the event has occurred.

toString

public java.lang.String toString()

Implementation of the Object method.

Overrides:

toString in class java.lang.Object

Returns:

a string representation.