Package net.sf.freecol.common.networking

Class AnimateMoveMessage

java.lang.Object

net.sf.freecol.common.networking.Message

net.sf.freecol.common.networking.TrivialMessage

net.sf.freecol.common.networking.AttributeMessage

net.sf.freecol.common.networking.ObjectMessage

net.sf.freecol.common.networking.AnimateMoveMessage

public class AnimateMoveMessage
extends ObjectMessage

The message sent to tell a client to show a movement animation.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.freecol.common.networking.Message

Message.MessagePriority

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	NEW_TILE_TAG
private static java.lang.String	OLD_TILE_TAG
static java.lang.String	TAG
private static java.lang.String	UNIT_TAG

Fields inherited from class net.sf.freecol.common.networking.AttributeMessage

attributes

Fields inherited from class net.sf.freecol.common.networking.TrivialMessage

continueMessage, disconnectMessage, endTurnMessage, enterRevengeModeMessage, reconnectMessage, requestLaunchMessage, retireMessage, startGameMessage

Fields inherited from class net.sf.freecol.common.networking.Message

logger, messagePriorityComparator

Constructor Summary

Constructors

Constructor	Description
AnimateMoveMessage(Game game, FreeColXMLReader xr)	Create a new AnimateMoveMessage from a stream.
AnimateMoveMessage(Unit unit, Tile oldTile, Tile newTile, boolean appears)	Create a new AnimateMoveMessage for the supplied unit and direction.

Method Summary

Modifier and Type	Method	Description
void	aiHandler(FreeColServer freeColServer, AIPlayer aiPlayer)	AI-side handler for this message.
void	clientHandler(FreeColClient freeColClient)	Client-side handler for this message.
private Tile	getNewTile(Game game)	Get the tile to move to.
private Tile	getOldTile(Game game)	Get the tile to move from.
Message.MessagePriority	getPriority()	Get the priority of this type of message.
private Unit	getUnit(Game game)	Get the unit that is moving.

Methods inherited from class net.sf.freecol.common.networking.ObjectMessage

appendChild, appendChildren, getChildCount, getChildren, setChildren

Methods inherited from class net.sf.freecol.common.networking.AttributeMessage

canMerge, getStringAttribute, getStringAttributeMap, hasAttribute, setMergeable, setStringAttribute

Methods inherited from class net.sf.freecol.common.networking.TrivialMessage

currentPlayerMessage, getType, serverHandler, setType

Methods inherited from class net.sf.freecol.common.networking.Message

clientGeneric, expected, getArrayAttributes, getBooleanAttribute, getChild, getChildren, getEnumAttribute, getIntegerAttribute, getPriorityLevel, igc, igc, invokeAndWait, invokeLater, isEmpty, isType, merge, pgc, pgc, pretty, read, setArrayAttributes, setArrayAttributes, setBooleanAttribute, setEnumAttribute, setIntegerAttribute, setStringAttributeMap, setStringAttributes, setStringAttributes, toString, toXML, writeAttributes, writeChildren

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

NEW_TILE_TAG

private static final java.lang.String NEW_TILE_TAG

See Also:

Constant Field Values

OLD_TILE_TAG

private static final java.lang.String OLD_TILE_TAG

See Also:

Constant Field Values

UNIT_TAG

private static final java.lang.String UNIT_TAG

See Also:

Constant Field Values

Constructor Detail

AnimateMoveMessage

public AnimateMoveMessage(Unit unit,
                          Tile oldTile,
                          Tile newTile,
                          boolean appears)

Create a new AnimateMoveMessage for the supplied unit and direction.

Parameters:

unit - The Unit to move.

oldTile - The Tile to move from.

newTile - The Tile to move to.

appears - If true, the unit is newly appearing, and either it or its carrier must be present in this message.

AnimateMoveMessage

public AnimateMoveMessage(Game game,
                          FreeColXMLReader xr)
                   throws javax.xml.stream.XMLStreamException

Create a new AnimateMoveMessage from a stream.

Parameters:

game - The Game this message belongs to.

xr - The FreeColXMLReader to read from.

Throws:

javax.xml.stream.XMLStreamException - if there is a problem reading the stream.

Method Detail

getUnit

private Unit getUnit(Game game)

Get the unit that is moving.

Parameters:

game - The Game to look up the unit in.

Returns:

The Unit that moves.

getNewTile

private Tile getNewTile(Game game)

Get the tile to move to.

Parameters:

game - The Game to look up the tile in.

Returns:

The new Tile.

getOldTile

private Tile getOldTile(Game game)

Get the tile to move from.

Parameters:

game - The Game to look up the tile in.

Returns:

The old Tile.

getPriority

public Message.MessagePriority getPriority()

Get the priority of this type of message.

Overrides:

getPriority in class AttributeMessage

Returns:

The message priority.

aiHandler

public void aiHandler(FreeColServer freeColServer,
                      AIPlayer aiPlayer)

AI-side handler for this message. AI handlers always return null. FIXME: One day the FreeColServer should devolve to AIMain.

Overrides:

aiHandler in class TrivialMessage

Parameters:

freeColServer - The FreeColServer handling the request.

aiPlayer - The AIPlayer the message was sent to.

clientHandler

public void clientHandler(FreeColClient freeColClient)

Client-side handler for this message. Client handlers always return null.

Overrides:

clientHandler in class TrivialMessage

Parameters:

freeColClient - The FreeColClient to handle this message.