eu.wauz.wauzcore.items.identifiers

Class WauzEquipmentBuilder

java.lang.Object

eu.wauz.wauzcore.items.identifiers.WauzEquipmentBuilder

public class WauzEquipmentBuilder
extends java.lang.Object

A class for generating equipment with all possible skill and stat combinations.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	armorCategoryString The display of the armor category of the equipment.
private int	attackStat The attack stat of the equipment.
private int	defenseStat The defense stat of the equipment.
private java.lang.String	durabilityString The display of the durability stat of the equipment.
static java.lang.String	EMPTY_RUNE_SLOT An empty rune slot, to put in the equipment lore.
static java.lang.String	EMPTY_SKILL_SLOT An empty skillgem slot, to put in the equipment lore.
private java.util.List<java.lang.String>	enhancementStrings The displays of the enhancements of the equipment.
private java.lang.String	enhancementSuffix The suffix to add behind the name of the equipment.
private org.bukkit.inventory.meta.ItemMeta	itemMeta The item meta of the equipment item.
private org.bukkit.inventory.ItemStack	itemStack The equipment item stack.
private java.lang.String	rarityNamePrefix The prefix of the name of the equipment's rarity.
private java.lang.String	rarityStarPrefix The prefix of the star rating of the equipment's rarity.
private java.lang.String	scalingString The display of the scaled level of the equipment.
private WauzPlayerSkill	skillgem The skillgem to socket into the equipment.
private java.lang.String	speedString The display of the speed stat of the equipment.
private java.lang.String	swiftnessString The display of the swiftness stat of the equipment.

Constructor Summary

Constructors

Constructor and Description
WauzEquipmentBuilder(org.bukkit.Material material) Constructs a builder for creating a new equipment item.

Method Summary

Modifier and Type	Method and Description
void	addArmorCategory(ArmorCategory armorCategory) Adds an armor category to the equipment item.
void	addDurabilityStat(int durabilityStat) Adds a durability stat to the equipment item.
void	addEnhancementString(java.lang.String enhancementString, java.lang.String enhancementSuffix) Adds an enhancement string to the equipment item.
void	addLeatherDye(org.bukkit.Color color) Adds a leather dye to the equipment item.
private void	addLoreIfNotBlank(java.util.List<java.lang.String> lores, java.lang.String lore) Extends the lore list, if the given lore string is not blank.
void	addMainStats(int attackStat, int defenseStat, int requiredLevel, float scalingLevel) Adds a main stat, including level requirement to the equipment item.
void	addRarityPrefixes(java.lang.String rarityNamePrefix, java.lang.String rarityStarPrefix) Adds custom prefixes to the rarity display of the equipment item.
void	addShieldPattern() Adds a random shield pattern to the equipment item.
void	addSkillgem(WauzPlayerSkill skill) Adds a skillgem to socket into the equipment item.
void	addSpeedStat(double speedStat) Adds a speed stat to the equipment item.
void	addSwiftnessStat(int swiftnessStat) Adds a swiftness stat to the equipment item.
private void	applyCustomItemProperties(java.util.List<java.lang.String> lores, CustomItem customItem, Rarity rarity) Adds the possible properties of a custom item class to the lores.
org.bukkit.inventory.ItemStack	generate(Tier tier, Rarity rarity, EquipmentType type, java.lang.String name) Generates the equipment item stack, as configured in the builder.
void	makeUnbreakable() Makes the equipment item unbreakable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_SKILL_SLOT

public static final java.lang.String EMPTY_SKILL_SLOT

An empty skillgem slot, to put in the equipment lore.

EMPTY_RUNE_SLOT

public static final java.lang.String EMPTY_RUNE_SLOT

An empty rune slot, to put in the equipment lore.

itemStack

private org.bukkit.inventory.ItemStack itemStack

The equipment item stack.

itemMeta

private org.bukkit.inventory.meta.ItemMeta itemMeta

The item meta of the equipment item.

rarityNamePrefix

private java.lang.String rarityNamePrefix

The prefix of the name of the equipment's rarity.

rarityStarPrefix

private java.lang.String rarityStarPrefix

The prefix of the star rating of the equipment's rarity.

attackStat

private int attackStat

The attack stat of the equipment.

defenseStat

private int defenseStat

The defense stat of the equipment.

scalingString

private java.lang.String scalingString

The display of the scaled level of the equipment.

durabilityString

private java.lang.String durabilityString

The display of the durability stat of the equipment.

speedString

private java.lang.String speedString

The display of the speed stat of the equipment.

swiftnessString

private java.lang.String swiftnessString

The display of the swiftness stat of the equipment.

armorCategoryString

private java.lang.String armorCategoryString

The display of the armor category of the equipment.

enhancementStrings

private java.util.List<java.lang.String> enhancementStrings

The displays of the enhancements of the equipment.

enhancementSuffix

private java.lang.String enhancementSuffix

The suffix to add behind the name of the equipment.

skillgem

private WauzPlayerSkill skillgem

The skillgem to socket into the equipment.

Constructor Detail

WauzEquipmentBuilder

public WauzEquipmentBuilder(org.bukkit.Material material)

Constructs a builder for creating a new equipment item.

Parameters:

material - The material of the equipment item.

Method Detail

addShieldPattern

public void addShieldPattern()

Adds a random shield pattern to the equipment item.

addLeatherDye

public void addLeatherDye(org.bukkit.Color color)

Adds a leather dye to the equipment item.

Parameters:

color - The color of the dye.

addSkillgem

public void addSkillgem(WauzPlayerSkill skill)

Adds a skillgem to socket into the equipment item.

Parameters:

skill - The skill to add.

makeUnbreakable

public void makeUnbreakable()

Makes the equipment item unbreakable.

addRarityPrefixes

public void addRarityPrefixes(java.lang.String rarityNamePrefix,
                              java.lang.String rarityStarPrefix)

Adds custom prefixes to the rarity display of the equipment item.

Parameters:

rarityNamePrefix - The prefix of the name of the equipment's rarity.

rarityStarPrefix - The prefix of the star rating of the equipment's rarity.

addMainStats

public void addMainStats(int attackStat,
                         int defenseStat,
                         int requiredLevel,
                         float scalingLevel)

Adds a main stat, including level requirement to the equipment item.

Parameters:

attackStat - The value of the attack stat.

defenseStat - The value of the defense stat.

requiredLevel - The level requirement.

scalingLevel - The scaling of the stats, where 1 = unscaled.

addDurabilityStat

public void addDurabilityStat(int durabilityStat)

Adds a durability stat to the equipment item.

Parameters:

durabilityStat - The value of the stat.

addSpeedStat

public void addSpeedStat(double speedStat)

Adds a speed stat to the equipment item.

Parameters:

speedStat - The value of the stat.

addSwiftnessStat

public void addSwiftnessStat(int swiftnessStat)

Adds a swiftness stat to the equipment item.

Parameters:

swiftnessStat - The value of the stat.

addArmorCategory

public void addArmorCategory(ArmorCategory armorCategory)

Adds an armor category to the equipment item.

Parameters:

armorCategory - The category.

addEnhancementString

public void addEnhancementString(java.lang.String enhancementString,
                                 java.lang.String enhancementSuffix)

Adds an enhancement string to the equipment item.

Parameters:

enhancementString - The enhancement string.

enhancementSuffix - The suffix to add behind the name of the equipment or null.

generate

public org.bukkit.inventory.ItemStack generate(Tier tier,
                                               Rarity rarity,
                                               EquipmentType type,
                                               java.lang.String name)

Generates the equipment item stack, as configured in the builder.

Parameters:

tier - The tier of the equipment item.

rarity - The rarity of the equipment item.

type - The type of the equipment item.

name - The name of the equipment item.

Returns:

The generated equipment item stack.

See Also:

addLoreIfNotBlank(List, String), applyCustomItemProperties(List, CustomItem, Rarity)

addLoreIfNotBlank

private void addLoreIfNotBlank(java.util.List<java.lang.String> lores,
                               java.lang.String lore)

Extends the lore list, if the given lore string is not blank.

Parameters:

lores - The list of lores.

lore - The lore to add.

applyCustomItemProperties

private void applyCustomItemProperties(java.util.List<java.lang.String> lores,
                                       CustomItem customItem,
                                       Rarity rarity)

Adds the possible properties of a custom item class to the lores. Custom weapons with magic or higher rarity have a 50% chance to receive a skilgem slot. Magic or higher items will get 1 rune slot, while epic or higher items will receive 2 slots.

Parameters:

lores - The list of lores.

customItem - The custom item class.

rarity - The rarity of the item.