amerifrance.guideapi.api.impl

Class Book

java.lang.Object

amerifrance.guideapi.api.impl.Book

public class Book
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Book()
Book(java.util.List<CategoryAbstract> categoryList, java.lang.String title, java.lang.String welcomeMessage, java.lang.String displayName, java.lang.String author, net.minecraft.util.ResourceLocation pageTexture, net.minecraft.util.ResourceLocation outlineTexture, boolean customModel, java.awt.Color color, boolean spawnWithBook, net.minecraft.util.ResourceLocation registryName, net.minecraft.creativetab.CreativeTabs creativeTab)

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	getAuthor() The author of this book.
java.util.List<CategoryAbstract>	getCategoryList() A list of categories contained in this book
java.awt.Color	getColor() The color of your book.
net.minecraft.creativetab.CreativeTabs	getCreativeTab() Optionally set this to have the item appear in your creative tab rather than the misc creative tab
java.lang.String	getDisplayName() The unlocalized display title of the book item.
java.lang.String	getLocalizedBookTitle()
java.lang.String	getLocalizedDisplayName()
java.lang.String	getLocalizedWelcomeMessage()
net.minecraft.util.ResourceLocation	getOutlineTexture() The texture to draw around your page.
net.minecraft.util.ResourceLocation	getPageTexture() The texture to draw for your page.
net.minecraft.util.ResourceLocation	getRegistryName() A registry name for this book.
java.lang.String	getTitle() The unlocalized display title of this book.
java.lang.String	getWelcomeMessage() The unlocalized welcome message.
int	hashCode()
boolean	isCustomModel() Whether or not your book has a custom model.
boolean	isSpawnWithBook() Whether or not player's should spawn with this book when they first join the world.
void	removeCategory(CategoryAbstract category)
void	removeCategoryList(java.util.List<CategoryAbstract> categories)
void	setAuthor(java.lang.String author) The author of this book.
void	setCategoryList(java.util.List<CategoryAbstract> categoryList) A list of categories contained in this book
void	setColor(java.awt.Color color) The color of your book.
void	setCreativeTab(net.minecraft.creativetab.CreativeTabs creativeTab) Optionally set this to have the item appear in your creative tab rather than the misc creative tab
void	setCustomModel(boolean customModel) Whether or not your book has a custom model.
void	setDisplayName(java.lang.String displayName) The unlocalized display title of the book item.
void	setOutlineTexture(net.minecraft.util.ResourceLocation outlineTexture) The texture to draw around your page.
void	setPageTexture(net.minecraft.util.ResourceLocation pageTexture) The texture to draw for your page.
void	setRegistryName(net.minecraft.util.ResourceLocation registryName) A registry name for this book.
void	setSpawnWithBook(boolean spawnWithBook) Whether or not player's should spawn with this book when they first join the world.
void	setTitle(java.lang.String title) The unlocalized display title of this book.
void	setWelcomeMessage(java.lang.String welcomeMessage) The unlocalized welcome message.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Book

@Generated(value="lombok")
public Book()

Book

@ConstructorProperties(value={"categoryList","title","welcomeMessage","displayName","author","pageTexture","outlineTexture","customModel","color","spawnWithBook","registryName","creativeTab"})
 @Generated(value="lombok")
public Book(java.util.List<CategoryAbstract> categoryList,
                                                                                                                                                                                                                                         java.lang.String title,
                                                                                                                                                                                                                                         java.lang.String welcomeMessage,
                                                                                                                                                                                                                                         java.lang.String displayName,
                                                                                                                                                                                                                                         java.lang.String author,
                                                                                                                                                                                                                                         net.minecraft.util.ResourceLocation pageTexture,
                                                                                                                                                                                                                                         net.minecraft.util.ResourceLocation outlineTexture,
                                                                                                                                                                                                                                         boolean customModel,
                                                                                                                                                                                                                                         java.awt.Color color,
                                                                                                                                                                                                                                         boolean spawnWithBook,
                                                                                                                                                                                                                                         net.minecraft.util.ResourceLocation registryName,
                                                                                                                                                                                                                                         net.minecraft.creativetab.CreativeTabs creativeTab)

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

getCategoryList

@Generated(value="lombok")
public java.util.List<CategoryAbstract> getCategoryList()

A list of categories contained in this book

getTitle

@Generated(value="lombok")
public java.lang.String getTitle()

The unlocalized display title of this book. Drawn at the top of the home page.

getWelcomeMessage

@Generated(value="lombok")
public java.lang.String getWelcomeMessage()

The unlocalized welcome message. Displayed on the home page.

getDisplayName

@Generated(value="lombok")
public java.lang.String getDisplayName()

The unlocalized display title of the book item.

getAuthor

@Generated(value="lombok")
public java.lang.String getAuthor()

The author of this book. Usually your mod name/id.

getPageTexture

@Generated(value="lombok")
public net.minecraft.util.ResourceLocation getPageTexture()

The texture to draw for your page.

getOutlineTexture

@Generated(value="lombok")
public net.minecraft.util.ResourceLocation getOutlineTexture()

The texture to draw around your page.

isCustomModel

@Generated(value="lombok")
public boolean isCustomModel()

Whether or not your book has a custom model. If false, a colored default model will be used.

getColor

@Generated(value="lombok")
public java.awt.Color getColor()

The color of your book. Used for your model (if customModel is false) and for the outlineTexture

isSpawnWithBook

@Generated(value="lombok")
public boolean isSpawnWithBook()

Whether or not player's should spawn with this book when they first join the world.

getRegistryName

@Generated(value="lombok")
public net.minecraft.util.ResourceLocation getRegistryName()

A registry name for this book. Used internally.

getCreativeTab

@Generated(value="lombok")
public net.minecraft.creativetab.CreativeTabs getCreativeTab()

Optionally set this to have the item appear in your creative tab rather than the misc creative tab

setCategoryList

@Generated(value="lombok")
public void setCategoryList(java.util.List<CategoryAbstract> categoryList)

A list of categories contained in this book

setTitle

@Generated(value="lombok")
public void setTitle(java.lang.String title)

The unlocalized display title of this book. Drawn at the top of the home page.

setWelcomeMessage

@Generated(value="lombok")
public void setWelcomeMessage(java.lang.String welcomeMessage)

The unlocalized welcome message. Displayed on the home page.

setDisplayName

@Generated(value="lombok")
public void setDisplayName(java.lang.String displayName)

The unlocalized display title of the book item.

setAuthor

@Generated(value="lombok")
public void setAuthor(java.lang.String author)

The author of this book. Usually your mod name/id.

setPageTexture

@Generated(value="lombok")
public void setPageTexture(net.minecraft.util.ResourceLocation pageTexture)

The texture to draw for your page.

setOutlineTexture

@Generated(value="lombok")
public void setOutlineTexture(net.minecraft.util.ResourceLocation outlineTexture)

The texture to draw around your page.

setCustomModel

@Generated(value="lombok")
public void setCustomModel(boolean customModel)

Whether or not your book has a custom model. If false, a colored default model will be used.

setColor

@Generated(value="lombok")
public void setColor(java.awt.Color color)

The color of your book. Used for your model (if customModel is false) and for the outlineTexture

setSpawnWithBook

@Generated(value="lombok")
public void setSpawnWithBook(boolean spawnWithBook)

Whether or not player's should spawn with this book when they first join the world.

setRegistryName

@Generated(value="lombok")
public void setRegistryName(net.minecraft.util.ResourceLocation registryName)

A registry name for this book. Used internally.

setCreativeTab

@Generated(value="lombok")
public void setCreativeTab(net.minecraft.creativetab.CreativeTabs creativeTab)

Optionally set this to have the item appear in your creative tab rather than the misc creative tab

toString

@Generated(value="lombok")
public java.lang.String toString()

Overrides:

toString in class java.lang.Object