org.spongepowered.api.item.enchantment

Interface Enchantment.RandomListBuilder

All Superinterfaces:

ResettableBuilder<List<Enchantment>,Enchantment.RandomListBuilder>

Enclosing interface:

Enchantment

public static interface Enchantment.RandomListBuilder
extends ResettableBuilder<List<Enchantment>,Enchantment.RandomListBuilder>

Represents a builder interface which can be used to create a Enchantment.

Method Summary

Modifier and Type	Method and Description
List<Enchantment>	build() Builds an instance of a Enchantment based on the entered information.
Enchantment.RandomListBuilder	fixedPool(List<Enchantment> pool) Sets a fixed pool for the random enchantments to pick from.
Enchantment.RandomListBuilder	item(ItemStack item) Sets the item for which the enchantments are chosen
Enchantment.RandomListBuilder	level(int level) Sets the enchanting level.
Enchantment.RandomListBuilder	option(int option) Sets the enchanting option.
Enchantment.RandomListBuilder	seed(int seed) Sets the random seed.
Enchantment.RandomListBuilder	treasure(boolean treasure) Sets whether to include treasure enchantments or not

Methods inherited from interface org.spongepowered.api.util.ResettableBuilder

from, reset

Method Detail

seed

Enchantment.RandomListBuilder seed(int seed)

Sets the random seed.

Parameters:

seed - the random seed

Returns:

The modified builder, for chaining

option

Enchantment.RandomListBuilder option(int option)

Sets the enchanting option. (1-3 in vanilla)

Parameters:

option - the enchanting option

Returns:

The modified builder, for chaining

level

Enchantment.RandomListBuilder level(int level)

Sets the enchanting level. (max. 30 in vanilla)

Parameters:

level - the enchanting level

Returns:

The modified builder, for chaining

treasure

Enchantment.RandomListBuilder treasure(boolean treasure)

Sets whether to include treasure enchantments or not

Parameters:

treasure - whether to include treasure enchantments or not

Returns:

The modified builder, for chaining

fixedPool

Enchantment.RandomListBuilder fixedPool(List<Enchantment> pool)

Sets a fixed pool for the random enchantments to pick from.

If empty a pool will be calculated based on the other values instead.

Parameters:

pool - the fixed pool of enchantments

Returns:

The modified builder, for chaining

item

Enchantment.RandomListBuilder item(ItemStack item)

Sets the item for which the enchantments are chosen

Parameters:

item - the item for which the enchantments are chosen

Returns:

The modified builder, for chaining

build

List<Enchantment> build()
                 throws IllegalStateException

Builds an instance of a Enchantment based on the entered information.

Returns:

The created enchantment

Throws:

IllegalStateException - If a required value was not specified