Package net.ixdarklord.folios.internal.client

Class GuideSession

java.lang.Object

net.ixdarklord.folios.internal.client.GuideSession

public final class GuideSession
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GuideSession.EntryPages	An entry's pages, ready to draw: anchors and the pages of its JSON point into them.
static final record	GuideSession.Target	Where a link goes.

Method Summary

Modifier and Type	Method	Description
GuideBook	book()
net.minecraft.network.chat.Component	describe(String link)	What a link's tooltip says: where it goes.
GuideSession.EntryPages	entry(String id)
GuideLayout	layout()
GuideBook.Location	location(String entry, int laid)	A laid page of an entry as a place in the book.
int	pageOf(GuideBook.Location location)	Which laid page of its entry a place is.
@Nullable GuideSession.Target	resolve(String link)
List<GuideEntry>	search(String query)	The open entries whose name or words contain every word of a query, best matches (by name) first.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

book

public GuideBook book()

layout

public GuideLayout layout()

entry

public GuideSession.EntryPages entry(String id)

location

public GuideBook.Location location(String entry,
 int laid)

A laid page of an entry as a place in the book.

pageOf

public int pageOf(GuideBook.Location location)

Which laid page of its entry a place is.

resolve

@Nullable
public @Nullable GuideSession.Target resolve(String link)

describe

public net.minecraft.network.chat.Component describe(String link)

What a link's tooltip says: where it goes.

search

public List<GuideEntry> search(String query)

The open entries whose name or words contain every word of a query, best matches (by name) first.