amerifrance.guideapi.api.base

Class Book

java.lang.Object

amerifrance.guideapi.api.base.Book

public class Book
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	author
java.awt.Color	bookColor
java.util.List<CategoryAbstract>	categoryList
java.lang.String[]	chestHooks
boolean	isLostBook
java.lang.String	itemTexture
int	lootChance
net.minecraft.util.ResourceLocation	outlineTexture
net.minecraft.util.ResourceLocation	pageTexture
boolean	spawnWithBook
java.lang.String	unlocBookTitle
java.lang.String	unlocDisplayName
java.lang.String	unlocWelcomeMessage

Constructor Summary

Constructors

Constructor and Description
Book(java.util.List<CategoryAbstract> categoryList, java.lang.String unlocBookTitle, java.lang.String unlocWelcomeMessage, java.lang.String unlocDisplayName, java.awt.Color bookColor) Deprecated.
Book(java.util.List<CategoryAbstract> categoryList, java.lang.String unlocBookTitle, java.lang.String unlocWelcomeMessage, java.lang.String unlocDisplayName, java.awt.Color bookColor, boolean spawnWithBook) Deprecated.
Book(java.util.List<CategoryAbstract> categoryList, java.lang.String unlocBookTitle, java.lang.String unlocWelcomeMessage, java.lang.String unlocDisplayName, net.minecraft.util.ResourceLocation pageTexture, net.minecraft.util.ResourceLocation outlineTexture, java.awt.Color bookColor) Deprecated.
Book(java.util.List<CategoryAbstract> categoryList, java.lang.String unlocBookTitle, java.lang.String unlocWelcomeMessage, java.lang.String unlocDisplayName, java.lang.String author, net.minecraft.util.ResourceLocation pageTexture, net.minecraft.util.ResourceLocation outlineTexture, java.lang.String itemTexture, java.awt.Color bookColor, boolean spawnWithBook, boolean isLostBook, int lootChance, java.lang.String[] chestHooks)

Method Summary

Modifier and Type	Method and Description
void	addCategory(CategoryAbstract category)
void	addCategoryList(java.util.List<CategoryAbstract> categories)
boolean	equals(java.lang.Object o)
java.lang.String	getLocalizedBookTitle()
java.lang.String	getLocalizedDisplayName()
java.lang.String	getLocalizedWelcomeMessage()
int	hashCode()
void	removeCategory(CategoryAbstract category)
void	removeCategoryList(java.util.List<CategoryAbstract> categories)

Methods inherited from class java.lang.Object

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

Field Detail

categoryList

public java.util.List<CategoryAbstract> categoryList

unlocBookTitle

public java.lang.String unlocBookTitle

unlocWelcomeMessage

public java.lang.String unlocWelcomeMessage

unlocDisplayName

public java.lang.String unlocDisplayName

author

public java.lang.String author

pageTexture

public net.minecraft.util.ResourceLocation pageTexture

outlineTexture

public net.minecraft.util.ResourceLocation outlineTexture

itemTexture

public java.lang.String itemTexture

bookColor

public java.awt.Color bookColor

spawnWithBook

public boolean spawnWithBook

isLostBook

public boolean isLostBook

lootChance

public int lootChance

chestHooks

public java.lang.String[] chestHooks

Constructor Detail

Book

public Book(java.util.List<CategoryAbstract> categoryList,
            java.lang.String unlocBookTitle,
            java.lang.String unlocWelcomeMessage,
            java.lang.String unlocDisplayName,
            java.lang.String author,
            net.minecraft.util.ResourceLocation pageTexture,
            net.minecraft.util.ResourceLocation outlineTexture,
            java.lang.String itemTexture,
            java.awt.Color bookColor,
            boolean spawnWithBook,
            boolean isLostBook,
            int lootChance,
            java.lang.String[] chestHooks)

Parameters:

categoryList - - Category List with all your information

unlocBookTitle - - Unlocalized name for a book title

unlocWelcomeMessage - - Unlocalized welcome message

unlocDisplayName - - Unlocalized item display name

author - - Author of the book. Meant for the modid/modname so the book is displayed when the user searches the mod in NEI

pageTexture - - Texture for book's page

outlineTexture - - Texture for book outline

itemTexture - - Custom texture for the book. Disables the coloring on item

bookColor - - Color for the book. If an itemTexture is set, only affects GUI color

spawnWithBook - - Whether a player gets this book on the first time joining a world

isLostBook - - Pages become dungeon loot

lootChance - - Chance for pages to generate as loot. 1 = Golden Apples, 100 = Iron Ingot, 1000 = Basically override everything

chestHooks - - Types of dungeon chests to generate pages in. See ChestGenHooks

Book

@Deprecated
public Book(java.util.List<CategoryAbstract> categoryList,
                        java.lang.String unlocBookTitle,
                        java.lang.String unlocWelcomeMessage,
                        java.lang.String unlocDisplayName,
                        net.minecraft.util.ResourceLocation pageTexture,
                        net.minecraft.util.ResourceLocation outlineTexture,
                        java.awt.Color bookColor)

Deprecated.

Deprecated in favor of BookBuilder

Book

@Deprecated
public Book(java.util.List<CategoryAbstract> categoryList,
                        java.lang.String unlocBookTitle,
                        java.lang.String unlocWelcomeMessage,
                        java.lang.String unlocDisplayName,
                        java.awt.Color bookColor)

Deprecated.

Deprecated in favor of BookBuilder

Book

@Deprecated
public Book(java.util.List<CategoryAbstract> categoryList,
                        java.lang.String unlocBookTitle,
                        java.lang.String unlocWelcomeMessage,
                        java.lang.String unlocDisplayName,
                        java.awt.Color bookColor,
                        boolean spawnWithBook)

Deprecated.

Deprecated in favor of BookBuilder

Method Detail

addCategory

public void addCategory(CategoryAbstract category)

Parameters:

category - - Add this category

removeCategory

public void removeCategory(CategoryAbstract category)

Parameters:

category - - Remove this category

addCategoryList

public void addCategoryList(java.util.List<CategoryAbstract> categories)

Parameters:

categories - - Add these categories

removeCategoryList

public void removeCategoryList(java.util.List<CategoryAbstract> categories)

Parameters:

categories - - Remove these categories

getLocalizedBookTitle

public java.lang.String getLocalizedBookTitle()

Returns:

- Localized book title

getLocalizedWelcomeMessage

public java.lang.String getLocalizedWelcomeMessage()

Returns:

- Localized welcome message

getLocalizedDisplayName

public java.lang.String getLocalizedDisplayName()

Returns:

- Localized item display name

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object