jfreerails.move
Class AddActiveEntityMove

java.lang.Object
  jfreerails.move.AddActiveEntityMove

All Implemented Interfaces:

java.io.Serializable, Move, FreerailsSerializable

public class AddActiveEntityMove
extends java.lang.Object
implements Move

A move that adds an active entity. An active entity is something whose state may be continually changing. An example is a train - it is an active entity since while it is moving its position is continually changing.

Author:

Luke

See Also:

NextActivityMove, Serialized Form

Field Summary

private Activity	activity
private int	index
private FreerailsPrincipal	principal
private static long	serialVersionUID

Constructor Summary

AddActiveEntityMove(Activity activity, int index, FreerailsPrincipal principal)

Method Summary

MoveStatus	doMove(World w, FreerailsPrincipal p) Executes this move on the specifed world object.
boolean	equals(java.lang.Object o)
int	hashCode()
MoveStatus	tryDoMove(World w, FreerailsPrincipal p) Tests whether this Move can be executed on the specifed world object, this method should leave the world object unchanged.
MoveStatus	tryUndoMove(World w, FreerailsPrincipal p) Tests whether this Move can be undone on the specifed world object, this method should leave the world object unchanged.
MoveStatus	undoMove(World w, FreerailsPrincipal p) If doMove has just been executed on the specified world object, calling this method changes the state of the world object back to how it was before doMove was called.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

activity

private final Activity activity

principal

private final FreerailsPrincipal principal

index

private final int index

Constructor Detail

AddActiveEntityMove

public AddActiveEntityMove(Activity activity,
                           int index,
                           FreerailsPrincipal principal)

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

tryDoMove

public MoveStatus tryDoMove(World w,
                            FreerailsPrincipal p)

Description copied from interface: Move

Tests whether this Move can be executed on the specifed world object, this method should leave the world object unchanged.

Specified by:

tryDoMove in interface Move

tryUndoMove

public MoveStatus tryUndoMove(World w,
                              FreerailsPrincipal p)

Description copied from interface: Move

Tests whether this Move can be undone on the specifed world object, this method should leave the world object unchanged.

Specified by:

tryUndoMove in interface Move

doMove

public MoveStatus doMove(World w,
                         FreerailsPrincipal p)

Description copied from interface: Move

Executes this move on the specifed world object.

Specified by:

doMove in interface Move

undoMove

public MoveStatus undoMove(World w,
                           FreerailsPrincipal p)

Description copied from interface: Move

If doMove has just been executed on the specified world object, calling this method changes the state of the world object back to how it was before doMove was called.

Specified by:

undoMove in interface Move