Package org.spongepowered.api.event.cause.entity.damage

Class DamageModifier.Builder

java.lang.Object

org.spongepowered.api.event.cause.entity.damage.DamageModifier.Builder

All Implemented Interfaces:

AbstractBuilder<DamageModifier>, Builder<DamageModifier,DamageModifier.Builder>, CopyableBuilder<DamageModifier,DamageModifier.Builder>, ResettableBuilder<DamageModifier,DamageModifier.Builder>

Enclosing interface:

DamageModifier

public static final class DamageModifier.Builder
extends Object
implements Builder<DamageModifier,DamageModifier.Builder>, CopyableBuilder<DamageModifier,DamageModifier.Builder>

A builder that creates DamageModifiers, for use in both plugin and implementation requirements.

Method Summary

Modifier and Type	Method	Description
DamageModifier.Builder	attackDamageGroup()	The main attack damage calculated for an AttackEntityEvent
DamageModifier.Builder	attackEnchantmentGroup()	The enchantment attack damage calculated for an AttackEntityEvent
DamageModifier	build()	Creates a new DamageModifier with this builder's provided Cause and DamageModifierType.
DamageModifier.Builder	cause(Cause cause)	Sets the Cause for the DamageModifier to build.
DamageModifier.Builder	damageReductionGroup()	The damage calculated for an DamageEntityEvent
DamageModifier.Builder	from(DamageModifier value)	Resets this builder to the values of the given built object.
DamageModifier.Builder	group(String group)
DamageModifier.Builder	item(ItemStackLike item)
DamageModifier.Builder	reset()	Resets this builder to a "default" state such that there is no remaining data to set.
DamageModifier.Builder	type(Supplier<? extends DamageModifierType> damageModifierType)	Sets the DamageModifierType for the DamageModifier to build.
DamageModifier.Builder	type(DamageModifierType damageModifierType)	Sets the DamageModifierType for the DamageModifier to build.

Methods inherited from class java.lang.Object

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

Method Details

type

public DamageModifier.Builder type(Supplier<? extends DamageModifierType> damageModifierType)

Sets the DamageModifierType for the DamageModifier to build.

Parameters:

damageModifierType - The damage modifier type

Returns:

This builder, for chaining

type

public DamageModifier.Builder type(DamageModifierType damageModifierType)

Sets the DamageModifierType for the DamageModifier to build.

Parameters:

damageModifierType - The damage modifier type

Returns:

This builder, for chaining

attackDamageGroup

public DamageModifier.Builder attackDamageGroup()

The main attack damage calculated for an AttackEntityEvent

Returns:

This builder, for chaining

attackEnchantmentGroup

public DamageModifier.Builder attackEnchantmentGroup()

The enchantment attack damage calculated for an AttackEntityEvent

Returns:

This builder, for chaining

damageReductionGroup

public DamageModifier.Builder damageReductionGroup()

The damage calculated for an DamageEntityEvent

Returns:

This builder, for chaining

group

public DamageModifier.Builder group(String group)

item

public DamageModifier.Builder item(ItemStackLike item)

cause

public DamageModifier.Builder cause(Cause cause)

Sets the Cause for the DamageModifier to build.

Parameters:

cause - The cause for the damage modifier

Returns:

This builder, for chaining

build

public DamageModifier build()

Creates a new DamageModifier with this builder's provided Cause and DamageModifierType.

Specified by:

build in interface AbstractBuilder<DamageModifier>

Returns:

The newly created damage modifier

from

public DamageModifier.Builder from(DamageModifier value)

Description copied from interface: CopyableBuilder

Resets this builder to the values of the given built object.

Specified by:

from in interface CopyableBuilder<DamageModifier,DamageModifier.Builder>

Parameters:

value - The built object

Returns:

This builder, for chaining

reset

public DamageModifier.Builder reset()

Description copied from interface: Builder

Resets this builder to a "default" state such that there is no remaining data to set. This is to be the presumed "default" state.

Specified by:

reset in interface Builder<DamageModifier,DamageModifier.Builder>

Specified by:

reset in interface ResettableBuilder<DamageModifier,DamageModifier.Builder>

Returns:

This builder, for chaining