/*
 * This file is part of the Illarion project.
 *
 * Copyright © 2015 - Illarion e.V.
 *
 * Illarion is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Illarion is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */
package illarion.client.net.client;

import illarion.client.net.CommandList;
import illarion.common.net.NetCommWriter;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;

/**
 * Client Command: This command returns the selection made in a selection dialog to the server
 * ({@link CommandList#CMD_CLOSE_DIALOG_SELECTION}).
 *
 * @author Martin Karing <nitram@illarion.org>
 */
@Immutable
public final class CloseDialogSelectionCmd extends AbstractCommand {
    /**
     * The ID that was send by the server to initiate text input.
     */
    private final int dialogID;

    /**
     * The index that was selected.
     */
    private final short selectedIndex;

    /**
     * The flag that stores if the input was confirmed or canceled.
     */
    private final boolean success;

    /**
     * Default constructor for the text response command.
     *
     * @param dialogID the ID of the dialog
     * @param selectedIndex the index that was selected
     * @param success {@code true} in case the dialog got confirmed
     */
    public CloseDialogSelectionCmd(int dialogID, int selectedIndex, boolean success) {
        super(CommandList.CMD_CLOSE_DIALOG_SELECTION);

        this.dialogID = dialogID;
        this.selectedIndex = (short) selectedIndex;
        this.success = success;
    }

    @Override
    public void encode(@Nonnull NetCommWriter writer) {
        writer.writeInt(dialogID);
        if (success) {
            writer.writeUByte((byte) 0xFF);
        } else {
            writer.writeUByte((byte) 0x00);
        }
        writer.writeUByte(selectedIndex);
    }

    @Nonnull
    @Override
    public String toString() {
        return toString("Dialog ID: " + dialogID + " - Index: " + selectedIndex + " successful: " + success);
    }
}