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 category, int color)

protected

MobEffect(MobEffectCategory category, int color, ParticleOptions particle)
Method Summary

Modifier and Type

Method

Description

MobEffect

addAttributeModifier(Holder<Attribute> attribute, ResourceLocation id, double amount, AttributeModifier.Operation operation)

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 attributeMap, int amplifier)

boolean

applyEffectTick(LivingEntity livingEntity, int amplifier)

void

applyInstantenousEffect(Entity source, Entity indirectSource, LivingEntity livingEntity, int amplifier, double health)

void

createModifiers(int amplifier, BiConsumer<Holder<Attribute>,AttributeModifier> output)

ParticleOptions

createParticleOptions(MobEffectInstance effect)

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 livingEntity, int amplifier)

void

onEffectStarted(LivingEntity livingEntity, int amplifier)

void

onMobHurt(LivingEntity livingEntity, int amplifier, DamageSource damageSource, float amount)

void

onMobRemoved(LivingEntity livingEntity, int amplifier, Entity.RemovalReason reason)

void

removeAttributeModifiers(AttributeMap attributeMap)

FeatureFlagSet

requiredFeatures()

MobEffect

requiredFeatures(FeatureFlag... requiredFeatures)

MobEffect

setBlendDuration(int blendDuration)

boolean

shouldApplyEffectTickThisTick(int duration, int amplifier)

MobEffect

withSoundOnAdded(SoundEvent sound)

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 category, int color)
- MobEffect
  
  protected MobEffect(MobEffectCategory category, int color, ParticleOptions particle)
Method Details
- getBlendDurationTicks
  
  public int getBlendDurationTicks()
- applyEffectTick
  
  public boolean applyEffectTick(LivingEntity livingEntity, int amplifier)
- applyInstantenousEffect
  
  public void applyInstantenousEffect(@Nullable Entity source, @Nullable Entity indirectSource, LivingEntity livingEntity, int amplifier, double health)
- shouldApplyEffectTickThisTick
  
  public boolean shouldApplyEffectTickThisTick(int duration, int amplifier)
- onEffectStarted
  
  public void onEffectStarted(LivingEntity livingEntity, int amplifier)
- onEffectAdded
  
  public void onEffectAdded(LivingEntity livingEntity, int amplifier)
- onMobRemoved
  
  public void onMobRemoved(LivingEntity livingEntity, int amplifier, Entity.RemovalReason reason)
- onMobHurt
  
  public void onMobHurt(LivingEntity livingEntity, int amplifier, DamageSource damageSource, float amount)
- 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, ResourceLocation id, double amount, AttributeModifier.Operation operation)
- 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 blendDuration)
- createModifiers
  
  public void createModifiers(int amplifier, BiConsumer<Holder<Attribute>,AttributeModifier> output)
- removeAttributeModifiers
  
  public void removeAttributeModifiers(AttributeMap attributeMap)
- addAttributeModifiers
  
  public void addAttributeModifiers(AttributeMap attributeMap, int amplifier)
- isBeneficial
  
  public boolean isBeneficial()
- createParticleOptions
  
  public ParticleOptions createParticleOptions(MobEffectInstance effect)
- withSoundOnAdded
  
  public MobEffect withSoundOnAdded(SoundEvent sound)
- requiredFeatures
  
  public MobEffect requiredFeatures(FeatureFlag... requiredFeatures)
- 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

Class MobEffect

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Field Details

CODEC

STREAM_CODEC

AMBIENT_ALPHA

attributeModifiers

category

color

particleFactory

descriptionId

blendDurationTicks

soundOnAdded

requiredFeatures

Constructor Details

MobEffect

MobEffect

Method Details

getBlendDurationTicks

applyEffectTick

applyInstantenousEffect

shouldApplyEffectTickThisTick

onEffectStarted

onEffectAdded

onMobRemoved

onMobHurt

isInstantenous

getOrCreateDescriptionId

getDescriptionId

getDisplayName

getCategory

getColor

addAttributeModifier

addAttributeModifier

setBlendDuration

createModifiers

removeAttributeModifiers

addAttributeModifiers

isBeneficial

createParticleOptions

withSoundOnAdded

requiredFeatures

requiredFeatures

initializeClient