BracketHandlers

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

import crafttweaker.api.bracket.BracketHandlers;

Description

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.

Members

// BracketHandlers.getAttribute(tokens as string) as Attribute;
BracketHandlers.getAttribute(myString);

Parameters:

tokens: string Type: string

Return Type: Attribute

Gets a banner pattern based on registry name. Throws an exception if it can't find the banner pattern.

Returns: The found banner pattern

// BracketHandlers.getBannerPattern(tokens as string) as BannerPattern;
BracketHandlers.getBannerPattern("minecraft:square_bottom_left");

Parameters:

tokens: string Type: string - The banner pattern's resource location

Return Type: BannerPattern

Gets the give Block. Throws an Exception if not found

Returns: The found Block

// BracketHandlers.getBlock(tokens as string) as Block;
BracketHandlers.getBlock("minecraft:dirt");

Parameters:

tokens: string Type: string - What you would write in the BEP call.

Return Type: Block

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

Returns: The found BlockState

// BracketHandlers.getBlockState(tokens as string) as BlockState;
BracketHandlers.getBlockState("minecraft:acacia_planks");

Parameters:

tokens: string Type: string - The block's resource location and variants

Return Type: BlockState

Gets a data component type based on registry name. Throws an exception if it can't find the data component type.

Returns: The found data component type

// BracketHandlers.getComponentType(tokens as string) as DataComponentType<T>;
BracketHandlers.getComponentType("minecraft:max_stack_size");

Parameters:

tokens: string Type: string - The data component type's resource location

Return Type: DataComponentType<T>

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

Returns: The found enchantment

// BracketHandlers.getEnchantment(tokens as string) as Enchantment;
BracketHandlers.getEnchantment("minecraft:riptide");

Parameters:

tokens: string Type: string - The enchantment's registry name

Return Type: Enchantment

Gets the entityType based on registry name. Throws an exception if it can't find the entityType.

Returns: The found entityType

// BracketHandlers.getEntityType(tokens as string) as EntityType<Entity>;
BracketHandlers.getEntityType("minecraft:pig");

Parameters:

tokens: string Type: string - The entityType's resource location

Return Type: EntityType<Entity>

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

// BracketHandlers.getFluidStack(tokens as string) as IFluidStack;
BracketHandlers.getFluidStack("minecraft:water");

Parameters:

tokens: string Type: string - The Fluid's resource location

Return Type: IFluidStack

Gets an instrument based on registry name. Throws an exception if it can't find the instrument.

Returns: The found instrument

// BracketHandlers.getInstrument(tokens as string) as Instrument;
BracketHandlers.getInstrument("minecraft:ponder_goat_horn");

Parameters:

tokens: string Type: string - The instrument's resource location

Return Type: Instrument

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

Returns: The found item

// BracketHandlers.getItem(tokens as string) as IItemStack;
BracketHandlers.getItem("minecraft:dirt");

Parameters:

tokens: string Type: string - The item's resource location

Return Type: IItemStack

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

Returns: The found mobeffect

// BracketHandlers.getMobEffect(tokens as string) as MobEffect;
BracketHandlers.getMobEffect("minecraft:haste");

Parameters:

tokens: string Type: string - The mobeffect's resource location

Return Type: MobEffect

// BracketHandlers.getPotion(tokens as string) as Potion;
BracketHandlers.getPotion(myString);

Parameters:

tokens: string Type: string

Return Type: Potion

Gets the villager profession based on registry name. Throws an exception if it can't find the profession.

Returns: The found profession

// BracketHandlers.getProfession(tokens as string) as VillagerProfession;
BracketHandlers.getProfession("minecraft:armorer");

Parameters:

tokens: string Type: string - The profession's resource location

Return Type: VillagerProfession

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

// BracketHandlers.getRecipeManager(tokens as string) as IRecipeManager<?>;
BracketHandlers.getRecipeManager("minecraft:crafting");

Parameters:

tokens: string Type: string - The recipeManager's resource location

Return Type: IRecipeManager<?>

Gets a sound event based on registry name. Throws an exception if it can't find the sound event.

Returns: The found sound event

// BracketHandlers.getSoundEvent(tokens as string) as SoundEvent;
BracketHandlers.getSoundEvent("minecraft:ambient.cave");

Parameters:

tokens: string Type: string - The sound event's resource location

Return Type: SoundEvent

Gets an ITargetingStrategy based on its name.

Throws an exception if the strategy doesn't exist.

Returns: The found targeting strategy

// BracketHandlers.getTargetingStrategy(tokens as string) as ITargetingStrategy;
BracketHandlers.getTargetingStrategy("crafttweaker:default");

Parameters:

tokens: string Type: string - The strategy's resource location

Return Type: ITargetingStrategy

Gets a trim material based on registry name. Throws an exception if it can't find the trim material.

Returns: The found trim material

// BracketHandlers.getTrimMaterial(tokens as string) as TrimMaterial;
BracketHandlers.getTrimMaterial("minecraft:quartz");

Parameters:

tokens: string Type: string - The trim material's resource location

Return Type: TrimMaterial

Gets a trim pattern based on registry name. Throws an exception if it can't find the trim pattern.

Returns: The found trim pattern

// BracketHandlers.getTrimPattern(tokens as string) as TrimPattern;
BracketHandlers.getTrimPattern("minecraft:sentry");

Parameters:

tokens: string Type: string - The trim pattern's resource location

Return Type: TrimPattern

Gets the villager profession based on registry name. Throws an exception if it can't find the profession.

Returns: The found profession

// BracketHandlers.getVillagerType(tokens as string) as VillagerType;
BracketHandlers.getVillagerType("minecraft:armorer");

Parameters:

tokens: string Type: string - The profession's resource location

Return Type: VillagerType

BracketHandlers

Importing the class

Description

Members