forestry.api.book

Interface IBookCategory

All Known Implementing Classes:

BookCategory

public interface IBookCategory

Method Summary

Modifier and Type	Method and Description
IBookCategory	addEntry(IBookEntry entry) Adds an custom entry to the category.
IBookCategory	addEntry(java.lang.String name, net.minecraft.item.ItemStack stack) Adds an entry with the given name and the given icon to the category.
IBookEntryBuilder	createEntry(java.lang.String name) Creates a entry builder with the given name.
IBookEntryBuilder	createEntry(java.lang.String name, net.minecraft.item.ItemStack stack) Creates a entry builder with the given name and the given icon.
java.util.Collection<IBookEntry>	getEntries()
IBookEntry	getEntry(java.lang.String name)
java.lang.String	getLocalizedName()
java.lang.String	getName()
net.minecraft.item.ItemStack	getStack()
java.lang.String	getTooltip() Currently unused
IBookCategory	setStack(net.minecraft.item.ItemStack stack)

Method Detail

getStack

net.minecraft.item.ItemStack getStack()

Returns:

the ItemStack that represents this category at the front page.

setStack

IBookCategory setStack(net.minecraft.item.ItemStack stack)

addEntry

IBookCategory addEntry(IBookEntry entry)

Adds an custom entry to the category.

addEntry

IBookCategory addEntry(java.lang.String name,
                       net.minecraft.item.ItemStack stack)

Adds an entry with the given name and the given icon to the category.

Parameters:

name - A unique name for this entry.

stack - The stack that will be displayed next to the entry title at the category page.

createEntry

IBookEntryBuilder createEntry(java.lang.String name)

Creates a entry builder with the given name.

At the end of your creation you have to call IBookEntryBuilder.addToCategory() to add the entry to this category.

Parameters:

name - A unique name for this entry.

createEntry

IBookEntryBuilder createEntry(java.lang.String name,
                              net.minecraft.item.ItemStack stack)

Creates a entry builder with the given name and the given icon.

At the end of your creation you have to call IBookEntryBuilder.addToCategory() to add the entry to this category.

Parameters:

name - A unique name for this entry.

stack - The stack that will be displayed next to the entry title at the category page.

getEntries

java.util.Collection<IBookEntry> getEntries()

Returns:

a collection that contains all entries of this category.

getEntry

@Nullable
IBookEntry getEntry(java.lang.String name)

Returns:

the entry with the given unique name.

getLocalizedName

java.lang.String getLocalizedName()

Returns:

the localized name of this category.

getTooltip

java.lang.String getTooltip()

Currently unused

getName

java.lang.String getName()

Returns:

the unique name of this category