mod.chiselsandbits.api

Interface IChiselAndBitsAPI

All Known Implementing Classes:

ChiselAndBitsAPI

public interface IChiselAndBitsAPI

Do not implement, is passed to your IChiselsAndBitsAddon

Method Summary

Modifier and Type	Method and Description
void	addEquivilantMaterial(net.minecraft.block.material.Material newMaterial, net.minecraft.block.material.Material target) Register a custom material as equivalent to another material.
void	beginUndoGroup(net.minecraft.entity.player.EntityPlayer player) Begins an undo group, starting two operations without ending the previous operation will throw a runtime exception.
boolean	canBeChiseled(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Check if a block can support IBitAccess
IBitAccess	createBitItem(net.minecraft.item.ItemStack stack) Create a bit access from an ItemStack, passing an empty ItemStack creates an empty bit access, passing an invalid item returns null.
IBitBrush	createBrush(net.minecraft.item.ItemStack stack) Create a brush from an ItemStack, once created you can use it many times.
IBitBrush	createBrushFromState(net.minecraft.block.state.IBlockState state) Create a brush from a state, once created you can use it many times.
void	endUndoGroup(net.minecraft.entity.player.EntityPlayer player) Ends a previously running undo group, must be called after starting an undo group, closing a group without opening one will result in a runtime exception.
IBitAccess	getBitAccess(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Get Access to the bits for a given block.
IBitBag	getBitbag(net.minecraft.item.ItemStack stack) Access the contents of a bitbag as if it was a normal IItemHandler with a few extra features.
net.minecraft.item.ItemStack	getBitItem(net.minecraft.block.state.IBlockState defaultState) Get an ItemStack for the bit type of the state...
IBitLocation	getBitPos(float hitX, float hitY, float hitZ, net.minecraft.util.EnumFacing side, net.minecraft.util.math.BlockPos pos, boolean placement) Convert ray trace information into bit location information, note that the block position can change, be aware.
ItemType	getItemType(net.minecraft.item.ItemStack stack) Determine the Item Type of the item in an ItemStack and return it.
net.minecraft.client.settings.KeyBinding	getKeyBinding(ModKeyBinding modKeyBinding) Get a C&B key binding.
<T> T	getParameter(ParameterType<T> which) Example: int stackSize = api.getParameter(IntegerParam.BIT_BAG_MAX_STACK_SIZE );
void	giveBitToPlayer(net.minecraft.entity.player.EntityPlayer player, net.minecraft.item.ItemStack stack, net.minecraft.util.math.Vec3d spawnPos) Give a bit to a player, it will end up in their inventory, a bag, or if there is no where to put it, on the ground.
boolean	isBlockChiseled(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) is this block already chiseled?

Method Detail

getItemType

@Nullable
ItemType getItemType(net.minecraft.item.ItemStack stack)

Determine the Item Type of the item in an ItemStack and return it.

Parameters:

stack -

Returns:

ItemType of the item, or null if it is not any of them.

canBeChiseled

boolean canBeChiseled(net.minecraft.world.World world,
                      net.minecraft.util.math.BlockPos pos)

Check if a block can support IBitAccess

Parameters:

world -

pos -

Returns:

true if the block can be chiseled, this is true for air, multi-parts, and blocks which can be chiseled, false otherwise.

isBlockChiseled

boolean isBlockChiseled(net.minecraft.world.World world,
                        net.minecraft.util.math.BlockPos pos)

is this block already chiseled?

Parameters:

world -

pos -

Returns:

true if the block contains chiseled bits, false otherwise.

getBitAccess

IBitAccess getBitAccess(net.minecraft.world.World world,
                        net.minecraft.util.math.BlockPos pos)
                 throws APIExceptions.CannotBeChiseled

Get Access to the bits for a given block.

Parameters:

world -

pos -

Returns:

A IBitAccess for the specified location.

Throws:

APIExceptions.CannotBeChiseled - when the location cannot support bits, or if the parameters are invalid.

createBitItem

@Nullable
IBitAccess createBitItem(net.minecraft.item.ItemStack stack)

Create a bit access from an ItemStack, passing an empty ItemStack creates an empty bit access, passing an invalid item returns null.

Returns:

a IBitAccess for an ItemStack.

createBrush

IBitBrush createBrush(net.minecraft.item.ItemStack stack)
               throws APIExceptions.InvalidBitItem

Create a brush from an ItemStack, once created you can use it many times.

Parameters:

bitItem -

Returns:

A brush for the specified ItemStack, if passed an empty ItemStack an air brush is created.

Throws:

APIExceptions.InvalidBitItem

createBrushFromState

IBitBrush createBrushFromState(@Nullable
                               net.minecraft.block.state.IBlockState state)
                        throws APIExceptions.InvalidBitItem

Create a brush from a state, once created you can use it many times.

Parameters:

state -

Returns:

A brush for the specified state, if null is passed for the item an air brush is created.

Throws:

APIExceptions.InvalidBitItem

getBitPos

IBitLocation getBitPos(float hitX,
                       float hitY,
                       float hitZ,
                       net.minecraft.util.EnumFacing side,
                       net.minecraft.util.math.BlockPos pos,
                       boolean placement)

Convert ray trace information into bit location information, note that the block position can change, be aware.

Parameters:

hitX -

hitY -

hitZ -

side -

pos -

placement -

Returns:

details about the target bit, no arguments should be null.

getBitItem

net.minecraft.item.ItemStack getBitItem(net.minecraft.block.state.IBlockState defaultState)
                                 throws APIExceptions.InvalidBitItem

Get an ItemStack for the bit type of the state... VERY IMPORTANT: C&B lets you disable bits, if this happens the Item in this ItemStack WILL BE empty.

Parameters:

defaultState -

Returns:

the bit.

Throws:

APIExceptions.InvalidBitItem

giveBitToPlayer

void giveBitToPlayer(net.minecraft.entity.player.EntityPlayer player,
                     net.minecraft.item.ItemStack stack,
                     net.minecraft.util.math.Vec3d spawnPos)

Give a bit to a player, it will end up in their inventory, a bag, or if there is no where to put it, on the ground. CLIENT: destroys the item. SERVER: adds ItemStack to inv/bag/spawns entity.

Parameters:

player - player to give bits to.

itemstack - bits to store.

spawnPos - if null defaults to the players position, absolute position of where to spawn bits, should be in the block near where they are being extracted from.

getBitbag

@Nullable
IBitBag getBitbag(net.minecraft.item.ItemStack stack)

Access the contents of a bitbag as if it was a normal IItemHandler with a few extra features.

Returns:

internal object to manipulate bag.

getParameter

<T> T getParameter(ParameterType<T> which)

Example: int stackSize = api.getParameter(IntegerParam.BIT_BAG_MAX_STACK_SIZE );

Parameters:

which - - refer to ParameterType for list of possible values.

Returns:

value of specified parameter.

beginUndoGroup

void beginUndoGroup(net.minecraft.entity.player.EntityPlayer player)

Begins an undo group, starting two operations without ending the previous operation will throw a runtime exception. This is used to merge multiple blocks into a single operation, undo steps will be recorded regardless of usage of this method, however its suggested to use groups in any case where a change well affect more then one block.

endUndoGroup

void endUndoGroup(net.minecraft.entity.player.EntityPlayer player)

Ends a previously running undo group, must be called after starting an undo group, closing a group without opening one will result in a runtime exception.

addEquivilantMaterial

void addEquivilantMaterial(net.minecraft.block.material.Material newMaterial,
                           net.minecraft.block.material.Material target)

Register a custom material as equivalent to another material.

Parameters:

newMaterial - your custom material

target - default MC Material C&B knows about.

getKeyBinding

net.minecraft.client.settings.KeyBinding getKeyBinding(ModKeyBinding modKeyBinding)

Get a C&B key binding.

Parameters:

modKeyBinding - the ModKeyBinding value that denotes the C&B key binding to return.

Returns:

a C&B KeyBinding.