ViewingOrb.java

package com.asteria.game.character.player.content;

import java.util.stream.IntStream;

import com.asteria.game.character.Flag;
import com.asteria.game.character.player.Player;
import com.asteria.game.location.Position;

/**
 * The container class that handles the opening, closing, and navigation of
 * viewing orbs.
 *
 * @author lare96 <http://github.com/lare96>
 */
public final class ViewingOrb {

    /**
     * The player that is viewing the orb.
     */
    private final Player player;

    /**
     * The starting position of the player viewing the orb.
     */
    private final Position start;

    /**
     * The centre position corresponding to the viewing orb.
     */
    private final Position centre;

    /**
     * The north-west position corresponding to the viewing orb.
     */
    private final Position northWest;

    /**
     * The north-east position corresponding to the viewing orb.
     */
    private final Position northEast;

    /**
     * The south-west position corresponding to the viewing orb.
     */
    private final Position southWest;

    /**
     * The south-east position corresponding to the viewing orb.
     */
    private final Position southEast;

    /**
     * Creates a new {@link ViewingOrb}.
     *
     * @param player
     *            the player that is viewing the orb.
     * @param centre
     *            the centre position corresponding to the viewing orb.
     * @param northWest
     *            the north-west position corresponding to the viewing orb.
     * @param northEast
     *            the north-east position corresponding to the viewing orb.
     * @param southWest
     *            the south-west position corresponding to the viewing orb.
     * @param southEast
     *            the south-east position corresponding to the viewing orb.
     */
    public ViewingOrb(Player player, Position centre, Position northWest, Position northEast, Position southWest, Position southEast) {
        this.player = player;
        this.start = player.getPosition().copy();
        this.centre = centre;
        this.northWest = northWest;
        this.northEast = northEast;
        this.southWest = southWest;
        this.southEast = southEast;
    }

    /**
     * Opens the viewing orb navigation interface in the sidebar.
     */
    public void open() {
        IntStream.rangeClosed(0, 13).filter(v -> v != 7 && v != 10).forEach(v -> player.getMessages().sendSidebarInterface(v, -1));
        player.getMessages().sendSidebarInterface(10, 3209);
        player.getMessages().sendForceTab(10);
        player.getMessages().sendString("@yel@Centre", 15239);
        player.getMessages().sendString("@yel@North-West", 15240);
        player.getMessages().sendString("@yel@North-East", 15241);
        player.getMessages().sendString("@yel@South-East", 15242);
        player.getMessages().sendString("@yel@South-West", 15243);
        player.getMovementQueue().setLockMovement(true);
        player.setVisible(false);
        player.setDisabled(true);
        player.getMessages().sendMinimapState(2);
        player.setPlayerNpc(2982);
        player.getFlags().set(Flag.APPEARANCE);
        move("Centre", 15239, centre);
    }

    /**
     * Closes the viewing orb navigation interface in the sidebar and teleports
     * the player back to the starting position.
     */
    public void close() {
        int[] interfaces = { 3917, 638, 3213, 1644, 5608, player.getSpellbook().getId(), 5065, 5715, 2449, 904, 147, 962, 2423 };
        for (int idx = 0; idx < interfaces.length; idx++)
            player.getMessages().sendSidebarInterface(idx, interfaces[idx]);
        player.getMovementQueue().setLockMovement(false);
        player.setVisible(true);
        player.setDisabled(false);
        player.setPlayerNpc(-1);
        player.getFlags().set(Flag.APPEARANCE);
        player.getMessages().sendMinimapState(0);
        player.move(start);
    }

    /**
     * Moves the player to {@code position} and updates the navigation interface
     * with the position that the player is being moved to.
     *
     * @param positionName
     *            the name of the position being moved to.
     * @param positionLineId
     *            the interface string id of the position being moved to.
     * @param position
     *            the position being moved to.
     */
    public void move(String positionName, int positionLineId, Position position) {
        if (position.equals(player.getPosition()))
            return;
        player.getMessages().sendString("@yel@Centre", 15239);
        player.getMessages().sendString("@yel@North-West", 15240);
        player.getMessages().sendString("@yel@North-East", 15241);
        player.getMessages().sendString("@yel@South-East", 15242);
        player.getMessages().sendString("@yel@South-West", 15243);
        player.getMessages().sendString("@whi@" + positionName, positionLineId);
        player.move(position);
    }

    /**
     * Gets the starting position of the player viewing the orb.
     *
     * @return the starting position.
     */
    public Position getStart() {
        return start;
    }

    /**
     * Gets the centre position corresponding to the viewing orb.
     *
     * @return the centre position.
     */
    public Position getCentre() {
        return centre;
    }

    /**
     * Gets the north-west position corresponding to the viewing orb.
     *
     * @return the north-west position.
     */
    public Position getNorthWest() {
        return northWest;
    }

    /**
     * Gets the north-east position corresponding to the viewing orb.
     *
     * @return the north-east position.
     */
    public Position getNorthEast() {
        return northEast;
    }

    /**
     * Gets the south-west position corresponding to the viewing orb.
     *
     * @return the south-west position.
     */
    public Position getSouthWest() {
        return southWest;
    }

    /**
     * Gets the south-east position corresponding to the viewing orb.
     *
     * @return the south-east position.
     */
    public Position getSouthEast() {
        return southEast;
    }
}