ISlimevoidHelper.java

/*
 * This program 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. 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
 * Lesser General Public License along with this program. If not, see
 * <http://www.gnu.org/licenses/>
 */
package net.slimevoid.library.util.helpers;

import net.minecraft.block.Block;
import net.minecraft.block.state.IBlockState;
import net.minecraft.entity.EntityLivingBase;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.tileentity.TileEntity;
import net.minecraft.util.BlockPos;
import net.minecraft.world.IBlockAccess;
import net.minecraft.world.World;

public interface ISlimevoidHelper {

    /**
     * Gets the block from location
     *
     * @param world the world of the target
     * @param pos   block position
     * @return the block
     */
    public Block getBlock(World world, BlockPos pos);

    /**
     * Gets the block from location
     *
     * @param world the world of the target
     * @param pos   block position
     * @return the block
     */
    public IBlockState getBlockState(World world, BlockPos pos);

    /**
     * Gets the tile entity for the block
     *
     * @param world the world of the target
     * @param pos   block position
     * @return a tile entity
     */
    public TileEntity getBlockTileEntity(IBlockAccess world, BlockPos pos);

    /**
     * Checks if the target exists within the worldObj of the target
     *
     * @param world the world of the target
     * @param pos   block position
     * @return if block exists
     */
    public boolean targetExists(World world, BlockPos pos);

    @Deprecated
    public boolean isUseableByPlayer(World world, EntityPlayer player, int xCoord, int yCoord, int zCoord, double xDiff, double yDiff, double zDiff, double distance);

    /**
     * Helps get the usable by player for Containers
     *
     * @param world    NOT player.worldObj world of the object e.g.
     *                 tileentity.worldObj
     * @param player   the player attempting to use the block
     * @param pos      the {@link BlockPos}
     * @param xDiff    the x differential (0.5D)
     * @param yDiff    the y differential (0.5D)
     * @param zDiff    the z differential (0.5D)
     * @param distance the distance from object (64.0D)
     * @return whether the Player can use the object
     */
    public boolean isUseableByPlayer(World world, EntityPlayer player, BlockPos pos, double xDiff, double yDiff, double zDiff, double distance);

    /**
     * Overridden to return a readable name string
     *
     * @return the name of the helper
     */
    public String getHelperName();

    /**
     * Overridden to determine whether or not the entity is on a ladder
     *
     * @param world
     * @param x
     * @param y
     * @param z
     * @param entity
     * @return true of false
     */
    @Deprecated
    public boolean isLadder(IBlockAccess world, int x, int y, int z, EntityLivingBase entity);

    /**
     * Overridden to determine whether or not the entity is on a ladder
     *
     * @param world
     * @param pos
     * @param entity
     * @return true of false
     */
    public boolean isLadder(IBlockAccess world, BlockPos pos, EntityLivingBase entity);
}