Package org.bukkit.inventory.meta.components

Interface BlocksAttacksComponent

All Superinterfaces:

ConfigurationSerializable

@Experimental
public interface BlocksAttacksComponent
extends ConfigurationSerializable

Represents a component which can turn any item into a shield-like item which blocks attack damage.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BlocksAttacksComponent.DamageReduction	A damage reduction for a specific set of damage types.

Method Summary

Modifier and Type	Method	Description
BlocksAttacksComponent.DamageReduction	addDamageReduction(Collection<DamageType> types, float base, float factor, float horizontalBlockingAngle)	Add a new damage reduction to this component, which blocks specific types of attacks.
BlocksAttacksComponent.DamageReduction	addDamageReduction(DamageType type, float base, float factor, float horizontalBlockingAngle)	Add a new damage reduction to this component, which blocks specific types of attacks.
BlocksAttacksComponent.DamageReduction	addDamageReduction(Tag<DamageType> tag, float base, float factor, float horizontalBlockingAngle)	Add a new damage reduction to this component, which blocks specific types of attacks.
float	getBlockDelaySeconds()	Gets the delay on equip before this item will block attacks.
Sound	getBlockSound()	Gets the sound to play when the item blocks an attack.
Tag<DamageType>	getBypassedBy()	Gets the type of damage that will bypass blocking by this item.
List<BlocksAttacksComponent.DamageReduction>	getDamageReductions()	Get the list of DamageReductions that apply to this item.
float	getDisableCooldownScale()	Gets the multiplier applied to the item cooldown when attacked by a disabling attack.
Sound	getDisableSound()	Gets the sound to play when the item is disabled.
float	getItemDamageBase()	Gets the constant amount of damage applied to the item if the threshold is reached.
float	getItemDamageFactor()	Gets the proportion of damage applied to the item if the threshold is reached.
float	getItemDamageThreshold()	Gets the amount of damage required to be dealt before damage is also applied to the item.
boolean	removeDamageReduction(BlocksAttacksComponent.DamageReduction reduction)	Remove the given BlocksAttacksComponent.DamageReduction from this item.
void	setBlockDelaySeconds(float seconds)	Sets the delay on equip before this item will block attacks.
void	setBlockSound(Sound sound)	Sets the sound to play when the item blocks an attack.
void	setBypassedBy(Tag<DamageType> tag)	Sets the type of damage that will bypass blocking by this item.
void	setDamageReductions(List<BlocksAttacksComponent.DamageReduction> reductions)	Set the list of DamageReductions to apply to this item.
void	setDisableCooldownScale(float scale)	Sets the multiplier applied to the item cooldown when attacked by a disabling attack.
void	setDisableSound(Sound sound)	Sets the sound to play when the item is disabled.
void	setItemDamageBase(float base)	Sets the constant amount of damage applied to the item if the threshold is reached.
void	setItemDamageFactor(float factor)	Sets the proportion of damage applied to the item if the threshold is reached.
void	setItemDamageThreshold(float threshold)	Sets the amount of damage required to be dealt before damage is also applied to the item.

Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable

serialize

Method Details

getBlockDelaySeconds

float getBlockDelaySeconds()

Gets the delay on equip before this item will block attacks.

Returns:

the delay in seconds

setBlockDelaySeconds

void setBlockDelaySeconds(float seconds)

Sets the delay on equip before this item will block attacks.

Parameters:

seconds - the delay in seconds to set

getDisableCooldownScale

float getDisableCooldownScale()

Gets the multiplier applied to the item cooldown when attacked by a disabling attack.

Returns:

the scale

setDisableCooldownScale

void setDisableCooldownScale(float scale)

Sets the multiplier applied to the item cooldown when attacked by a disabling attack.

Parameters:

scale - the scale to set. Must be 0 or a positive integer

getDamageReductions

@NotNull
List<BlocksAttacksComponent.DamageReduction> getDamageReductions()

Get the list of DamageReductions that apply to this item.

Returns:

all damage reductions. The mutability of the returned list cannot be guaranteed, but its contents are mutable and can have their values changed

setDamageReductions

void setDamageReductions(@NotNull
 List<BlocksAttacksComponent.DamageReduction> reductions)

Set the list of DamageReductions to apply to this item. This will remove any existing damage reductions.

Parameters:

reductions - the reductions to set

addDamageReduction

@NotNull
BlocksAttacksComponent.DamageReduction addDamageReduction(@NotNull
 DamageType type,
 float base,
 float factor,
 float horizontalBlockingAngle)

Add a new damage reduction to this component, which blocks specific types of attacks.

Parameters:

type - the type of attack

base - the constant amount of damage to be blocked

factor - the proportion of damage to be blocked

horizontalBlockingAngle - the maximum angle at which attacks will be blocked

Returns:

the BlocksAttacksComponent.DamageReduction instance that was added to this item

addDamageReduction

@NotNull
BlocksAttacksComponent.DamageReduction addDamageReduction(@NotNull
 Collection<DamageType> types,
 float base,
 float factor,
 float horizontalBlockingAngle)

Add a new damage reduction to this component, which blocks specific types of attacks.

Parameters:

types - the types of attack

base - the constant amount of damage to be blocked

factor - the proportion of damage to be blocked

horizontalBlockingAngle - the maximum angle at which attacks will be blocked

Returns:

the BlocksAttacksComponent.DamageReduction instance that was added to this item

addDamageReduction

@NotNull
BlocksAttacksComponent.DamageReduction addDamageReduction(@NotNull
 Tag<DamageType> tag,
 float base,
 float factor,
 float horizontalBlockingAngle)

Add a new damage reduction to this component, which blocks specific types of attacks.

Parameters:

tag - the type of attacks

base - the constant amount of damage to be blocked

factor - the proportion of damage to be blocked

horizontalBlockingAngle - the maximum angle at which attacks will be blocked

Returns:

the BlocksAttacksComponent.DamageReduction instance that was added to this item

removeDamageReduction

boolean removeDamageReduction(@NotNull
 BlocksAttacksComponent.DamageReduction reduction)

Remove the given BlocksAttacksComponent.DamageReduction from this item.

Parameters:

reduction - the reduction to remove

Returns:

true if the reduction was removed, false if this component did not contain a matching reduction

getItemDamageThreshold

float getItemDamageThreshold()

Gets the amount of damage required to be dealt before damage is also applied to the item.

Returns:

threshold damage amount

setItemDamageThreshold

void setItemDamageThreshold(float threshold)

Sets the amount of damage required to be dealt before damage is also applied to the item.

Parameters:

threshold - new threshold damage amount

getItemDamageBase

float getItemDamageBase()

Gets the constant amount of damage applied to the item if the threshold is reached.

Returns:

base item damage

setItemDamageBase

void setItemDamageBase(float base)

Sets the constant amount of damage applied to the item if the threshold is reached.

Parameters:

base - new base item damage

getItemDamageFactor

float getItemDamageFactor()

Gets the proportion of damage applied to the item if the threshold is reached.

Returns:

item damage factor

setItemDamageFactor

void setItemDamageFactor(float factor)

Sets the proportion of damage applied to the item if the threshold is reached.

Parameters:

factor - new item damage factor

getBlockSound

@Nullable
Sound getBlockSound()

Gets the sound to play when the item blocks an attack.

Returns:

the sound

setBlockSound

void setBlockSound(@Nullable
 Sound sound)

Sets the sound to play when the item blocks an attack.

Parameters:

sound - sound or null for current default

getDisableSound

@Nullable
Sound getDisableSound()

Gets the sound to play when the item is disabled.

Returns:

the sound

setDisableSound

void setDisableSound(@Nullable
 Sound sound)

Sets the sound to play when the item is disabled.

Parameters:

sound - sound or null for current default

getBypassedBy

@Nullable
Tag<DamageType> getBypassedBy()

Gets the type of damage that will bypass blocking by this item.

Returns:

damage type

setBypassedBy

void setBypassedBy(@Nullable
 Tag<DamageType> tag)

Sets the type of damage that will bypass blocking by this item.

Parameters:

tag - the tag, or null to clear