org.spongepowered.api.effect.potion

Interface PotionEffect.Builder

All Superinterfaces:

DataBuilder<PotionEffect>, ResettableBuilder<PotionEffect,DataBuilder<PotionEffect>>

Enclosing interface:

PotionEffect

public static interface PotionEffect.Builder
extends DataBuilder<PotionEffect>

Represents a builder interface to create a PotionEffect.

Method Summary

Modifier and Type	Method and Description
PotionEffect.Builder	ambience(boolean ambience) Sets the potion effect to be ambient or not.
PotionEffect.Builder	amplifier(int amplifier) Sets the amplifier power of the potion effect.
PotionEffect	build() Builds an instance of a PotionEffect.
PotionEffect.Builder	duration(int duration) Sets the duration in ticks of the potion effect.
PotionEffect.Builder	from(PotionEffect potionEffect) Resets this builder to the values of the given built object.
PotionEffect.Builder	particles(boolean showsParticles) Sets the potion effect to show particles when applied or not.
PotionEffect.Builder	potionType(PotionEffectType potionEffectType) Sets the PotionEffectType of the potion.
PotionEffect.Builder	reset() Resets this builder to a "default" state such that there is no remaining data to set.

Methods inherited from interface org.spongepowered.api.data.persistence.DataBuilder

build

Method Detail

from

PotionEffect.Builder from(PotionEffect potionEffect)

Description copied from interface: ResettableBuilder

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

Specified by:

from in interface DataBuilder<PotionEffect>

Specified by:

from in interface ResettableBuilder<PotionEffect,DataBuilder<PotionEffect>>

Parameters:

potionEffect - The built object

Returns:

This builder, for chaining

potionType

PotionEffect.Builder potionType(PotionEffectType potionEffectType)

Sets the PotionEffectType of the potion.

Parameters:

potionEffectType - The type of item

Returns:

This builder, for chaining

duration

PotionEffect.Builder duration(int duration)

Sets the duration in ticks of the potion effect.

Parameters:

duration - The duration in ticks of this effect

Returns:

This builder, for chaining

amplifier

PotionEffect.Builder amplifier(int amplifier)
                        throws IllegalArgumentException

Sets the amplifier power of the potion effect.

Amplifiers must be above zero.

Parameters:

amplifier - The amplifier power

Returns:

This builder, for chaining

Throws:

IllegalArgumentException - If the amplifier is less than zero

ambience

PotionEffect.Builder ambience(boolean ambience)

Sets the potion effect to be ambient or not.

Parameters:

ambience - Whether the potion effect is ambient

Returns:

This builder, for chaining

particles

PotionEffect.Builder particles(boolean showsParticles)

Sets the potion effect to show particles when applied or not.

Parameters:

showsParticles - Whether the potion effect will show particles

Returns:

This builder, for chaining

build

PotionEffect build()
            throws IllegalStateException

Builds an instance of a PotionEffect.

Returns:

A new instance of a PotionEffect

Throws:

IllegalStateException - If the potion effect is not completed

reset

PotionEffect.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 DataBuilder<PotionEffect>

Specified by:

reset in interface ResettableBuilder<PotionEffect,DataBuilder<PotionEffect>>

Returns:

This builder, for chaining