rails.game.action
Class GameAction

java.lang.Object
  rails.game.action.PossibleAction
      rails.game.action.GameAction

All Implemented Interfaces:

java.io.Serializable

public class GameAction
extends PossibleAction

See Also:

Serialized Form

Field Summary

static int	EXPORT
protected java.lang.String	filepath
static int	FORCED_UNDO
static int	LOAD
static int	MAX_MODE
protected int	mode
protected int	moveStackIndex
static int	REDO
static int	RELOAD
static int	SAVE
static long	serialVersionUID
static int	UNDO

Fields inherited from class rails.game.action.PossibleAction

acted, gameManager, log, playerIndex, playerName

Constructor Summary

GameAction(int mode)

Method Summary

boolean	equalsAsAction(PossibleAction action) Compare the chosen actions of two action objects.
boolean	equalsAsOption(PossibleAction action) Compare the choice options of two action objects, without regard to whatever choice has been made, if any.
java.lang.String	getFilepath()
int	getMode()
int	getmoveStackIndex()
void	setFilepath(java.lang.String filepath)
void	setmoveStackIndex(int moveStackIndex)
java.lang.String	toString()

Methods inherited from class rails.game.action.PossibleAction

getCompanyManager, getGameManager, getPlayerIndex, getPlayerName, hasActed, setActed, setPlayerName, toMenu

Methods inherited from class java.lang.Object

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

Field Detail

SAVE

public static final int SAVE

See Also:

Constant Field Values

LOAD

public static final int LOAD

See Also:

Constant Field Values

UNDO

public static final int UNDO

See Also:

Constant Field Values

FORCED_UNDO

public static final int FORCED_UNDO

See Also:

Constant Field Values

REDO

public static final int REDO

See Also:

Constant Field Values

EXPORT

public static final int EXPORT

See Also:

Constant Field Values

RELOAD

public static final int RELOAD

See Also:

Constant Field Values

MAX_MODE

public static final int MAX_MODE

See Also:

Constant Field Values

mode

protected int mode

filepath

protected java.lang.String filepath

moveStackIndex

protected int moveStackIndex

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

GameAction

public GameAction(int mode)

Method Detail

setFilepath

public void setFilepath(java.lang.String filepath)

getFilepath

public java.lang.String getFilepath()

setmoveStackIndex

public void setmoveStackIndex(int moveStackIndex)

getmoveStackIndex

public int getmoveStackIndex()

getMode

public int getMode()

equalsAsOption

public boolean equalsAsOption(PossibleAction action)

Description copied from class: PossibleAction

Compare the choice options of two action objects, without regard to whatever choice has been made, if any. In other words: only the server-set (prior) attributes must be compared.

This method is used by the server (engine) to validate the incoming action that has actually been chosen in the client (GUI), but only for the purpose to check if the chosen option was really on offer, not to check if the chosen action is actually valid. These perspectives could give different results in cases where the PossibleAction does not fully restrict choices to valid values only (such as the blanket LayTile that does no restrict the hex to lay a tile on, or the SetDividend that will accept any revenue value).

Specified by:

equalsAsOption in class PossibleAction

Parameters:

action - Another PossibleAction to compare with.

Returns:

True if the compared PossibleAction object has equal choice options.

equalsAsAction

public boolean equalsAsAction(PossibleAction action)

Description copied from class: PossibleAction

Compare the chosen actions of two action objects. In other words: the client-set (posterior) attributes must be compared, in addition to those server-set (prior) attributes that sufficiently identify the action.

This method is used by the server (engine) to check if two action objects represent the same actual action, as is done when reloading a saved file (i.e. loading a later stage of the same game).

Specified by:

equalsAsAction in class PossibleAction

Parameters:

action - Another PossibleAction to compare with.

Returns:

True if the compared PossibleAction object has equal selected action values.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object