Package net.minecraft.world.effect

Class MobEffect

java.lang.Object

net.minecraft.world.effect.MobEffect

All Implemented Interfaces:

FeatureElement, IMobEffectExtension

Direct Known Subclasses:

AbsorptionMobEffect, BadOmenMobEffect, HungerMobEffect, InfestedMobEffect, InstantenousMobEffect, OozingMobEffect, PoisonMobEffect, RaidOmenMobEffect, RegenerationMobEffect, WeavingMobEffect, WindChargedMobEffect, WitherMobEffect

public class MobEffect
extends Object
implements FeatureElement, IMobEffectExtension

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MobEffect.AttributeTemplate

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	AMBIENT_ALPHA
private final Map<Holder<Attribute>,MobEffect.AttributeTemplate>	attributeModifiers	Contains a Map of the AttributeModifiers registered by potions
private int	blendDurationTicks
private final MobEffectCategory	category
static final com.mojang.serialization.Codec<Holder<MobEffect>>	CODEC
private final int	color
private String	descriptionId
private final Function<MobEffectInstance,ParticleOptions>	particleFactory
private FeatureFlagSet	requiredFeatures
private Optional<SoundEvent>	soundOnAdded
static final StreamCodec<RegistryFriendlyByteBuf,Holder<MobEffect>>	STREAM_CODEC

Fields inherited from interface net.minecraft.world.flag.FeatureElement

FILTERED_REGISTRIES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MobEffect(MobEffectCategory pCategory, int pColor)
protected	MobEffect(MobEffectCategory pCategory, int pColor, ParticleOptions pParticle)

Method Summary

Modifier and Type	Method	Description
MobEffect	addAttributeModifier(Holder<Attribute> pAttribute, ResourceLocation pId, double pAmount, AttributeModifier.Operation pOperation)
MobEffect	addAttributeModifier(Holder<Attribute> attribute, ResourceLocation id, AttributeModifier.Operation operation, it.unimi.dsi.fastutil.ints.Int2DoubleFunction curve)	Neo: attribute template with custom level curve, for mob effects providing non-linear attribute modifiers.
void	addAttributeModifiers(AttributeMap pAttributeMap, int pAmplifier)
boolean	applyEffectTick(LivingEntity pLivingEntity, int pAmplifier)
void	applyInstantenousEffect(Entity pSource, Entity pIndirectSource, LivingEntity pLivingEntity, int pAmplifier, double pHealth)
void	createModifiers(int pAmplifier, BiConsumer<Holder<Attribute>,AttributeModifier> pOutput)
ParticleOptions	createParticleOptions(MobEffectInstance pEffect)
int	getBlendDurationTicks()
MobEffectCategory	getCategory()
int	getColor()
String	getDescriptionId()
Component	getDisplayName()
protected String	getOrCreateDescriptionId()
void	initializeClient(Consumer<IClientMobEffectExtensions> consumer)	Deprecated, for removal: This API element is subject to removal in a future version. Use RegisterClientExtensionsEvent instead
boolean	isBeneficial()
boolean	isInstantenous()
void	onEffectAdded(LivingEntity pLivingEntity, int pAmplifier)
void	onEffectStarted(LivingEntity pLivingEntity, int pAmplifier)
void	onMobHurt(LivingEntity pLivingEntity, int pAmplifier, DamageSource pDamageSource, float pAmount)
void	onMobRemoved(LivingEntity pLivingEntity, int pAmplifier, Entity.RemovalReason pReason)
void	removeAttributeModifiers(AttributeMap pAttributeMap)
FeatureFlagSet	requiredFeatures()
MobEffect	requiredFeatures(FeatureFlag... pRequiredFeatures)
MobEffect	setBlendDuration(int pBlendDuration)
boolean	shouldApplyEffectTickThisTick(int pDuration, int pAmplifier)
MobEffect	withSoundOnAdded(SoundEvent pSound)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.world.flag.FeatureElement

isEnabled

Methods inherited from interface net.neoforged.neoforge.common.extensions.IMobEffectExtension

fillEffectCures, getSortOrder

Field Details

CODEC

public static final com.mojang.serialization.Codec<Holder<MobEffect>> CODEC

STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf,Holder<MobEffect>> STREAM_CODEC

AMBIENT_ALPHA

private static final int AMBIENT_ALPHA

attributeModifiers

private final Map<Holder<Attribute>,MobEffect.AttributeTemplate> attributeModifiers

Contains a Map of the AttributeModifiers registered by potions

category

private final MobEffectCategory category

color

private final int color

particleFactory

private final Function<MobEffectInstance,ParticleOptions> particleFactory

descriptionId

@Nullable
private String descriptionId

blendDurationTicks

private int blendDurationTicks

soundOnAdded

private Optional<SoundEvent> soundOnAdded

requiredFeatures

private FeatureFlagSet requiredFeatures

Constructor Details

MobEffect

protected MobEffect(MobEffectCategory pCategory,
 int pColor)

MobEffect

protected MobEffect(MobEffectCategory pCategory,
 int pColor,
 ParticleOptions pParticle)

Method Details

getBlendDurationTicks

public int getBlendDurationTicks()

applyEffectTick

public boolean applyEffectTick(LivingEntity pLivingEntity,
 int pAmplifier)

applyInstantenousEffect

public void applyInstantenousEffect(@Nullable
 Entity pSource,
 @Nullable
 Entity pIndirectSource,
 LivingEntity pLivingEntity,
 int pAmplifier,
 double pHealth)

shouldApplyEffectTickThisTick

public boolean shouldApplyEffectTickThisTick(int pDuration,
 int pAmplifier)

onEffectStarted

public void onEffectStarted(LivingEntity pLivingEntity,
 int pAmplifier)

onEffectAdded

public void onEffectAdded(LivingEntity pLivingEntity,
 int pAmplifier)

onMobRemoved

public void onMobRemoved(LivingEntity pLivingEntity,
 int pAmplifier,
 Entity.RemovalReason pReason)

onMobHurt

public void onMobHurt(LivingEntity pLivingEntity,
 int pAmplifier,
 DamageSource pDamageSource,
 float pAmount)

isInstantenous

public boolean isInstantenous()

getOrCreateDescriptionId

protected String getOrCreateDescriptionId()

getDescriptionId

public String getDescriptionId()

getDisplayName

public Component getDisplayName()

getCategory

public MobEffectCategory getCategory()

getColor

public int getColor()

addAttributeModifier

public MobEffect addAttributeModifier(Holder<Attribute> pAttribute,
 ResourceLocation pId,
 double pAmount,
 AttributeModifier.Operation pOperation)

addAttributeModifier

public MobEffect addAttributeModifier(Holder<Attribute> attribute,
 ResourceLocation id,
 AttributeModifier.Operation operation,
 it.unimi.dsi.fastutil.ints.Int2DoubleFunction curve)

Neo: attribute template with custom level curve, for mob effects providing non-linear attribute modifiers.

Parameters:

attribute - The attribute of the modifier

id - ID of the modifier

operation - Operation of the modifier

curve - A function mapping effect instance amplifier to modifier amount

setBlendDuration

public MobEffect setBlendDuration(int pBlendDuration)

createModifiers

public void createModifiers(int pAmplifier,
 BiConsumer<Holder<Attribute>,AttributeModifier> pOutput)

removeAttributeModifiers

public void removeAttributeModifiers(AttributeMap pAttributeMap)

addAttributeModifiers

public void addAttributeModifiers(AttributeMap pAttributeMap,
 int pAmplifier)

isBeneficial

public boolean isBeneficial()

createParticleOptions

public ParticleOptions createParticleOptions(MobEffectInstance pEffect)

withSoundOnAdded

public MobEffect withSoundOnAdded(SoundEvent pSound)

requiredFeatures

public MobEffect requiredFeatures(FeatureFlag... pRequiredFeatures)

requiredFeatures

public FeatureFlagSet requiredFeatures()

Specified by:

requiredFeatures in interface FeatureElement

initializeClient

@Deprecated(forRemoval=true,
            since="1.21")
public void initializeClient(Consumer<IClientMobEffectExtensions> consumer)

Deprecated, for removal: This API element is subject to removal in a future version.

Use RegisterClientExtensionsEvent instead

Neo: Allowing mods to define client behavior for their MobEffects