SpoutBlock.java

/*
 * This file is part of SpoutcraftPlugin.
 *
 * Copyright (c) 2011 SpoutcraftDev <http://spoutcraft.org//>
 * SpoutcraftPlugin is licensed under the GNU Lesser General Public License.
 *
 * SpoutcraftPlugin is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * SpoutcraftPlugin 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.getspout.spoutapi.block;

import java.io.Serializable;

import org.bukkit.Material;
import org.bukkit.block.Block;
import org.bukkit.block.BlockFace;

import org.getspout.spoutapi.inventory.SpoutItemStack;
import org.getspout.spoutapi.material.CustomBlock;

public interface SpoutBlock extends Block {
	/**
	 * Sets the block type safely, appearing instantly and seamlessly to all players
	 * Can be used on main thread, but recommended for async threads
	 * @param type to set the block to
	 */
	@Deprecated
	public void setTypeAsync(Material type);

	/**
	 * Sets the block type id safely, appearing instantly and seamlessly to all players
	 * Can be used on main thread, but recommended for async threads
	 * @param type id to set the block to
	 */
	@Deprecated
	public void setTypeIdAsync(int type);

	/**
	 * Sets the block data safely, appearing instantly and seamlessly to all players
	 * Can be used on main thread, but recommended for async threads
	 * @param data to set the block to
	 */
	@Deprecated
	public void setDataAsync(byte data);

	/**
	 * Sets the block type id and data safely, appearing instantly and seamlessly to all players
	 * Can be used on main thread, but recommended for async threads
	 * @param type to set the block to
	 * @param data to set the block to
	 */
	@Deprecated
	public void setTypeIdAndDataAsync(int type, byte data);

	/**
	 * Overrides the block to be the customBlock
	 * <p/>
	 * This can be used to set custom blocks at the location.
	 * @param customBlock the custom block to use instead of the block, or removes it if null
	 */
	public void setCustomBlock(CustomBlock block);

	/**
	 * Sets block data for the block at (x, y, z) and a given id.
	 * <p/>
	 * Setting data for unloaded chunks has an undefined effect.
	 * @param id   the id used to retrieve the data
	 * @param data the data to be stored
	 * @return the old data for that block using that string
	 */
	public Serializable setData(String id, Serializable data);

	/**
	 * Returns the block data for the block at (x, y, z) and a given id.
	 * <p/>
	 * Retrieving data for unloaded chunks is undefined.
	 * @param id the id used to retrieve the data
	 * @return the old data for that block using that string
	 */
	public Serializable getData(String id);

	/**
	 * Removes and returns the block data for the block at (x, y, z) and a given id.
	 * <p/>
	 * Deleting data for unloaded chunks has an undefined effect.
	 * @param id the id used to retrieve the data
	 * @return the old data for that block using that string
	 */
	public Serializable removeData(String id);

	/**
	 * Gets the name of this block
	 * <p/>
	 * Ex dirt block returns "Dirt".
	 * @return block name
	 */
	@Deprecated
	public String getName();

	/**
	 * Sets the power state of this block, overriding the default power state.
	 * <p/>
	 * This will override the default power state.
	 * Unpowering this location will prevent normal redstone sources from working, powering it will allow for non-redstone sources to generate a power current.
	 * <p/>
	 * Note: The new power state will remain even if the underlying block type changes!
	 * @param power to set
	 */
	@Deprecated
	public void setBlockPowered(boolean power);

	/**
	 * Sets the power state of the block face of this block, overriding the default power state.
	 * <p/>
	 * Valid block faces are null (entire block), EAST, WEST, NORTH, SOUTH, UP, DOWN. Non-valid states will throw an exception.
	 * <p/>
	 * This will override the default power state of this blockface.
	 * Unpowering this location will prevent normal redstone sources from working, powering it will allow for non-redstone sources to generate a power current.
	 * <p/>
	 * Note: The new power state will remain even if the underlying block type changes!
	 * @param power to set
	 * @param face  to affect
	 */
	@Deprecated
	public void setBlockPowered(boolean power, BlockFace face);

	/**
	 * Resets the block back to the minecraft standard rules for power.
	 */
	@Deprecated
	public void resetBlockPower();

	/**
	 * Gets the relevant block information. Allows manipulation of the base features of each type of block.
	 * @return block type
	 */
	public org.getspout.spoutapi.material.Block getBlockType();

	/**
	 * Returns an item stack with 1 of this block inside of it.
	 * @return itemstack
	 */
	@Deprecated
	public SpoutItemStack toItemStack();

	/**
	 * Returns an item stack with the given amount of this block inside it.
	 * @param amount to create
	 * @return itemstack
	 */
	@Deprecated
	public SpoutItemStack toItemStack(int amount);

	@Override
	public SpoutBlock getRelative(int modX, int modY, int modZ);

	@Override
	public SpoutBlock getRelative(BlockFace face);

	@Override
	public SpoutChunk getChunk();

	/**
	 * Gets the custom block ID associated with this SpoutBlock if it exists, or 0 if not
	 * @return blockId
	 */
	@Deprecated
	public short getCustomBlockId();

	/**
	 * Checks if the SpoutBlock has a custom material data or not
	 * @return true if block is custom
	 */
	@Deprecated
	public boolean isCustomBlock();

	/**
	 * Removes the custom material data associated with this SpoutBlock
	 * @Deprecated use {@link #setCustomBlock(CustomBlock)} with null instead
	 */
	@Deprecated
	public void removeCustomBlockData();

	/**
	 * Gets the custom block material associated with this SpoutBlock
	 * @return custom block material
	 */
	public CustomBlock getCustomBlock();

	public byte getCustomBlockData();

	public void setCustomBlockData(byte dat);
}