Class EmbarkMessage


  • public class EmbarkMessage
    extends AttributeMessage
    The message sent when embarking.
    • Constructor Detail

      • EmbarkMessage

        public EmbarkMessage​(Unit unit,
                             Unit carrier,
                             Direction direction)
        Create a new EmbarkMessage with the supplied unit, carrier and optional direction.
        Parameters:
        unit - The Unit to embark.
        carrier - The carrier Unit to embark on.
        direction - An option direction to embark in.
      • EmbarkMessage

        public EmbarkMessage​(Game game,
                             FreeColXMLReader xr)
                      throws javax.xml.stream.XMLStreamException
        Create a new EmbarkMessage from a stream.
        Parameters:
        game - The Game this message belongs to.
        xr - The FreeColXMLReader to read from.
        Throws:
        javax.xml.stream.XMLStreamException - if the stream is corrupt.
    • Method Detail

      • currentPlayerMessage

        public boolean currentPlayerMessage()
        Should this message only be sent to a server by the current player?
        Overrides:
        currentPlayerMessage in class TrivialMessage
        Returns:
        True if this is a current-player-only message.
      • serverHandler

        public ChangeSet serverHandler​(FreeColServer freeColServer,
                                       ServerPlayer serverPlayer)
        Server-side handler for this message.
        Overrides:
        serverHandler in class TrivialMessage
        Parameters:
        freeColServer - The FreeColServer handling the request.
        serverPlayer - The ServerPlayer that sent the request.
        Returns:
        A ChangeSet defining the response.