org.spongepowered.api.event.cause.entity.health

Class HealthModifier.Builder

java.lang.Object

org.spongepowered.api.event.cause.entity.health.HealthModifier.Builder

All Implemented Interfaces:

ResettableBuilder<HealthModifier,HealthModifier.Builder>

Enclosing interface:

HealthModifier

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

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

Method Summary

Modifier and Type	Method and Description
HealthModifier	build() Creates a new HealthModifier with this builder's provided Cause and HealthModifierType.
static HealthModifier.Builder	builder() Creates a new HealthModifier.Builder.
HealthModifier.Builder	cause(Cause cause) Sets the Cause for the HealthModifier to build.
HealthModifier.Builder	from(HealthModifier value) Resets this builder to the values of the given built object.
HealthModifier.Builder	reset() Resets this builder to a "default" state such that there is no remaining data to set.
HealthModifier.Builder	type(HealthModifierType healthModifierType) Sets the HealthModifierType for the HealthModifier to build.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static HealthModifier.Builder builder()

Creates a new HealthModifier.Builder.

Returns:

The new builder instance

type

public HealthModifier.Builder type(HealthModifierType healthModifierType)

Sets the HealthModifierType for the HealthModifier to build.

Parameters:

healthModifierType - The health modifier type

Returns:

This builder, for chaining

cause

public HealthModifier.Builder cause(Cause cause)

Sets the Cause for the HealthModifier to build.

Parameters:

cause - The cause for the health modifier

Returns:

This builder, for chaining

build

public HealthModifier build()

Creates a new HealthModifier with this builder's provided Cause and HealthModifierType.

Returns:

The newly created health modifier

from

public HealthModifier.Builder from(HealthModifier value)

Description copied from interface: ResettableBuilder

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

Specified by:

from in interface ResettableBuilder<HealthModifier,HealthModifier.Builder>

Parameters:

value - The built object

Returns:

This builder, for chaining

reset

public HealthModifier.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<HealthModifier,HealthModifier.Builder>

Returns:

This builder, for chaining