Package com.hammy275.immersivemc.common.config

Record Class ItemGuideColorData

java.lang.Object

java.lang.Record

com.hammy275.immersivemc.common.config.ItemGuideColorData

Record Components:

colors - Supplier of a list of colors to transition between for item guides.

selectedColors - Supplier of a list of colors to transition between for selected item guides.

rangedGrabColors - Supplier of a list of colors to transition between for ranged grab particles.

transitionTimeMS - Supplier of the time to transition between colors in the list in milliseconds. Should be a constant time!

public record ItemGuideColorData(Supplier<List<RGBA>> colors, Supplier<List<RGBA>> selectedColors, Supplier<List<RGBA>> rangedGrabColors, Supplier<Integer> transitionTimeMS)
extends Record

Contains the data for item guide coloring.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ItemGuideColorData.GsonHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final ItemGuideColorData	DEFAULT_CUSTOM

Constructor Summary

Constructors

Constructor	Description
ItemGuideColorData(Supplier<List<RGBA>> colors, Supplier<List<RGBA>> selectedColors, Supplier<List<RGBA>> rangedGrabColors, Supplier<Integer> transitionTimeMS)	Creates an instance of a ItemGuideColorData record class.

Method Summary

Modifier and Type	Method	Description
Supplier<List<RGBA>>	colors()	Returns the value of the colors record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static ItemGuideColorData	of(Supplier<RGBA> color, Supplier<RGBA> selectedColor, Supplier<RGBA> rangedGrabColor)
static ItemGuideColorData	of(List<RGBA> colors, List<RGBA> selectedColors, List<RGBA> rangedGrabColors, int transitionTimeMS)
Supplier<List<RGBA>>	rangedGrabColors()	Returns the value of the rangedGrabColors record component.
Supplier<List<RGBA>>	selectedColors()	Returns the value of the selectedColors record component.
final String	toString()	Returns a string representation of this record class.
Supplier<Integer>	transitionTimeMS()	Returns the value of the transitionTimeMS record component.
ItemGuideColorData	withChangedTransitionTime(int newTransitionTimeMS)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_CUSTOM

public static final ItemGuideColorData DEFAULT_CUSTOM

Constructor Details

ItemGuideColorData

public ItemGuideColorData(Supplier<List<RGBA>> colors,
 Supplier<List<RGBA>> selectedColors,
 Supplier<List<RGBA>> rangedGrabColors,
 Supplier<Integer> transitionTimeMS)

Creates an instance of a ItemGuideColorData record class.

Parameters:

colors - the value for the colors record component

selectedColors - the value for the selectedColors record component

rangedGrabColors - the value for the rangedGrabColors record component

transitionTimeMS - the value for the transitionTimeMS record component

Method Details

of

public static ItemGuideColorData of(Supplier<RGBA> color,
 Supplier<RGBA> selectedColor,
 Supplier<RGBA> rangedGrabColor)

of

public static ItemGuideColorData of(List<RGBA> colors,
 List<RGBA> selectedColors,
 List<RGBA> rangedGrabColors,
 int transitionTimeMS)

withChangedTransitionTime

public ItemGuideColorData withChangedTransitionTime(int newTransitionTimeMS)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

colors

public Supplier<List<RGBA>> colors()

Returns the value of the colors record component.

Returns:

the value of the colors record component

selectedColors

public Supplier<List<RGBA>> selectedColors()

Returns the value of the selectedColors record component.

Returns:

the value of the selectedColors record component

rangedGrabColors

public Supplier<List<RGBA>> rangedGrabColors()

Returns the value of the rangedGrabColors record component.

Returns:

the value of the rangedGrabColors record component

transitionTimeMS

public Supplier<Integer> transitionTimeMS()

Returns the value of the transitionTimeMS record component.

Returns:

the value of the transitionTimeMS record component