Class FoliosReader

java.lang.Object

net.ixdarklord.folios.internal.client.FoliosReader

All Implemented Interfaces:

AbstractPainter.Navigator

Direct Known Subclasses:

HandheldBook

public class FoliosReader
extends Object
implements AbstractPainter.Navigator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FoliosReader.Flip
static final record	FoliosReader.Spot

Field Summary

Fields

Modifier and Type	Field	Description
final FoliosBook	book
@Nullable FoliosReader.Flip	flip
static final float	FLIP_MILLIS
final FoliosMemory	memory
FoliosSession	session
FoliosReader.Spot	spot
final TabMotion	tabs

Constructor Summary

Constructors

Constructor	Description
FoliosReader(FoliosBook book, FoliosSession session, @Nullable FoliosBook.Location at)
FoliosReader(FoliosBook book, FoliosSession session, @Nullable FoliosBook.Location at, @Nullable net.minecraft.world.InteractionHand hand)

Method Summary

Modifier and Type	Method	Description
void	back()
void	bookmarks()
protected boolean	canMove()
boolean	canTurn(int direction)
@Nullable FoliosCategory	category()
void	category(String id)
List<FoliosPageElement.Laid>	chapter(String key)
void	chrome(FoliosPainter painter, FoliosReader.Spot spot, boolean right, boolean pressable, @Nullable Runnable shut)
void	drawRevealed(FoliosPainter painter, FoliosPageElement.Laid page, FoliosReader.Spot at, boolean right)
@Nullable FoliosEntry	entry()
float	flipProgress()
void	follow(String link)
void	go(FoliosReader.Spot next)
boolean	hasHistory()
@Nullable FoliosBook.Location	here()
void	home()
void	index()
void	keepCurrent()
boolean	mention(boolean right)
void	moveAlong(FoliosReader.Spot next)
void	open(FoliosBook.Location location)
@Nullable FoliosPageElement.Laid	page(FoliosReader.Spot at, int offset)
@Nullable FoliosPopup	pinned()
int[]	progress(@Nullable String category)
void	reveal()
protected boolean	revealHeld()
FoliosPainter	revealing(FoliosPainter painter, FoliosReader.Spot at, boolean right)
FoliosReveal.Use	revealOf(FoliosReader.Spot at)
void	save()
void	search(String query)
float	seconds()
int	tabColor(@Nullable FoliosCategory category, FoliosPalette palette, boolean here, boolean hovered)
int	tabColor(@Nullable FoliosCategory category, FoliosPalette palette, float out)
@Nullable net.minecraft.network.chat.Component	tabDetail(@Nullable FoliosCategory category, String part)
static String	tabKey(@Nullable FoliosCategory category, String part)
void	turn(int direction)
void	turnTo(int page)
void	unpin()
void	useSession(FoliosSession next)

Methods inherited from class Object

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

Field Details

FLIP_MILLIS

public static final float FLIP_MILLIS

See Also:

• Constant Field Values

book

public final FoliosBook book

session

public FoliosSession session

memory

public final FoliosMemory memory

spot

public FoliosReader.Spot spot

tabs

public final TabMotion tabs

flip

public @Nullable FoliosReader.Flip flip

Constructor Details

FoliosReader

public FoliosReader(FoliosBook book,
 FoliosSession session,
 @Nullable FoliosBook.Location at)

FoliosReader

public FoliosReader(FoliosBook book,
 FoliosSession session,
 @Nullable FoliosBook.Location at,
 @Nullable net.minecraft.world.InteractionHand hand)

Method Details

keepCurrent

public void keepCurrent()

useSession

public void useSession(FoliosSession next)

seconds

public float seconds()

revealHeld

protected boolean revealHeld()

reveal

public void reveal()

revealOf

public FoliosReveal.Use revealOf(FoliosReader.Spot at)

revealing

public FoliosPainter revealing(FoliosPainter painter,
 FoliosReader.Spot at,
 boolean right)

drawRevealed

public void drawRevealed(FoliosPainter painter,
 FoliosPageElement.Laid page,
 FoliosReader.Spot at,
 boolean right)

canMove

protected boolean canMove()

chapter

public List<FoliosPageElement.Laid> chapter(String key)

page

public @Nullable FoliosPageElement.Laid page(FoliosReader.Spot at,
 int offset)

chrome

public void chrome(FoliosPainter painter,
 FoliosReader.Spot spot,
 boolean right,
 boolean pressable,
 @Nullable Runnable shut)

tabColor

public int tabColor(@Nullable FoliosCategory category,
 FoliosPalette palette,
 boolean here,
 boolean hovered)

tabColor

public int tabColor(@Nullable FoliosCategory category,
 FoliosPalette palette,
 float out)

tabDetail

public @Nullable net.minecraft.network.chat.Component tabDetail(@Nullable FoliosCategory category,
 String part)

tabKey

public static String tabKey(@Nullable FoliosCategory category,
 String part)

progress

public int[] progress(@Nullable String category)

canTurn

public boolean canTurn(int direction)

turn

public void turn(int direction)

turnTo

public void turnTo(int page)

back

public void back()

go

public void go(FoliosReader.Spot next)

moveAlong

public void moveAlong(FoliosReader.Spot next)

flipProgress

public float flipProgress()

home

public void home()

category

public void category(String id)

search

public void search(String query)

bookmarks

public void bookmarks()

index

public void index()

hasHistory

public boolean hasHistory()

pinned

public @Nullable FoliosPopup pinned()

unpin

public void unpin()

mention

public boolean mention(boolean right)

follow

public void follow(String link)

Specified by:

follow in interface AbstractPainter.Navigator

open

public void open(FoliosBook.Location location)

Specified by:

open in interface AbstractPainter.Navigator

here

public @Nullable FoliosBook.Location here()

Specified by:

here in interface AbstractPainter.Navigator

entry

public @Nullable FoliosEntry entry()

category

public @Nullable FoliosCategory category()

save

public void save()