cusack.hcg.games.pebble.events

Class UndoMovePebbleEvent

java.lang.Object

cusack.hcg.events.BaseEvent<S>

cusack.hcg.events.MultiVertexEvent<S>

cusack.hcg.events.DoubleVertexEvent<PebbleInstance>

cusack.hcg.games.pebble.events.UndoMovePebbleEvent

All Implemented Interfaces:

Event<PebbleInstance>, RecordableEvent, PebbleEvent

Direct Known Subclasses:

UndoMovePebbleFirstToVertexEvent

public class UndoMovePebbleEvent
extends DoubleVertexEvent<PebbleInstance>
implements PebbleEvent

Fired when a game is undone. The will store the move that is undone so that it may be redone later if desired.

Author:

Eric DePree

Constructor Summary

Constructors

Constructor and Description
UndoMovePebbleEvent(PebbleInstance game)
UndoMovePebbleEvent(PebbleInstance game, Vertex from, Vertex to)
UndoMovePebbleEvent(PebbleInstance game, Vertex from, Vertex to, int number_pebbles_to_move)

Method Summary

Modifier and Type	Method and Description
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	getNumber_pebbles_to_move()
Event<PebbleInstance>	inverseEvent() This is the method that will be called by the public method getInverseEvent.
boolean	isSameEvent(Event arg)
boolean	modifiedPuzzle()
void	reallyPerformEvent() Essentially the exact same thing as performEvent from all of the other event classes.
void	takebackSideEffects() Implement anything special that has to be done after a move has been taken back.

Methods inherited from class cusack.hcg.events.DoubleVertexEvent

getFrom, getPrintableDetails, getTo

Methods inherited from class cusack.hcg.events.MultiVertexEvent

contains, containsAll, decodeData, getVertex, getVertices, hasExactlyTheseVertices, involvesMultipleVertices, involvesOneVertex, performEvent, reallyDecodeData, size, vertsToString

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

UndoMovePebbleEvent

public UndoMovePebbleEvent(PebbleInstance game)

UndoMovePebbleEvent

public UndoMovePebbleEvent(PebbleInstance game,
                           Vertex from,
                           Vertex to)

UndoMovePebbleEvent

public UndoMovePebbleEvent(PebbleInstance game,
                           Vertex from,
                           Vertex to,
                           int number_pebbles_to_move)

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:

modifiedPuzzle

public boolean modifiedPuzzle()

Specified by:

modifiedPuzzle in interface Event<PebbleInstance>

Overrides:

modifiedPuzzle in class BaseEvent<PebbleInstance>

reallyPerformEvent

public void reallyPerformEvent()

Description copied from class: MultiVertexEvent

Essentially the exact same thing as performEvent from all of the other event classes. For subclasses of this, we need to do something before we perform the events so we override performEvent and subclasses implement this as if it were performEvent.

getNumber_pebbles_to_move

public int getNumber_pebbles_to_move()

isSameEvent

public boolean isSameEvent(Event arg)

Specified by:

isSameEvent in interface Event<PebbleInstance>

Overrides:

isSameEvent in class MultiVertexEvent<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>