FastAsyncWorldEdit/src/WorldEditPlayer.java

// $Id$
/*
 * WorldEdit
 * Copyright (C) 2010 sk89q <http://www.sk89q.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

import com.sk89q.worldedit.Vector;
import com.sk89q.worldedit.ServerInterface;

/**
 *
 * @author sk89q
 */
public abstract class WorldEditPlayer {
    /**
     * Server interface.
     */
    protected ServerInterface server;

    /**
     * Construct the player.
     */
    public WorldEditPlayer() {
        server = WorldEdit.getServer();
    }
    
    /**
     * Get the name of the player.
     *
     * @return String
     */
    public abstract String getName();
    /**
     * Get the point of the block that is being stood upon.
     *
     * @return point
     */
    public abstract Vector getBlockOn();
    /**
     * Get the point of the block that is being stood in.
     * 
     * @return point
     */
    public abstract Vector getBlockIn();
    /**
     * Get the player's position.
     * 
     * @return point
     */
    public abstract Vector getPosition();
    /**
     * Get the player's view pitch.
     *
     * @return pitch
     */
    public abstract double getPitch();
    /**
     * Get the player's view yaw.
     *
     * @return yaw
     */
    public abstract double getYaw();
    /**
     * Get the ID of the item that the player is holding.
     * 
     * @return
     */
    public abstract int getItemInHand();

    /**
     * Returns true if the player is holding a pick axe.
     *
     * @return whether a pick axe is held
     */
    public boolean isHoldingPickAxe() {
        int item = getItemInHand();
        return item == 271 || item == 270 || item == 274 || item == 278
                || item == 285;
    }

    /**
     * Get the player's cardinal direction (N, W, NW, etc.).
     * 
     * @return
     */
    public abstract String getCardinalDirection();

    /**
     * Print a WorldEdit message.
     *
     * @param msg
     */
    public abstract void print(String msg);

    /**
     * Print a WorldEdit error.
     *
     * @param msg
     */
    public abstract void printError(String msg);

    /**
     * Move the player.
     *
     * @param pos
     * @param pitch
     * @param yaw
     */
    public abstract void setPosition(Vector pos, float pitch, float yaw);

    /**
     * Move the player.
     *
     * @param pos
     */
    public void setPosition(Vector pos) {
        setPosition(pos, (float)getPitch(), (float)getYaw());
    }

    /**
     * Find a position for the player to stand that is not inside a block.
     * Blocks above the player will be iteratively tested until there is
     * a series of two free blocks. The player will be teleported to
     * that free position.
     */
    public void findFreePosition() {
        Vector pos = getPosition();
        int x = pos.getBlockX();
        int y = pos.getBlockY();
        int origY = y;
        int z = pos.getBlockZ();

        byte free = 0;

        while (y <= 129) {
            if (etc.getServer().getBlockIdAt(x, y, z) == 0) {
                free++;
            } else {
                free = 0;
            }

            if (free == 2) {
                if (y - 1 != origY) {
                    setPosition(new Vector(x + 0.5, y - 1, z + 0.5));
                    return;
                }
            }

            y++;
        }
    }

    /**
     * Go up one level to the next free space above.
     *
     * @return true if a spot was found
     */
    public boolean ascendLevel() {
        Vector pos = getPosition();
        int x = pos.getBlockX();
        int y = pos.getBlockY();
        int z = pos.getBlockZ();

        byte free = 0;
        byte spots = 0;
        boolean inFree = false;

        while (y <= 129) {
            if (server.getBlockType(new Vector(x, y, z)) == 0) {
                free++;
            } else {
                free = 0;
                inFree = false;
            }

            if (free == 2 && inFree == false) {
                inFree = true;
                spots++;
                if (y >= 129 || spots == 2) {
                    setPosition(new Vector(x + 0.5, y - 1, z + 0.5));
                    return true;
                }
            }

            y++;
        }

        return false;
    }

    /**
     * Go up one level to the next free space above.
     *
     * @return true if a spot was found
     */
    public boolean descendLevel() {
        Vector pos = getPosition();
        int x = pos.getBlockX();
        int y = pos.getBlockY() - 1;
        int z = pos.getBlockZ();

        byte free = 0;

        while (y >= 0) {
            if (server.getBlockType(new Vector(x, y, z)) == 0) {
                free++;
            } else {
                free = 0;
            }

            if (free == 2) {
                setPosition(new Vector(x + 0.5, y, z + 0.5));
                return true;
            }

            y--;
        }

        return false;
    }

    /**
     * Gives the player an item.
     * 
     * @param type
     * @param amt
     */
    public abstract void giveItem(int type, int amt);

    /**
     * Returns true if equal.
     * 
     * @param other
     * @return whether the other object is equivalent
     */
    @Override
    public boolean equals(Object other) {
        if (!(other instanceof WorldEditPlayer)) {
            return false;
        }
        WorldEditPlayer other2 = (WorldEditPlayer)other;
        return other2.getName().equals(getName());
    }

    /**
     * Gets the hash code.
     *
     * @return hash code
     */
    @Override
    public int hashCode() {
        return getName().hashCode();
    }
}