buildcraft.api.items

Interface IMapLocation

All Superinterfaces:

INamedItem

All Known Implementing Classes:

ItemMapLocation

public interface IMapLocation
extends INamedItem

Created by asie on 2/28/15.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IMapLocation.MapLocationType

Method Summary

Modifier and Type	Method and Description
IBox	getBox(net.minecraft.item.ItemStack stack) This function can be used for SPOT and AREA types.
java.util.List<BlockIndex>	getPath(net.minecraft.item.ItemStack stack) This function can be used for SPOT and PATH types.
BlockIndex	getPoint(net.minecraft.item.ItemStack stack) This function can be used for SPOT types.
net.minecraftforge.common.util.ForgeDirection	getPointSide(net.minecraft.item.ItemStack stack) This function can be used for SPOT types only.
IMapLocation.MapLocationType	getType(net.minecraft.item.ItemStack stack)
IZone	getZone(net.minecraft.item.ItemStack stack) This function can be used for SPOT, AREA and ZONE types.

Methods inherited from interface buildcraft.api.items.INamedItem

getName, setName

Method Detail

getType

IMapLocation.MapLocationType getType(net.minecraft.item.ItemStack stack)

getPoint

BlockIndex getPoint(net.minecraft.item.ItemStack stack)

This function can be used for SPOT types.

Parameters:

stack -

Returns:

The point representing the map location.

getBox

IBox getBox(net.minecraft.item.ItemStack stack)

This function can be used for SPOT and AREA types.

Parameters:

stack -

Returns:

The box representing the map location.

getZone

IZone getZone(net.minecraft.item.ItemStack stack)

This function can be used for SPOT, AREA and ZONE types. The PATH type needs to be handled separately.

Parameters:

stack -

Returns:

An IZone representing the map location - also an instance of IBox for SPOT and AREA types.

getPath

java.util.List<BlockIndex> getPath(net.minecraft.item.ItemStack stack)

This function can be used for SPOT and PATH types.

Parameters:

stack -

Returns:

A list of BlockIndexes representing the path the Map Location stores.

getPointSide

net.minecraftforge.common.util.ForgeDirection getPointSide(net.minecraft.item.ItemStack stack)

This function can be used for SPOT types only.

Parameters:

stack -

Returns:

The side of the spot.