Record Class EntityEffect.ApplyPotionEffect

java.lang.Object

java.lang.Record

net.minestom.server.item.enchant.EntityEffect.ApplyPotionEffect

All Implemented Interfaces:

Enchantment.Effect, EntityEffect, LocationEffect

Enclosing interface:

EntityEffect

public static record EntityEffect.ApplyPotionEffect(@NotNull RegistryTag<PotionEffect> toApply, @NotNull LevelBasedValue minDuration, @NotNull LevelBasedValue maxDuration, @NotNull LevelBasedValue minAmplifier, @NotNull LevelBasedValue maxAmplifier)
extends Record
implements EntityEffect, LocationEffect

Nested Class Summary

Nested classes/interfaces inherited from interface net.minestom.server.item.enchant.EntityEffect

EntityEffect.AllOf, EntityEffect.ApplyPotionEffect, EntityEffect.ChangeItemDamage, EntityEffect.DamageEntity, EntityEffect.Explode, EntityEffect.Ignite, EntityEffect.PlaySound, EntityEffect.ReplaceBlock, EntityEffect.ReplaceDisc, EntityEffect.RunFunction, EntityEffect.SetBlockProperties, EntityEffect.SpawnParticles, EntityEffect.SummonEntity

Nested classes/interfaces inherited from interface net.minestom.server.item.enchant.LocationEffect

LocationEffect.AllOf

Field Summary

Fields

Modifier and Type	Field	Description
static final StructCodec<EntityEffect.ApplyPotionEffect>	CODEC

Constructor Summary

Constructors

Constructor	Description
ApplyPotionEffect(@NotNull RegistryTag<PotionEffect> toApply, @NotNull LevelBasedValue minDuration, @NotNull LevelBasedValue maxDuration, @NotNull LevelBasedValue minAmplifier, @NotNull LevelBasedValue maxAmplifier)	Creates an instance of a ApplyPotionEffect record class.

Method Summary

Modifier and Type	Method	Description
@NotNull StructCodec<EntityEffect.ApplyPotionEffect>	codec()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@NotNull LevelBasedValue	maxAmplifier()	Returns the value of the maxAmplifier record component.
@NotNull LevelBasedValue	maxDuration()	Returns the value of the maxDuration record component.
@NotNull LevelBasedValue	minAmplifier()	Returns the value of the minAmplifier record component.
@NotNull LevelBasedValue	minDuration()	Returns the value of the minDuration record component.
@NotNull RegistryTag<PotionEffect>	toApply()	Returns the value of the toApply record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

CODEC

public static final StructCodec<EntityEffect.ApplyPotionEffect> CODEC

Constructor Details

ApplyPotionEffect

public ApplyPotionEffect(@NotNull
 @NotNull RegistryTag<PotionEffect> toApply,
 @NotNull
 @NotNull LevelBasedValue minDuration,
 @NotNull
 @NotNull LevelBasedValue maxDuration,
 @NotNull
 @NotNull LevelBasedValue minAmplifier,
 @NotNull
 @NotNull LevelBasedValue maxAmplifier)

Creates an instance of a ApplyPotionEffect record class.

Parameters:

toApply - the value for the toApply record component

minDuration - the value for the minDuration record component

maxDuration - the value for the maxDuration record component

minAmplifier - the value for the minAmplifier record component

maxAmplifier - the value for the maxAmplifier record component

Method Details

codec

@NotNull
public @NotNull StructCodec<EntityEffect.ApplyPotionEffect> codec()

Specified by:

codec in interface EntityEffect

Specified by:

codec in interface LocationEffect

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

toApply

@NotNull
public @NotNull RegistryTag<PotionEffect> toApply()

Returns the value of the toApply record component.

Returns:

the value of the toApply record component

minDuration

@NotNull
public @NotNull LevelBasedValue minDuration()

Returns the value of the minDuration record component.

Returns:

the value of the minDuration record component

maxDuration

@NotNull
public @NotNull LevelBasedValue maxDuration()

Returns the value of the maxDuration record component.

Returns:

the value of the maxDuration record component

minAmplifier

@NotNull
public @NotNull LevelBasedValue minAmplifier()

Returns the value of the minAmplifier record component.

Returns:

the value of the minAmplifier record component

maxAmplifier

@NotNull
public @NotNull LevelBasedValue maxAmplifier()

Returns the value of the maxAmplifier record component.

Returns:

the value of the maxAmplifier record component