LootModifierManager

Importing the class

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.loot.modifier.LootModifierManager;

Description

Manager for loot modifiers.

An instance of this manager can be obtained via the com.blamejared.crafttweaker.api.loot.LootManager.

The main usage of this manager is for registering "global loot modifiers", also known as "loot modifiers" for short. A global loot modifier runs on the loot drop of every loot table (unless otherwise specified by conditions) and is as such able to modify it according either to predetermined parameters (e.g. replacing items) or via completely customized code that leverages the dropping context.

For more information, refer to ILootModifier.

Members

Gets a list containing all currently registered loot modifiers.

Returns: A list containing all currently registered loot modifiers.

// LootModifierManager.getAll() as List<ILootModifier>;
myLootModifierManager.getAll();

Return Type: List<ILootModifier>

Gets a list of all the names of the currently registered loot modifiers.

Returns: A list with all the names of the currently registered loot modifiers.

// LootModifierManager.getAllNames() as List<ResourceLocation>;
myLootModifierManager.getAllNames();

Return Type: List<ResourceLocation>

Gets the loot modifier with the given name, if it exists.

If no loot modifier with that name exists, a default no-op instance is returned.

Returns: The ILootModifier with the given name, or a default one if no such instance exists.

// LootModifierManager.getByName(name as string) as ILootModifier;
myLootModifierManager.getByName(myString);

Parameters:

name: string Type: string - The name of the loot modifier.

Return Type: ILootModifier

Registers a new global loot modifier with the given name.

The loot modifier will be run only when the given set of conditions is satisfied.

// LootModifierManager.register(name as string, conditions as LootConditions, modifier as ILootModifier);
myLootModifierManager.register(myString, myLootConditions, myILootModifier);

Parameters:

name: string Type: string - The unique identifier for the loot modifier. It must be all lowercase and devoid of both spaces and
colons.

conditions: LootConditions Type: LootConditions - A set of conditions that restrict the context in which the loot modifier applies.

modifier: ILootModifier Type: ILootModifier - The loot modifier itself. It may be created via CommonLootModifiers.

Removes all loot modifiers that have been registered up to this point.

// LootModifierManager.removeAll();
myLootModifierManager.removeAll();

Removes all loot modifiers that have been registered by the mod with the given ID.

// LootModifierManager.removeByModId(modId as string);
myLootModifierManager.removeByModId(myString);

Parameters:

modId: string Type: string - The mod ID.

Removes the loot modifier with the given name.

The name may either contain a colon or not. If no colon is present, it is assumed that the loot modifier name is one of the modifiers that have been already registered in a script.

// LootModifierManager.removeByName(name as string);
myLootModifierManager.removeByName(myString);

Parameters:

name: string Type: string - The name of the loot modifier to remove.

Removes all loot modifiers whose name matches the given regular expression.

The entire name is taken into consideration for the match, effectively matching the format of a ResourceLocation.

// LootModifierManager.removeByRegex(regex as string);
myLootModifierManager.removeByRegex(myString);

Parameters:

regex: string Type: string - The regular expression to match.