CommonLootModifiers

Link to commonlootmodifiers

Holds a set of implementations of ILootModifier of common usage.

These can be used freely instead of rewriting the same code more than once. They are also guaranteed to behave correctly.

Importing the class

Link to 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.

ZenScript
Copy
import crafttweaker.api.loot.modifiers.CommonLootModifiers;

Name: add

Adds the given IItemStack to the drops.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.add(stack as IItemStack) as ILootModifier

CommonLootModifiers.add(<item:minecraft:cobblestone>);
ParameterTypeDescription
Parameter
stack
Type
IItemStack
Description
The stack to add

Name: addAll

Adds all the given IItemStack to the drops.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.addAll(stacks as IItemStack[]) as ILootModifier

CommonLootModifiers.addAll(<item:minecraft:iron_ingot>, <item:minecraft:iron_nugget> * 5);
ParameterTypeDescription
Parameter
stacks
Type
IItemStack[]
Description
The stacks to add

Link to g-addallwithbinomialbonus

Name: addAllWithBinomialBonus

Adds the given IItemStacks to the drops, modifying their count based on the level of the given <br /> MCEnchantment on the tool used, if available. <br /> <br /> In case no tool is used to obtain the stack, then this loot modifier behaves exactly like <br /> this#addAll(IItemStack...). <br /> <br /> The fortune modifier is applied separately for each IItemStack. <br /> <br /> The formula used is based on the binomial_with_bonus_count formula used by vanilla. In this case, the <br /> value of extra is added to the current tool's enchantment level; that determines the amount of times the <br /> randomness will roll. Every roll that is higher than p will add one element to the stack. This is the <br /> formula used by potatoes and carrots to determine their drop count.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.addAllWithBinomialBonus(enchantment as MCEnchantment, extra as int, p as float, stacks as IItemStack[]) as ILootModifier

CommonLootModifiers.addAllWithBinomialBonus(<enchantment:minecraft:fortune>, 3, 0.5714286, <item:minecraft:wheat_seeds>, <item:minecraft:carrot> * 9);
ParameterTypeDescription
Parameter
enchantment
Type
MCEnchantment
Description
The enchantment to check for.
Parameter
extra
Type
int
Description
An extra value that will be added to the tool's enchantment level.
Parameter
p
Type
float
Description
The probability of the binomial distribution, between 0.0 and 1.0 (both exclusive).
Parameter
stacks
Type
IItemStack[]
Description
The stacks to add.

Name: addAllWithChance

Adds the given MCWeightedItemStacks to the drops, according to the specified chances. <br /> <br /> The chance will be computed on each modifier roll, and independently for each of the given stacks.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.addAllWithChance(stacks as MCWeightedItemStack[]) as ILootModifier

CommonLootModifiers.addAllWithChance(<item:minecraft:honey_bottle> % 50, <item:minecraft:dried_kelp> % 13);
ParameterTypeDescription
Parameter
stacks
Type
MCWeightedItemStack[]
Description
The stacks to add.

Link to g-addallwithoredropsbonus

Name: addAllWithOreDropsBonus

Adds the given IItemStacks to the drops, modifying their count based on the level of the given <br /> MCEnchantment on the tool used, if available. <br /> <br /> In case no tool is used to obtain the stack, then this loot modifier behaves exactly like <br /> this#addAll(IItemStack...). <br /> <br /> The fortune modifier is applied separately for each IItemStack. <br /> <br /> The formula used is based on the ore_drops formula used by vanilla, which multiplies the stack's <br /> original count by a random number between 1 and the tool's enchantment level + 1. This is the formula used by <br /> all vanilla ores to determine their drop count.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.addAllWithOreDropsBonus(enchantment as MCEnchantment, stacks as IItemStack[]) as ILootModifier

CommonLootModifiers.addAllWithOreDropsBonus(<enchantment:minecraft:fortune>, <item:minecraft:coal>, <item:minecraft:diamond>);
ParameterTypeDescription
Parameter
enchantment
Type
MCEnchantment
Description
The enchantment to check for.
Parameter
stacks
Type
IItemStack[]
Description
The stacks to add.

Link to g-addallwithuniformbonus

Name: addAllWithUniformBonus

Adds the given IItemStacks to the drops, modifying their count based on the level of the given <br /> MCEnchantment on the tool used, if available. <br /> <br /> In case no tool is used to obtain the stack, then this loot modifier behaves exactly like <br /> this#addAll(IItemStack...). <br /> <br /> The fortune modifier is applied separately for each IItemStack. <br /> <br /> The formula used is based on the uniform_bonus_count formula used by vanilla. In this case, the <br /> enchantment level is multiplied by multiplier and a random number is extracted between 0 and the result. <br /> This number is then added to the original's stack count. This is the formula used by redstone ore and glowstone <br /> to determine their drop count.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.addAllWithUniformBonus(enchantment as MCEnchantment, multiplier as int, stacks as IItemStack[]) as ILootModifier

CommonLootModifiers.addAllWithUniformBonus(<enchantment:minecraft:fortune>, 1, <item:minecraft:glowstone_dust>, <item:minecraft:prismarine_crystals>);
ParameterTypeDescription
Parameter
enchantment
Type
MCEnchantment
Description
The enchantment to check for.
Parameter
multiplier
Type
int
Description
A multiplier that will be used in conjunction with the enchantment's level.
Parameter
stacks
Type
IItemStack[]
Description
The stacks to add.

Link to g-addwithbinomialbonus

Name: addWithBinomialBonus

Adds the given IItemStack to the drops, modifying its count based on the level of the given <br /> MCEnchantment on the tool used, if available. <br /> <br /> In case no tool is used to obtain the stack, then this loot modifier behaves exactly like <br /> this#add(IItemStack). <br /> <br /> The formula used is based on the binomial_with_bonus_count formula used by vanilla. In this case, the <br /> value of extra is added to the current tool's enchantment level; that determines the amount of times the <br /> randomness will roll. Every roll that is higher than p will add one element to the stack. This is the <br /> formula used by potatoes and carrots to determine their drop count.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.addWithBinomialBonus(enchantment as MCEnchantment, extra as int, p as float, stack as IItemStack) as ILootModifier

CommonLootModifiers.addWithBinomialBonus(<enchantment:minecraft:fortune>, 3, 0.5714286, <item:minecraft:wheat_seeds>);
ParameterTypeDescription
Parameter
enchantment
Type
MCEnchantment
Description
The enchantment to check for.
Parameter
extra
Type
int
Description
An extra value that will be added to the tool's enchantment level.
Parameter
p
Type
float
Description
The probability of the binomial distribution, between 0.0 and 1.0 (both exclusive).
Parameter
stack
Type
IItemStack
Description
The stack to add.

Name: addWithChance

Adds the given MCWeightedItemStack to the drops, according to the specified chances. <br /> <br /> The chance will be computed on each modifier roll.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.addWithChance(stack as MCWeightedItemStack) as ILootModifier

CommonLootModifiers.addWithChance(<item:minecraft:gilded_blackstone> % 50);
ParameterTypeDescription
Parameter
stack
Type
MCWeightedItemStack
Description
The stack to add.

Link to g-addwithoredropsbonus

Name: addWithOreDropsBonus

Adds the given IItemStack to the drops, modifying its count based on the level of the given <br /> MCEnchantment on the tool used, if available. <br /> <br /> In case no tool is used to obtain the stack, then this loot modifier behaves exactly like <br /> this#add(IItemStack). <br /> <br /> The formula used is based on the ore_drops formula used by vanilla, which multiplies the stack's <br /> original count by a random number between 1 and the tool's enchantment level + 1. This is the formula used by <br /> all vanilla ores to determine their drop count.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.addWithOreDropsBonus(enchantment as MCEnchantment, stack as IItemStack) as ILootModifier

CommonLootModifiers.addWithOreDropsBonus(<enchantment:minecraft:fortune>, <item:minecraft:coal>);
ParameterTypeDescription
Parameter
enchantment
Type
MCEnchantment
Description
The enchantment to check for.
Parameter
stack
Type
IItemStack
Description
The stack to add.

Name: addWithRandomAmount

Adds the given IItemStack to the drops, with an amount chosen randomly between the given bounds. <br /> <br /> Any original stack size given to this method is ignored; if an addition behavior is desired (as in random <br /> chance <em>on top</em> of the original stack size), a combining loot modifier should be used instead.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.addWithRandomAmount(stack as IItemStack, min as int, max as int) as ILootModifier

CommonLootModifiers.addWithRandomAmount(<item:minecraft:conduit>, 2, 9);
ParameterTypeDescription
Parameter
stack
Type
IItemStack
Description
The stack to add.
Parameter
min
Type
int
Description
The minimum amount that this stack can be.
Parameter
max
Type
int
Description
The maximum amount that this stack can be.

Name: addWithUniformBonus

Adds the given IItemStack to the drops, modifying its count based on the level of the given <br /> MCEnchantment on the tool used, if available. <br /> <br /> In case no tool is used to obtain the stack, then this loot modifier behaves exactly like <br /> this#add(IItemStack). <br /> <br /> The formula used is based on the uniform_bonus_count formula used by vanilla. In this case, the <br /> enchantment level is multiplied by multiplier and a random number is extracted between 0 and the result. <br /> This number is then added to the original's stack count. This is the formula used by redstone ore and glowstone <br /> to determine their drop count.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.addWithUniformBonus(enchantment as MCEnchantment, multiplier as int, stack as IItemStack) as ILootModifier

CommonLootModifiers.addWithUniformBonus(<enchantment:minecraft:fortune>, 1, <item:minecraft:glowstone_dust>);
ParameterTypeDescription
Parameter
enchantment
Type
MCEnchantment
Description
The enchantment to check for.
Parameter
multiplier
Type
int
Description
A multiplier that will be used in conjunction with the enchantment's level.
Parameter
stack
Type
IItemStack
Description
The stack to add.

Name: chaining

Chains the given list of ILootModifiers to be executed one after the other.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.chaining(modifiers as ILootModifier[]) as ILootModifier

CommonLootModifiers.chaining(CommonLootModifiers.clearLoot(), CommonLootModifiers.add(<item:minecraft:warped_hyphae>));
ParameterTypeDescription
Parameter
modifiers
Type
ILootModifier[]
Description
The modifier list.

Name: clearLoot

Clears the entire drop list.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.clearLoot() as ILootModifier

CommonLootModifiers.clearLoot();

Name: clearing

Chains the given list of ILootModifiers together after having cleaned the original loot.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.clearing(modifiers as ILootModifier[]) as ILootModifier

CommonLootModifiers.clearing(CommonLootModifiers.add(<item:minecraft:warped_hyphae>));
ParameterTypeDescription
Parameter
modifiers
Type
ILootModifier[]
Description
The modifier list.

Name: remove

Removes every instance of the targeted IIngredient from the drops.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.remove(target as IIngredient) as ILootModifier

CommonLootModifiers.remove(<tag:items:minecraft:creeper_drop_music_discs>);
ParameterTypeDescription
Parameter
target
Type
IIngredient
Description
The IIngredient to remove.

Name: removeAll

Removes every instance of all the targeted IIngredients from the drops.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.removeAll(targets as IIngredient[]) as ILootModifier

CommonLootModifiers.removeAll(<item:minecraft:bell>, <tag:items:minecraft:rails>);
ParameterTypeDescription
Parameter
targets
Type
IIngredient[]
Description
The IIngredients to remove.

Link to g-replaceallstackswith

Name: replaceAllStacksWith

Replaces every instance of the targeted IItemStacks with the replacement IItemStacks, <br /> proportionally. <br /> <br /> As an example, if the loot drops 5 carrots and this loot modifier runs with 2 carrots as the key of a pair and 1 <br /> potato as the corresponding value, the loot will be modified to 2 potatoes and 1 carrot. This happens because <br /> every 2-carrot stack will be actively replaced by a 1-potato stack, without exceptions. <br /> <br /> This loot modifier acts differently than this#replaceAllWith(Map), where a simpler approach is used.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.replaceAllStacksWith(replacementMap as IItemStack[IItemStack]) as ILootModifier

CommonLootModifiers.replaceAllStacksWith({ <item:minecraft:carrots> * 2 : <item:minecraft:potatoes> });
ParameterTypeDescription
Parameter
replacementMap
Type
IItemStack[IItemStack]
Description
A map of key-value pairs dictating the target to replace along with their replacement.

Name: replaceAllWith

Replaces every instance of the targeted IIngredients with their corresponding replacement <br /> IItemStack. <br /> <br /> In this case, a simple matching procedure is used, where every stack that matches the key of the pair is replaced <br /> by the corresponding value, without considering stack size. If stack size is to be preserved, refer to <br /> this#replaceAllStacksWith(Map).

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.replaceAllWith(replacementMap as IItemStack[IIngredient]) as ILootModifier

CommonLootModifiers.replaceAllWith({ <tag:items:forge:gems/emerald> : <item:minecraft:emerald> });
ParameterTypeDescription
Parameter
replacementMap
Type
IItemStack[IIngredient]
Description
A map of key-value pairs dictating the target to replace along with their replacement.

Name: replaceStackWith

Replaces every instance of the targeted IItemStack with the replacement IItemStack, <br /> proportionally. <br /> <br /> As an example, if the loot drops 5 carrots and this loot modifier runs with 2 carrots as the <code>target</code> <br /> and 1 potato as the <code>replacement</code>, the loot will be modified to 2 potatoes and 1 carrot. This happens <br /> because every 2-carrot stack will be actively replaced by a 1-potato stack, without exceptions. <br /> <br /> This loot modifier acts differently than this#replaceWith(IIngredient, IItemStack), where a simpler approach <br /> is used.

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.replaceStackWith(target as IItemStack, replacement as IItemStack) as ILootModifier

CommonLootModifiers.replaceStackWith(<item:minecraft:carrots> * 2, <item:minecraft:potatoes>);
ParameterTypeDescription
Parameter
target
Type
IItemStack
Description
The target to replace.
Parameter
replacement
Type
IItemStack
Description
The replacement to use.

Name: replaceWith

Replaces every instance of the targeted IIngredient with the replacement IItemStack. <br /> <br /> In this case, a simple matching procedure is used, where every stack that matches the given <code>target</code> <br /> is replaced by the <code>replacement</code> without considering stack size. If stack size is to be preserved, <br /> refer to this#replaceStackWith(IItemStack, IItemStack).

Returns: An ILootModifier that carries out the operation.
Return Type: ILootModifier

ZenScript
Copy
// CommonLootModifiers.replaceWith(target as IIngredient, replacement as IItemStack) as ILootModifier

CommonLootModifiers.replaceWith(<tag:items:forge:ingots/iron>, <item:minecraft:iron_ingot>);
ParameterTypeDescription
Parameter
target
Type
IIngredient
Description
The target to replace.
Parameter
replacement
Type
IItemStack
Description
The replacement to use.