package uulm.teamname.marvelous.gamelibrary.messages;

/**
 * The basic message from the standard, containing all possible expansion keys. In other words, one needs to check the
 * messageType, as fields that aren't sent are null. Note that ingame messages are not deserialized into the {@link
 * BasicMessage}, but instead into the {@link EventMessage}.
 */
public class BasicMessage {

    /** The messageType describes the type of message that might be sent */
    public MessageType messageType;

    /** I have no idea what this might be used for, even less the boolean in the answer */
    public String optionals;

    /**
     * <b>Exists only in a HelloClient message.</b>
     * Describes whether the user was in a running game before reconnecting.
     */
    public Boolean runningGame;

    /**
     * <b>Exists only in GameAssignment and GeneralAssignment messages.</b>
     * Used for notifying the player of which party they have been assigned to
     */
    public String gameID;
}