org.bukkit.potion

クラス PotionEffect

java.lang.Object

org.bukkit.potion.PotionEffect

すべての実装されたインタフェース:

ConfigurationSerializable

public class PotionEffect
extends Object
implements ConfigurationSerializable

Represents a potion effect, that can be added to a LivingEntity. A potion effect has a duration that it will last for, an amplifier that will enhance its effects, and a PotionEffectType, that represents its effect on an entity.

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PotionEffect(Map<String,Object> map) Constructor for deserialization.
PotionEffect(PotionEffectType type, int duration, int amplifier) Creates a potion effect.
PotionEffect(PotionEffectType type, int duration, int amplifier, boolean ambient) Creates a potion effect.
PotionEffect(PotionEffectType type, int duration, int amplifier, boolean ambient, boolean particles) Creates a potion effect with no defined color.
PotionEffect(PotionEffectType type, int duration, int amplifier, boolean ambient, boolean particles, Color color) Creates a potion effect.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	apply(LivingEntity entity) Attempts to add the effect represented by this object to the given LivingEntity.
boolean	equals(Object obj)
int	getAmplifier() Returns the amplifier of this effect.
Color	getColor()
int	getDuration() Returns the duration (in ticks) that this effect will run for when applied to a LivingEntity.
PotionEffectType	getType() Returns the PotionEffectType of this effect.
int	hashCode()
boolean	hasParticles()
boolean	isAmbient() Makes potion effect produce more, translucent, particles.
Map<String,Object>	serialize() Creates a Map representation of this class.
String	toString()

クラスから継承されたメソッド java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

PotionEffect

public PotionEffect(PotionEffectType type,
                    int duration,
                    int amplifier,
                    boolean ambient,
                    boolean particles,
                    Color color)

Creates a potion effect.

パラメータ:

type - effect type

duration - measured in ticks, see getDuration()

amplifier - the amplifier, see getAmplifier()

ambient - the ambient status, see isAmbient()

particles - the particle status, see hasParticles()

color - the particle color, see getColor()

PotionEffect

public PotionEffect(PotionEffectType type,
                    int duration,
                    int amplifier,
                    boolean ambient,
                    boolean particles)

Creates a potion effect with no defined color.

パラメータ:

type - effect type

duration - measured in ticks, see getDuration()

amplifier - the amplifier, see getAmplifier()

ambient - the ambient status, see isAmbient()

particles - the particle status, see hasParticles()

PotionEffect

public PotionEffect(PotionEffectType type,
                    int duration,
                    int amplifier,
                    boolean ambient)

Creates a potion effect. Assumes that particles are visible

パラメータ:

type - effect type

duration - measured in ticks, see getDuration()

amplifier - the amplifier, see getAmplifier()

ambient - the ambient status, see isAmbient()

PotionEffect

public PotionEffect(PotionEffectType type,
                    int duration,
                    int amplifier)

Creates a potion effect. Assumes ambient is true.

パラメータ:

type - Effect type

duration - measured in ticks

amplifier - the amplifier for the effect

関連項目:

PotionEffect(PotionEffectType, int, int, boolean)

PotionEffect

public PotionEffect(Map<String,Object> map)

Constructor for deserialization.

パラメータ:

map - the map to deserialize from

メソッドの詳細

serialize

public Map<String,Object> serialize()

インタフェースからコピーされた説明: ConfigurationSerializable

Creates a Map representation of this class.

This class must provide a method to restore this class, as defined in the ConfigurationSerializable interface javadocs.

定義:

serialize インタフェース内 ConfigurationSerializable

戻り値:

Map containing the current state of this class

apply

public boolean apply(LivingEntity entity)

Attempts to add the effect represented by this object to the given LivingEntity.

パラメータ:

entity - The entity to add this effect to

戻り値:

Whether the effect could be added

関連項目:

LivingEntity.addPotionEffect(PotionEffect)

equals

public boolean equals(Object obj)

オーバーライド:

equals クラス内 Object

getAmplifier

public int getAmplifier()

Returns the amplifier of this effect. A higher amplifier means the potion effect happens more often over its duration and in some cases has more effect on its target.

戻り値:

The effect amplifier

getDuration

public int getDuration()

Returns the duration (in ticks) that this effect will run for when applied to a LivingEntity.

戻り値:

The duration of the effect

getType

public PotionEffectType getType()

Returns the PotionEffectType of this effect.

戻り値:

The potion type of this effect

isAmbient

public boolean isAmbient()

Makes potion effect produce more, translucent, particles.

戻り値:

if this effect is ambient

hasParticles

public boolean hasParticles()

戻り値:

whether this effect has particles or not

getColor

public Color getColor()

戻り値:

color of this potion's particles. May be null if the potion has no particles or defined color.

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 Object

toString

public String toString()

オーバーライド:

toString クラス内 Object