org.spongepowered.api.item.merchant

Interface VillagerRegistry

public interface VillagerRegistry

Method Summary

Modifier and Type	Method and Description
VillagerRegistry	addMutator(Career career, int level, TradeOfferListMutator mutator) Adds the provided TradeOfferListMutator for the given Career and level.
VillagerRegistry	addMutators(Career career, int level, TradeOfferListMutator mutator, TradeOfferListMutator... mutators) Adds the provided TradeOfferListMutators for the given Career and level.
default Collection<TradeOffer>	generateTradeOffers(Merchant merchant, Career career, int level, Random random) Generates a new List of TradeOffers based on the provided Career, level, and Random.
default Collection<TradeOfferListMutator>	getMutatorsForCareer(Career career, int level) Gets the available TradeOfferListMutators for the desired Career and level.
Multimap<Integer,TradeOfferListMutator>	getTradeOfferLevelMap(Career career) Gets an immutable Multimap of the Career's registered {code level} to TradeOfferListMutators.
default List<TradeOffer>	populateOffers(Merchant merchant, List<TradeOffer> currentOffers, Career career, int level, Random random) Populates the provided List of TradeOffers with potentially new TradeOffers based on the TradeOfferListMutators and level.
VillagerRegistry	setMutators(Career career, int level, List<TradeOfferListMutator> mutators) Sets the provided TradeOfferListMutator for the given Career and level.
VillagerRegistry	setMutators(Career career, Multimap<Integer,TradeOfferListMutator> mutatorMap) Sets the provided TradeOfferListMutator for the given Career and level.

Method Detail

getTradeOfferLevelMap

Multimap<Integer,TradeOfferListMutator> getTradeOfferLevelMap(Career career)

Gets an immutable Multimap of the Career's registered {code level} to TradeOfferListMutators. Note that the map is immutable and cannot be modified directly.

Parameters:

career - The career

Returns:

The immutable multimap

getMutatorsForCareer

default Collection<TradeOfferListMutator> getMutatorsForCareer(Career career,
                                                               int level)

Gets the available TradeOfferListMutators for the desired Career and level.

Parameters:

career - The career

level - The level

Returns:

The collection of trade offer mutators, if available

addMutator

VillagerRegistry addMutator(Career career,
                            int level,
                            TradeOfferListMutator mutator)

Adds the provided TradeOfferListMutator for the given Career and level. Note that the level must be at least 1. There can be multiple TradeOfferListMutators per level.

Parameters:

career - The career

level - The level

mutator - The mutator to register

Returns:

This registry, for chaining

addMutators

VillagerRegistry addMutators(Career career,
                             int level,
                             TradeOfferListMutator mutator,
                             TradeOfferListMutator... mutators)

Adds the provided TradeOfferListMutators for the given Career and level. Note that the level must be at least 1. There can be multiple TradeOfferListMutators per level.

Parameters:

career - The career

level - The level

mutator - The mutator to register

mutators - The additional mutators

Returns:

This registry, for chaining

setMutators

VillagerRegistry setMutators(Career career,
                             int level,
                             List<TradeOfferListMutator> mutators)

Sets the provided TradeOfferListMutator for the given Career and level. Note that the level must be at least 1. There can be multiple TradeOfferListMutators per level. Any previously provided TradeOfferListMutators will be erased.

Parameters:

career - The career

level - The level

mutators - The mutators to register

Returns:

This registry, for chaining

setMutators

VillagerRegistry setMutators(Career career,
                             Multimap<Integer,TradeOfferListMutator> mutatorMap)

Sets the provided TradeOfferListMutator for the given Career and level. Note that the level must be at least 1. There can be multiple TradeOfferListMutators per level. Any previously provided TradeOfferListMutators will be erased.

Parameters:

career - The career

mutatorMap - The mutator map

Returns:

This registry, for chaining

generateTradeOffers

default Collection<TradeOffer> generateTradeOffers(Merchant merchant,
                                                   Career career,
                                                   int level,
                                                   Random random)

Generates a new List of TradeOffers based on the provided Career, level, and Random.

Parameters:

merchant - The merchant

career - The career

level - The level

random - The random

Returns:

The generated list of trade offers

populateOffers

default List<TradeOffer> populateOffers(Merchant merchant,
                                        List<TradeOffer> currentOffers,
                                        Career career,
                                        int level,
                                        Random random)

Populates the provided List of TradeOffers with potentially new TradeOffers based on the TradeOfferListMutators and level. If there are no TradeOfferListMutators registered for the desired level and Career, the list remains unmodified.

Parameters:

merchant - The merchant

currentOffers - The current offers

career - The career

level - The level

random - The random to use

Returns:

The list of offers modified