Package net.minecraft.world.damagesource

Enum Class DamageScaling

java.lang.Object

java.lang.Enum<DamageScaling>

net.minecraft.world.damagesource.DamageScaling

All Implemented Interfaces:

Serializable, Comparable<DamageScaling>, Constable, StringRepresentable, IExtensibleEnum

public enum DamageScaling
extends Enum<DamageScaling>
implements StringRepresentable, IExtensibleEnum

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface net.minecraft.util.StringRepresentable

StringRepresentable.EnumCodec<E extends Enum<E> & StringRepresentable>, StringRepresentable.StringRepresentableCodec<S extends StringRepresentable>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS
NEVER
WHEN_CAUSED_BY_LIVING_NON_PLAYER

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<DamageScaling>	CODEC
private final String	id
private final IScalingFunction	scaling

Fields inherited from interface net.minecraft.util.StringRepresentable

PRE_BUILT_MAP_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DamageScaling(String p_270266_)
private	DamageScaling(String id, IScalingFunction scaling)

Method Summary

Modifier and Type	Method	Description
static DamageScaling	create(String name, String id, IScalingFunction scaling)	Creates a new DamageScaling with the specified ID and scaling function. Example usage:

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.neoforged.neoforge.common.IExtensibleEnum

init

Enum Constant Details

NEVER

public static final DamageScaling NEVER

WHEN_CAUSED_BY_LIVING_NON_PLAYER

public static final DamageScaling WHEN_CAUSED_BY_LIVING_NON_PLAYER

ALWAYS

public static final DamageScaling ALWAYS

Field Details

CODEC

public static final com.mojang.serialization.Codec<DamageScaling> CODEC

id

private final String id

scaling

private final IScalingFunction scaling

Constructor Details

DamageScaling

private DamageScaling(String p_270266_)

DamageScaling

private DamageScaling(String id,
 IScalingFunction scaling)

Method Details

values

public static DamageScaling[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DamageScaling valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getSerializedName

public String getSerializedName()

Specified by:

getSerializedName in interface StringRepresentable

getScalingFunction

public IScalingFunction getScalingFunction()

The scaling function is used when a player is hurt by a damage type with this type of scaling.

Returns:

The IScalingFunction associated with this damage scaling.

create

public static DamageScaling create(String name,
 String id,
 IScalingFunction scaling)

Creates a new DamageScaling with the specified ID and scaling function.
Example usage:

 public static final DamageScaling CUSTOM_SCALING = DamageEffects.create("MYMOD_CUSTOM", "mymod:custom", MyMod.CUSTOM_SCALING_FUNCTION);
 

Parameters:

name - The true enum name. Prefix this with your modid.

id - The serialized name. Prefix this with your modid and `:`

scaling - The scaling function that will be used when a player is hurt by a damage type with this type of scaling.

Returns:

A newly created DamageScaling. Store this result in a static final field.