Enum Class TooltipLayout

java.lang.Object

java.lang.Enum<TooltipLayout>

net.darkhax.effecttooltips.common.api.event.TooltipLayout

All Implemented Interfaces:

Serializable, Comparable<TooltipLayout>, Constable

public enum TooltipLayout
extends Enum<TooltipLayout>

Represents the different sections of the effect tooltip and determines the ordering of tooltip entries.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BODY	The body is empty by default.
FOOTER	The footer contains the name of the mod that adds the effect.
HEADER	The header contains the name of the effect, the effect duration, and any info added by other mods that are not using this API.

Field Summary

Fields

Modifier and Type	Field	Description
final net.minecraft.resources.Identifier	id

Method Summary

Modifier and Type	Method	Description
static TooltipLayout	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TooltipLayout[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HEADER

public static final TooltipLayout HEADER

The header contains the name of the effect, the effect duration, and any info added by other mods that are not using this API.

BODY

public static final TooltipLayout BODY

The body is empty by default. Mods adding info should generally add it here.

FOOTER

public static final TooltipLayout FOOTER

The footer contains the name of the mod that adds the effect. When debug tooltips are enabled it will also include the registry ID.

Field Details

id

public final net.minecraft.resources.Identifier id

Method Details

values

public static TooltipLayout[] 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 TooltipLayout 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