ChiselAndBitsAPI (Chisels-and-Bits 13.0.174 API)

java.lang.Object
- mod.chiselsandbits.core.api.ChiselAndBitsAPI

All Implemented Interfaces:: IChiselAndBitsAPI

public class ChiselAndBitsAPI
extends java.lang.Object
implements IChiselAndBitsAPI

Constructor Summary

Constructors
Constructor and Description

ChiselAndBitsAPI()

Constructors
Constructor and Description
`ChiselAndBitsAPI()`

Method Summary

All Methods Instance Methods Concrete Methods
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 state)` 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.
`java.lang.Object`	`getParameter(ParameterType 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?

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ChiselAndBitsAPI
```
public ChiselAndBitsAPI()
```
- Method Detail
  - addEquivilantMaterial
```
public void addEquivilantMaterial(net.minecraft.block.material.Material newMaterial,
                                  net.minecraft.block.material.Material target)
```
    Description copied from interface: IChiselAndBitsAPI
    
    Register a custom material as equivalent to another material.
    
    Specified by:
    
    addEquivilantMaterial in interface IChiselAndBitsAPI
    
    Parameters:
    
    newMaterial - your custom material
    
    target - default MC Material C&B knows about.
  - canBeChiseled
```
public boolean canBeChiseled(net.minecraft.world.World world,
                             net.minecraft.util.math.BlockPos pos)
```
    Description copied from interface: IChiselAndBitsAPI
    
    Check if a block can support IBitAccess
    
    Specified by:
    
    canBeChiseled in interface IChiselAndBitsAPI
    
    Returns:
    
    true if the block can be chiseled, this is true for air, multi-parts, and blocks which can be chiseled, false otherwise.
  - isBlockChiseled
```
public boolean isBlockChiseled(net.minecraft.world.World world,
                               net.minecraft.util.math.BlockPos pos)
```
    Description copied from interface: IChiselAndBitsAPI
    
    is this block already chiseled?
    
    Specified by:
    
    isBlockChiseled in interface IChiselAndBitsAPI
    
    Returns:
    
    true if the block contains chiseled bits, false otherwise.
  - getBitAccess
```
public IBitAccess getBitAccess(net.minecraft.world.World world,
                               net.minecraft.util.math.BlockPos pos)
                        throws APIExceptions.CannotBeChiseled
```
    Description copied from interface: IChiselAndBitsAPI
    
    Get Access to the bits for a given block.
    
    Specified by:
    
    getBitAccess in interface IChiselAndBitsAPI
    
    Returns:
    
    A IBitAccess for the specified location.
    
    Throws:
    
    APIExceptions.CannotBeChiseled - when the location cannot support bits, or if the parameters are invalid.
  - createBrush
```
public IBitBrush createBrush(net.minecraft.item.ItemStack stack)
                      throws APIExceptions.InvalidBitItem
```
    Description copied from interface: IChiselAndBitsAPI
    
    Create a brush from an ItemStack, once created you can use it many times.
    
    Specified by:
    
    createBrush in interface IChiselAndBitsAPI
    
    Returns:
    
    A brush for the specified ItemStack, if passed an empty ItemStack an air brush is created.
    
    Throws:
    
    APIExceptions.InvalidBitItem
  - getBitPos
```
public IBitLocation getBitPos(float hitX,
                              float hitY,
                              float hitZ,
                              net.minecraft.util.EnumFacing side,
                              net.minecraft.util.math.BlockPos pos,
                              boolean placement)
```
    Description copied from interface: IChiselAndBitsAPI
    
    Convert ray trace information into bit location information, note that the block position can change, be aware.
    
    Specified by:
    
    getBitPos in interface IChiselAndBitsAPI
    
    Returns:
    
    details about the target bit, no arguments should be null.
  - getItemType
```
public ItemType getItemType(net.minecraft.item.ItemStack stack)
```
    Description copied from interface: IChiselAndBitsAPI
    
    Determine the Item Type of the item in an ItemStack and return it.
    
    Specified by:
    
    getItemType in interface IChiselAndBitsAPI
    
    Returns:
    
    ItemType of the item, or null if it is not any of them.
  - createBitItem
```
public IBitAccess createBitItem(net.minecraft.item.ItemStack stack)
```
    Description copied from interface: IChiselAndBitsAPI
    
    Create a bit access from an ItemStack, passing an empty ItemStack creates an empty bit access, passing an invalid item returns null.
    
    Specified by:
    
    createBitItem in interface IChiselAndBitsAPI
    
    Returns:
    
    a IBitAccess for an ItemStack.
  - createBrushFromState
```
public IBitBrush createBrushFromState(net.minecraft.block.state.IBlockState state)
                               throws APIExceptions.InvalidBitItem
```
    Description copied from interface: IChiselAndBitsAPI
    
    Create a brush from a state, once created you can use it many times.
    
    Specified by:
    
    createBrushFromState in interface IChiselAndBitsAPI
    
    Returns:
    
    A brush for the specified state, if null is passed for the item an air brush is created.
    
    Throws:
    
    APIExceptions.InvalidBitItem
  - getBitItem
```
public net.minecraft.item.ItemStack getBitItem(net.minecraft.block.state.IBlockState state)
                                        throws APIExceptions.InvalidBitItem
```
    Description copied from interface: IChiselAndBitsAPI
    
    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.
    
    Specified by:
    
    getBitItem in interface IChiselAndBitsAPI
    
    Returns:
    
    the bit.
    
    Throws:
    
    APIExceptions.InvalidBitItem
  - giveBitToPlayer
```
public void giveBitToPlayer(net.minecraft.entity.player.EntityPlayer player,
                            net.minecraft.item.ItemStack stack,
                            net.minecraft.util.math.Vec3d spawnPos)
```
    Description copied from interface: IChiselAndBitsAPI
    
    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.
    
    Specified by:
    
    giveBitToPlayer in interface IChiselAndBitsAPI
    
    Parameters:
    
    player - player to give bits to.
    
    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
```
public IBitBag getBitbag(net.minecraft.item.ItemStack stack)
```
    Description copied from interface: IChiselAndBitsAPI
    
    Access the contents of a bitbag as if it was a normal IItemHandler with a few extra features.
    
    Specified by:
    
    getBitbag in interface IChiselAndBitsAPI
    
    Returns:
    
    internal object to manipulate bag.
  - beginUndoGroup
```
public void beginUndoGroup(net.minecraft.entity.player.EntityPlayer player)
```
    Description copied from interface: IChiselAndBitsAPI
    
    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.
    
    Specified by:
    
    beginUndoGroup in interface IChiselAndBitsAPI
  - endUndoGroup
```
public void endUndoGroup(net.minecraft.entity.player.EntityPlayer player)
```
    Description copied from interface: IChiselAndBitsAPI
    
    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.
    
    Specified by:
    
    endUndoGroup in interface IChiselAndBitsAPI
  - getKeyBinding
```
public net.minecraft.client.settings.KeyBinding getKeyBinding(ModKeyBinding modKeyBinding)
```
    Description copied from interface: IChiselAndBitsAPI
    
    Get a C&B key binding.
    
    Specified by:
    
    getKeyBinding in interface IChiselAndBitsAPI
    
    Parameters:
    
    modKeyBinding - the ModKeyBinding value that denotes the C&B key binding to return.
    
    Returns:
    
    a C&B KeyBinding.
  - getParameter
```
public java.lang.Object getParameter(ParameterType which)
```
    Description copied from interface: IChiselAndBitsAPI
    
    Example: int stackSize = api.getParameter(IntegerParam.BIT_BAG_MAX_STACK_SIZE );
    
    Specified by:
    
    getParameter in interface IChiselAndBitsAPI
    
    Parameters:
    
    which - - refer to ParameterType for list of possible values.
    
    Returns:
    
    value of specified parameter.

Class ChiselAndBitsAPI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChiselAndBitsAPI

Method Detail

addEquivilantMaterial

canBeChiseled

isBlockChiseled

getBitAccess

createBrush

getBitPos

getItemType

createBitItem

createBrushFromState

getBitItem

giveBitToPlayer

getBitbag

beginUndoGroup

endUndoGroup

getKeyBinding

getParameter