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:

ResettableBuilder<DamageModifier,DamageModifier.Builder>

Enclosing interface:

DamageModifier

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

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

Method Summary

Modifier and Type	Method and Description
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	from(DamageModifier value) Resets this builder to the values of the given built object.
DamageModifier.Builder	item(ItemStack itemStack)
DamageModifier.Builder	item(ItemStackSnapshot snapshot)
DamageModifier.Builder	reset() Resets this builder to a "default" state such that there is no remaining data to set.
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 Detail

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

item

public DamageModifier.Builder item(ItemStack itemStack)

item

public DamageModifier.Builder item(ItemStackSnapshot snapshot)

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.

Returns:

The newly created damage modifier

from

public DamageModifier.Builder from(DamageModifier value)

Description copied from interface: ResettableBuilder

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

Specified by:

from in interface ResettableBuilder<DamageModifier,DamageModifier.Builder>

Parameters:

value - The built object

Returns:

This builder, for chaining

reset

public DamageModifier.Builder reset()

Description copied from interface: ResettableBuilder

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 ResettableBuilder<DamageModifier,DamageModifier.Builder>

Returns:

This builder, for chaining