BracketHandlers

This class contains the "simple" Bracket handlers from CraftTweaker. However, some Bracket handlers, like for recipeTypes, tags, tagManagers, won't be shown here as they use a different internal structure.

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

import crafttweaker.api.BracketHandlers;

Methods

getBiome

Gets a Biome based on the tokens. Throws an error if it can't get the biome

Returns: The found biome Return Type: MCBiome

<biome:minecraft:plain>

BracketHandlers.getBiome(tokens as string) as MCBiome
BracketHandlers.getBiome("minecraft:plain");
ParameterTypeDescription
tokensstringThe biome's resource location
getBlock

Gets the give MCBlock. Throws an Exception if not found

Returns: The found MCBlock Return Type: MCBlock

<block:minecraft:dirt>

BracketHandlers.getBlock(tokens as string) as MCBlock
BracketHandlers.getBlock("minecraft:dirt");
ParameterTypeDescription
tokensstringCo napisaliby państwo w wezwaniu do BEP.
getBlockMaterial

Gets the given MCMaterial. Throws an Exception if not found.

Returns: The found MCMaterial Return Type: MCMaterial

<blockmaterial:earth>

BracketHandlers.getBlockMaterial(tokens as string) as MCMaterial
BracketHandlers.getBlockMaterial("earth");
ParameterTypeDescription
tokensstringCo napisaliby państwo w wezwaniu do BEP.
getBlockState

Creates a Blockstate based on the given inputs. Returns null if it cannot find the block, ignored invalid variants

Returns: The found BlockState Return Type: MCBlockState

<blockstate:minecraft:acacia_planks>
<blockstate:minecraft:furnace:facing=north,lit=false>

BracketHandlers.getBlockState(tokens as string) as MCBlockState
BracketHandlers.getBlockState("minecraft:acacia_planks");
BracketHandlers.getBlockState("minecraft:furnace:facing=north,lit=false");
ParameterTypeDescription
tokensstringThe block's resource location and variants
getDamageSource

Gets a damage source based on type. If the damage source is not pre-registered, it will create a new one with the given name

Returns: The found pre-registered damage source or a new one Return Type: DamageSource

<damagesource:magic>

BracketHandlers.getDamageSource(tokens as string) as DamageSource
BracketHandlers.getDamageSource("magic");
ParameterTypeDescription
tokensstringthe damage sources' type
getDirectionAxis

Gets the direction Axis based on name. Throws an error if it can't find the direction Axis.

Returns: The found direction Axis Return Type: DirectionAxis

<directionaxis:x>

BracketHandlers.getDirectionAxis(tokens as string) as DirectionAxis
BracketHandlers.getDirectionAxis("x");
ParameterTypeDescription
tokensstringThe direction Axis's resource location
getEffect

Gets the effect based on registry name. Throws an error if it can't find the effect.

Returns: The found effect Return Type: MCPotionEffect

<effect:minecraft:haste>

BracketHandlers.getEffect(tokens as string) as MCPotionEffect
BracketHandlers.getEffect("minecraft:haste");
ParameterTypeDescription
tokensstringThe effect's resource location
getEnchantment

Gets the enchantment based on registry name. Throws an error if it can't find the enchantment.

Returns: The found enchantment Return Type: MCEnchantment

<enchantment:minecraft:riptide>

BracketHandlers.getEnchantment(tokens as string) as MCEnchantment
BracketHandlers.getEnchantment("minecraft:riptide");
ParameterTypeDescription
tokensstringThe enchantment's registry name
getEntityClassification

Gets the entityClassification based on registry name. Logs an error and returns null if it can't find the entityClassification.

Returns: The found entityClassification Return Type: MCEntityClassification

<entityclassification:monster>

BracketHandlers.getEntityClassification(tokens as string) as MCEntityClassification
BracketHandlers.getEntityClassification("monster");
ParameterTypeDescription
tokensstringThe entityClassification's resource location
getEntityType

Gets the entityType based on registry name. Logs an error and return null if it can't find the entityType.

Returns: The found entityType Return Type: MCEntityType

<entitytype:minecraft:pig>

BracketHandlers.getEntityType(tokens as string) as MCEntityType
BracketHandlers.getEntityType("minecraft:pig");
ParameterTypeDescription
tokensstringThe entityType's resource location
getEquipmentSlotType

Gets the equipment slot type based on name. Throws an error if it can't find the equipment slot type.

Returns: The found equipment slot type Return Type: MCEquipmentSlotType

<equipmentslottype:mainhand>

BracketHandlers.getEquipmentSlotType(tokens as string) as MCEquipmentSlotType
BracketHandlers.getEquipmentSlotType("mainhand");
ParameterTypeDescription
tokensstringThe equipment slot type's name
getFluidStack

Gets the fluid Stack based on registry name. Throws an error if it can't find the fluid.

Returns: A stack of the liquid with amount == 1mb Return Type: IFluidStack

<fluid:minecraft:water>

BracketHandlers.getFluidStack(tokens as string) as IFluidStack
BracketHandlers.getFluidStack("minecraft:water");
ParameterTypeDescription
tokensstringThe Fluid's resource location
getItem

Gets the item based on registry name. Throws an error if it can't find the item.

Returns: The found item Return Type: IItemStack

<item:minecraft:dirt>

BracketHandlers.getItem(tokens as string) as IItemStack
BracketHandlers.getItem("minecraft:dirt");
ParameterTypeDescription
tokensstringThe item's resource location
getPotion

Return Type: MCPotion

BracketHandlers.getPotion(tokens as string) as MCPotion
ParameterTypeDescription
tokensstringNo Description Provided
getProfession

Gets the villager profession based on registry name. Logs an error and return null if it can't find the profession.

Returns: The found profession Return Type: MCVillagerProfession

<profession:minecraft:armorer>

BracketHandlers.getProfession(tokens as string) as MCVillagerProfession
BracketHandlers.getProfession("minecraft:armorer");
ParameterTypeDescription
tokensstringThe profession's resource location
getRecipeManager

Gets the recipeManager based on registry name. Throws an error if it can't find the recipeManager. Throws an exception if the given recipeType is not found.

This will always return IRecipeManager.
There is also a BEP for that but that works differently so it can't be automatically added to the docs here. But the BEP looks the same as the other ones: <recipetype:minecraft:crafting>

Returns: The found recipeManager Return Type: IRecipeManager

BracketHandlers.getRecipeManager(tokens as string) as IRecipeManager
BracketHandlers.getRecipeManager("minecraft:crafting");
ParameterTypeDescription
tokensstringThe recipeManager's resource location
getResourceLocation

Creates a Resource location based on the tokens. Throws an error if the tokens are not a valid location.

Returns: The location Return Type: MCResourceLocation

<resource:minecraft:dirt>

BracketHandlers.getResourceLocation(tokens as string) as MCResourceLocation
BracketHandlers.getResourceLocation("minecraft:dirt");
ParameterTypeDescription
tokensstringThe resource location
getTextFormatting

Return Type: TextFormatting

BracketHandlers.getTextFormatting(tokens as string) as TextFormatting
ParameterTypeDescription
tokensstringNo Description Provided