/*
 * 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.client.world.World;
import illarion.common.net.NetCommWriter;
import illarion.common.types.Direction;
import illarion.common.types.ServerCoordinate;

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

/**
 * Client Command: Open a container on the map ({@link CommandList#CMD_OPEN_MAP}).
 *
 * @author Nop
 * @author Martin Karing <nitram@illarion.org>
 */
@Immutable
public final class OpenOnMapCmd extends AbstractCommand {
    /**
     * The direction relative to the player character the bag is located at.
     */
    @Nullable
    private final Direction direction;

    /**
     * Default constructor for the open container on the map command.
     *
     * @param mapLocation the location on the map where the container is supposed to be opened
     */
    public OpenOnMapCmd(@Nonnull ServerCoordinate mapLocation) {
        super(CommandList.CMD_OPEN_MAP);
        direction = World.getPlayer().getLocation().getDirection(mapLocation);
    }

    /**
     * Encode the data of this open container on map command and put the values into the buffer.
     *
     * @param writer the interface that allows writing data to the network communication system
     */
    @Override
    public void encode(@Nonnull NetCommWriter writer) {
        Direction.encode(direction, writer);
    }

    /**
     * Get the data of this open container on map command as string.
     *
     * @return the data of this command as string
     */
    @Nonnull
    @Override
    public String toString() {
        return toString("from direction:" + direction);
    }
}