org.spongepowered.api.effect.potion

Interface PotionEffect

All Superinterfaces:

DataSerializable, PropertyHolder

public interface PotionEffect
extends DataSerializable, PropertyHolder

Represents an effect of a PotionEffectType for a specified getDuration(), getAmplifier(), and getShowParticles(). The PotionEffect itself is immutable once created and can be offered to Entity instances through the PotionEffectData.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PotionEffect.Builder Represents a builder interface to create a PotionEffect.

Method Summary

Modifier and Type	Method and Description
static PotionEffect.Builder	builder() Creates a new PotionEffect.Builder to build a PotionEffect.
int	getAmplifier() Gets the amplifier at which this potion effect will apply effects.
int	getDuration() Gets the duration in ticks for which this potion effect will apply for.
boolean	getShowParticles() Gets whether or not this potion effect should show particles.
PotionEffectType	getType() Gets the PotionEffectType of this potion.
boolean	isAmbient() Gets if the potion effect is an ambient effect.
static PotionEffect	of(PotionEffectType type, int amplifier, int duration) Creates a new PotionEffect with the provided PotionEffectType, the provided amplifier, and the provided duration in ticks.

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Method Detail

builder

static PotionEffect.Builder builder()

Creates a new PotionEffect.Builder to build a PotionEffect.

Returns:

The new builder

of

static PotionEffect of(PotionEffectType type,
                       int amplifier,
                       int duration)

Creates a new PotionEffect with the provided PotionEffectType, the provided amplifier, and the provided duration in ticks.

Parameters:

type - The potion type

amplifier - The amplifier

duration - The duration in ticks

Returns:

The potion effect

getType

PotionEffectType getType()

Gets the PotionEffectType of this potion.

Returns:

The type.

getDuration

int getDuration()

Gets the duration in ticks for which this potion effect will apply for.

Returns:

The duration.

getAmplifier

int getAmplifier()

Gets the amplifier at which this potion effect will apply effects.

Returns:

The amplifier.

isAmbient

boolean isAmbient()

Gets if the potion effect is an ambient effect.

Returns:

Gets if ambient.

getShowParticles

boolean getShowParticles()

Gets whether or not this potion effect should show particles.

Returns:

If particles should be shown.