StartGameMessage (FreeCol Code Documentation)

java.lang.Object
- net.sf.freecol.common.networking.Message
- - net.sf.freecol.common.networking.TrivialMessage
  - - net.sf.freecol.common.networking.StartGameMessage

```
public class StartGameMessage
extends TrivialMessage
```
A trivial message sent to clients to signal the start of game.

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

static java.lang.String TAG
- 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
`StartGameMessage()`	Create a new `StartGameMessage`.
`StartGameMessage(Game game, FreeColXMLReader xr)`	Create a new `StartGameMessage` from a stream.

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class net.sf.freecol.common.networking.TrivialMessage
appendChild, appendChildren, currentPlayerMessage, getChildCount, getChildren, getPriority, getStringAttribute, getStringAttributeMap, getType, hasAttribute, serverHandler, setChildren, setStringAttribute, setType

Methods inherited from class net.sf.freecol.common.networking.Message
canMerge, 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
- Constructor Detail
  - StartGameMessage
```
public StartGameMessage()
```
    Create a new StartGameMessage.
  - StartGameMessage
```
public StartGameMessage(Game game,
                        FreeColXMLReader xr)
                 throws javax.xml.stream.XMLStreamException
```
    Create a new StartGameMessage 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
  - 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.