Record Class MultiblockPageElement

java.lang.Object

java.lang.Record

net.ixdarklord.folios.internal.client.page.MultiblockPageElement

All Implemented Interfaces:

GuidePage

public record MultiblockPageElement(List<List<String>> pattern, Map<String,String> mapping, Optional<String> title, String text, int height)
extends Record
implements GuidePage

Nested Class Summary

Nested classes/interfaces inherited from interface GuidePage

GuidePage.Laid, GuidePage.Part, GuidePage.SpreadHalf

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<MultiblockPageElement>	CODEC

Constructor Summary

Constructors

Constructor	Description
MultiblockPageElement(List<List<String>> pattern, Map<String,String> mapping, Optional<String> title, String text, int height)	Creates an instance of a MultiblockPageElement record class.

Method Summary

Modifier and Type	Method	Description
static Map<net.minecraft.core.BlockPos, BlockChoice>	blocks(List<List<String>> pattern, Map<String,String> mapping)	The blocks a pattern and its mapping make, by place: layers from the top down, rows, characters.
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.
int	height()	Returns the value of the height record component.
List<GuidePage.Laid>	lay(GuideLayout layout)	Sets the page out: one or more pages, each drawn on its own.
Map<String,String>	mapping()	Returns the value of the mapping record component.
List<List<String>>	pattern()	Returns the value of the pattern record component.
String	searchText()	Words of the page a search should find it by.
String	text()	Returns the value of the text record component.
Optional<String>	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface GuidePage

items, objectives, spread

Field Details

CODEC

public static final com.mojang.serialization.MapCodec<MultiblockPageElement> CODEC

Constructor Details

MultiblockPageElement

public MultiblockPageElement(List<List<String>> pattern,
 Map<String,String> mapping,
 Optional<String> title,
 String text,
 int height)

Creates an instance of a MultiblockPageElement record class.

Parameters:

pattern - the value for the pattern record component

mapping - the value for the mapping record component

title - the value for the title record component

text - the value for the text record component

height - the value for the height record component

Method Details

lay

public List<GuidePage.Laid> lay(GuideLayout layout)

Description copied from interface: GuidePage

Sets the page out: one or more pages, each drawn on its own.

Specified by:

lay in interface GuidePage

blocks

public static Map<net.minecraft.core.BlockPos, BlockChoice> blocks(List<List<String>> pattern,
 Map<String,String> mapping)

The blocks a pattern and its mapping make, by place: layers from the top down, rows, characters.

searchText

public String searchText()

Description copied from interface: GuidePage

Words of the page a search should find it by.

Specified by:

searchText in interface GuidePage

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 the compare method from their corresponding wrapper classes.

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.

pattern

public List<List<String>> pattern()

Returns the value of the pattern record component.

Returns:

the value of the pattern record component

mapping

public Map<String,String> mapping()

Returns the value of the mapping record component.

Returns:

the value of the mapping record component

title

public Optional<String> title()

Returns the value of the title record component.

Returns:

the value of the title record component

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

height

public int height()

Returns the value of the height record component.

Returns:

the value of the height record component