cusack.hcg.games.pebble.events

Class PebblePlacedEvent

java.lang.Object

cusack.hcg.events.BaseEvent<S>

cusack.hcg.events.SingleVertexEvent<PebbleInstance>

cusack.hcg.games.pebble.events.PebblePlacedEvent

All Implemented Interfaces:

Event<PebbleInstance>, OneVertexEvent, RecordableEvent, PebbleEvent

public class PebblePlacedEvent
extends SingleVertexEvent<PebbleInstance>
implements PebbleEvent

Fired when a pebble is moved

Author:

Eric DePree, Modified by Chuck Cusack, Feb 2010.

Constructor Summary

Constructors

Constructor and Description
PebblePlacedEvent(PebbleInstance game)
PebblePlacedEvent(PebbleInstance game, Vertex vertex, int pebs)
PebblePlacedEvent(PebbleInstance game, Vertex vertex, int pebs, PebbleAlgorithmStates old)

Method Summary

Modifier and Type	Method and Description
void	decodeAdditionalData(java.lang.String data)
java.lang.String	getDefaultBeforeActionComment()
java.lang.String	getDefaultBetweenActionComment()
java.lang.String	getDefaultIntroductoryComment()
java.lang.String	getEventName() Return the name of the event for printing.
int	getNumberPebbles()
Event<PebbleInstance>	inverseEvent() This is the method that will be called by the public method getInverseEvent.
boolean	isSameEvent(Event arg)
boolean	modifiedPuzzle()
void	performEvent()
void	takebackSideEffects() Implement anything special that has to be done after a move has been taken back.

Methods inherited from class cusack.hcg.events.SingleVertexEvent

decodeData, getPrintableDetails, getVertex, involvesMultipleVertices, involvesOneVertex, setVertex

Methods inherited from class cusack.hcg.events.BaseEvent

canUserGenerate, clearComments, encodeEvent, encodeEvents, equals, getAfterActionComment, getBeforeActionComment, getBetweenActionComment, getGame, getIntroductoryComment, getInverseEvent, getRealAfterActionComment, getRealBeforeActionComment, getRealBetweenActionComment, getRealIntroductoryComment, getTimeSinceFirstEvent, hashCode, isCreatedFromConstructor, modifiedGraph, performInverseEvent, performTakebackEvent, setAfterActionComment, setBeforeActionComment, setBetweenActionComment, setCreatedFromConstructor, setGame, setIntroductoryComment, setTimeSinceFirstEvent, toString, toStringWithoutTime

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PebblePlacedEvent

public PebblePlacedEvent(PebbleInstance game)

PebblePlacedEvent

public PebblePlacedEvent(PebbleInstance game,
                         Vertex vertex,
                         int pebs)

PebblePlacedEvent

public PebblePlacedEvent(PebbleInstance game,
                         Vertex vertex,
                         int pebs,
                         PebbleAlgorithmStates old)

Method Detail

inverseEvent

public Event<PebbleInstance> inverseEvent()

Description copied from class: BaseEvent

This is the method that will be called by the public method getInverseEvent. Although a bit weird, it is done this way because that method sets the time of the inverse event, so we want them to call that one. We don't want every class to have to remember to do that part.

Returns:

getNumberPebbles

public int getNumberPebbles()

modifiedPuzzle

public boolean modifiedPuzzle()

Specified by:

modifiedPuzzle in interface Event<PebbleInstance>

Overrides:

modifiedPuzzle in class BaseEvent<PebbleInstance>

performEvent

public void performEvent()

Specified by:

performEvent in interface Event<PebbleInstance>

decodeAdditionalData

public void decodeAdditionalData(java.lang.String data)

isSameEvent

public boolean isSameEvent(Event arg)

Specified by:

isSameEvent in interface Event<PebbleInstance>

Overrides:

isSameEvent in class SingleVertexEvent<PebbleInstance>

getDefaultIntroductoryComment

public java.lang.String getDefaultIntroductoryComment()

Specified by:

getDefaultIntroductoryComment in interface Event<PebbleInstance>

Specified by:

getDefaultIntroductoryComment in class BaseEvent<PebbleInstance>

getDefaultBeforeActionComment

public java.lang.String getDefaultBeforeActionComment()

Specified by:

getDefaultBeforeActionComment in interface Event<PebbleInstance>

Specified by:

getDefaultBeforeActionComment in class BaseEvent<PebbleInstance>

getDefaultBetweenActionComment

public java.lang.String getDefaultBetweenActionComment()

Specified by:

getDefaultBetweenActionComment in interface Event<PebbleInstance>

Specified by:

getDefaultBetweenActionComment in class BaseEvent<PebbleInstance>

getEventName

public java.lang.String getEventName()

Description copied from class: BaseEvent

Return the name of the event for printing.

Specified by:

getEventName in class BaseEvent<PebbleInstance>

Returns:

takebackSideEffects

public void takebackSideEffects()

Description copied from interface: Event

Implement anything special that has to be done after a move has been taken back. For instance, if it is a pebbling move, a vertex might need to be listed as uncovered, but that isn't a normal part of undoing a pebble move.

Specified by:

takebackSideEffects in interface Event<PebbleInstance>