Package com.portingdeadmods.researchd.impl.research.icons

Record Class SpriteResearchIcon

java.lang.Object

java.lang.Record

com.portingdeadmods.researchd.impl.research.icons.SpriteResearchIcon

All Implemented Interfaces:

ResearchIcon

public record SpriteResearchIcon(net.minecraft.resources.ResourceLocation sprite, int width, int height)
extends Record
implements ResearchIcon

Field Summary

Fields

Modifier and Type	Field	Description
static final SpriteResearchIcon	EMPTY
static final net.minecraft.resources.ResourceLocation	ID
static final ResearchIconSerializer<SpriteResearchIcon>	SERIALIZER

Fields inherited from interface com.portingdeadmods.researchd.api.research.ResearchIcon

CODEC, STREAM_CODEC

Constructor Summary

Constructors

Constructor	Description
SpriteResearchIcon(net.minecraft.resources.ResourceLocation sprite, int width, int height)	Creates an instance of a SpriteResearchIcon record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ResearchIconSerializer<SpriteResearchIcon>	getSerializer()
final int	hashCode()	Returns a hash code value for this object.
int	height()	Returns the value of the height record component.
net.minecraft.resources.ResourceLocation	id()
net.minecraft.resources.ResourceLocation	sprite()	Returns the value of the sprite record component.
static SpriteResearchIcon	spriteIcon(String namespace, String path, int width, int height)
final String	toString()	Returns a string representation of this record class.
int	width()	Returns the value of the width record component.

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZER

public static final ResearchIconSerializer<SpriteResearchIcon> SERIALIZER

ID

public static final net.minecraft.resources.ResourceLocation ID

EMPTY

public static final SpriteResearchIcon EMPTY

Constructor Details

SpriteResearchIcon

public SpriteResearchIcon(net.minecraft.resources.ResourceLocation sprite,
 int width,
 int height)

Creates an instance of a SpriteResearchIcon record class.

Parameters:

sprite - the value for the sprite record component

width - the value for the width record component

height - the value for the height record component

Method Details

id

public net.minecraft.resources.ResourceLocation id()

Specified by:

id in interface ResearchIcon

Returns:

The id of this type of Research Icon. Usually this is just a constant in the Research Icon class

getSerializer

public ResearchIconSerializer<SpriteResearchIcon> getSerializer()

Specified by:

getSerializer in interface ResearchIcon

spriteIcon

public static SpriteResearchIcon spriteIcon(String namespace,
 String path,
 int width,
 int height)

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

sprite

public net.minecraft.resources.ResourceLocation sprite()

Returns the value of the sprite record component.

Returns:

the value of the sprite record component

width

public int width()

Returns the value of the width record component.

Returns:

the value of the width record component

height

public int height()

Returns the value of the height record component.

Returns:

the value of the height record component