forestry.api.book

Interface IBookPageFactory

All Known Implementing Classes:

JsonPageFactory

public interface IBookPageFactory

A factory that creates book pages for a book entry.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<IGuiElement>	load(IBookEntry entry, int leftPageHeight, int rightPageHeight, int pageWidth) Usually called at the moment the player opens the given entry.

Method Detail

load

java.util.Collection<IGuiElement> load(IBookEntry entry,
                                       int leftPageHeight,
                                       int rightPageHeight,
                                       int pageWidth)

Usually called at the moment the player opens the given entry. Creates a collection of gui elements that represent a page of the book.

Parameters:

entry - The opened book entry.

leftPageHeight - The height of a page on the left side of the book.

rightPageHeight - The height of a page on the right side of the book.

pageWidth - The width of a book page.

Returns:

A collection where every member represent a page of the book.