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	blendInDurationTicks
private int	blendOutAdvanceTicks
private int	blendOutDurationTicks
private final MobEffectCategory	category
static final com.mojang.serialization.Codec<Holder<MobEffect>>	CODEC
private final int	color
private @Nullable 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 FeatureElement

FILTERED_REGISTRIES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MobEffect(MobEffectCategory category, int color)
protected	MobEffect(MobEffectCategory category, int color, Function<MobEffectInstance, ParticleOptions> particleFactory)	Neo: Constructor that can take in the particle factory as a function of the MobEffectInstance.
protected	MobEffect(MobEffectCategory category, int color, ParticleOptions particleOptions)

Method Summary

Modifier and Type	Method	Description
MobEffect	addAttributeModifier(Holder<Attribute> attribute, Identifier id, double amount, AttributeModifier.Operation operation)
MobEffect	addAttributeModifier(Holder<Attribute> attribute, Identifier 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 attributes, int amplifier)
boolean	applyEffectTick(ServerLevel serverLevel, LivingEntity mob, int amplification)
void	applyInstantenousEffect(ServerLevel level, @Nullable Entity source, @Nullable Entity owner, LivingEntity mob, int amplification, double scale)
void	createModifiers(int amplifier, BiConsumer<Holder<Attribute>, AttributeModifier> consumer)
ParticleOptions	createParticleOptions(MobEffectInstance mobEffectInstance)
int	getBlendInDurationTicks()
int	getBlendOutAdvanceTicks()
int	getBlendOutDurationTicks()
MobEffectCategory	getCategory()
int	getColor()
String	getDescriptionId()
Component	getDisplayName()
protected String	getOrCreateDescriptionId()
boolean	isBeneficial()
boolean	isInstantenous()
void	onEffectAdded(LivingEntity mob, int amplifier)
void	onEffectStarted(LivingEntity mob, int amplifier)
void	onMobHurt(ServerLevel level, LivingEntity mob, int amplifier, DamageSource source, float damage)
void	onMobRemoved(ServerLevel level, LivingEntity mob, int amplifier, Entity.RemovalReason reason)
void	removeAttributeModifiers(AttributeMap attributes)
FeatureFlagSet	requiredFeatures()
MobEffect	requiredFeatures(FeatureFlag... flags)
MobEffect	setBlendDuration(int ticks)
MobEffect	setBlendDuration(int inTicks, int outTicks, int outAdvanceTicks)
boolean	shouldApplyEffectTickThisTick(int tickCount, int amplification)
MobEffect	withSoundOnAdded(SoundEvent soundEvent)

Methods inherited from class Object

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

Methods inherited from interface FeatureElement

isEnabled

Methods inherited from interface IMobEffectExtension

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

private @Nullable String descriptionId

blendInDurationTicks

private int blendInDurationTicks

blendOutDurationTicks

private int blendOutDurationTicks

blendOutAdvanceTicks

private int blendOutAdvanceTicks

soundOnAdded

private Optional<SoundEvent> soundOnAdded

requiredFeatures

private FeatureFlagSet requiredFeatures

Constructor Details

MobEffect

protected MobEffect(MobEffectCategory category,
 int color)

MobEffect

protected MobEffect(MobEffectCategory category,
 int color,
 ParticleOptions particleOptions)

MobEffect

protected MobEffect(MobEffectCategory category,
 int color,
 Function<MobEffectInstance, ParticleOptions> particleFactory)

Neo: Constructor that can take in the particle factory as a function of the MobEffectInstance. This should be used if the desired ParticleOptions depends on the presence of other registry entries.

Method Details

getBlendInDurationTicks

public int getBlendInDurationTicks()

getBlendOutDurationTicks

public int getBlendOutDurationTicks()

getBlendOutAdvanceTicks

public int getBlendOutAdvanceTicks()

applyEffectTick

public boolean applyEffectTick(ServerLevel serverLevel,
 LivingEntity mob,
 int amplification)

applyInstantenousEffect

public void applyInstantenousEffect(ServerLevel level,
 @Nullable Entity source,
 @Nullable Entity owner,
 LivingEntity mob,
 int amplification,
 double scale)

shouldApplyEffectTickThisTick

public boolean shouldApplyEffectTickThisTick(int tickCount,
 int amplification)

onEffectStarted

public void onEffectStarted(LivingEntity mob,
 int amplifier)

onEffectAdded

public void onEffectAdded(LivingEntity mob,
 int amplifier)

onMobRemoved

public void onMobRemoved(ServerLevel level,
 LivingEntity mob,
 int amplifier,
 Entity.RemovalReason reason)

onMobHurt

public void onMobHurt(ServerLevel level,
 LivingEntity mob,
 int amplifier,
 DamageSource source,
 float damage)

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> attribute,
 Identifier id,
 double amount,
 AttributeModifier.Operation operation)

addAttributeModifier

public MobEffect addAttributeModifier(Holder<Attribute> attribute,
 Identifier 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 ticks)

setBlendDuration

public MobEffect setBlendDuration(int inTicks,
 int outTicks,
 int outAdvanceTicks)

createModifiers

public void createModifiers(int amplifier,
 BiConsumer<Holder<Attribute>, AttributeModifier> consumer)

removeAttributeModifiers

public void removeAttributeModifiers(AttributeMap attributes)

addAttributeModifiers

public void addAttributeModifiers(AttributeMap attributes,
 int amplifier)

isBeneficial

public boolean isBeneficial()

createParticleOptions

public ParticleOptions createParticleOptions(MobEffectInstance mobEffectInstance)

withSoundOnAdded

public MobEffect withSoundOnAdded(SoundEvent soundEvent)

requiredFeatures

public MobEffect requiredFeatures(FeatureFlag... flags)

requiredFeatures

public FeatureFlagSet requiredFeatures()

Specified by:

requiredFeatures in interface FeatureElement