amerifrance.guideapi.api

Class GuideAPI

java.lang.Object

amerifrance.guideapi.api.GuideAPI

public class GuideAPI
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static net.minecraftforge.fml.common.registry.IForgeRegistry<Book>	BOOKS The new Book registry.
static net.minecraft.item.Item	guideBook The item corresponding to the Guide-API books.

Constructor Summary

Constructors

Constructor and Description
GuideAPI()

Method Summary

Modifier and Type	Method and Description
static void	addTypeReader(ITypeReader typeReader) Adds a new ITypeReader to be used when creating JSON books.
static net.minecraft.item.ItemStack	getStackFromBook(Book book) Obtains a new ItemStack associated with the provided book.
static java.util.List<ITypeReader>	getTypeReaders()
static void	initialize()
static void	setModel(Book book) Helper method for setting a model for your book.
static void	setModel(Book book, net.minecraft.util.ResourceLocation modelLoc, java.lang.String variantName) Helper method for setting a model for your book.

Methods inherited from class java.lang.Object

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

Field Detail

BOOKS

public static final net.minecraftforge.fml.common.registry.IForgeRegistry<Book> BOOKS

The new Book registry. Handles world persistence to avoid de-sync issues. Register a book with GameRegistry.register(IForgeRegistryEntry)

guideBook

public static net.minecraft.item.Item guideBook

The item corresponding to the Guide-API books. Access it after the Pre-Init event.

Constructor Detail

GuideAPI

public GuideAPI()

Method Detail

addTypeReader

public static void addTypeReader(ITypeReader typeReader)

Adds a new ITypeReader to be used when creating JSON books. If you wish for modpack developers to be able to use your Category, Entry, or Page in their book, you must register one of these.

Add your TypeReader during FMLPreInitializationEvent. The list will be queried for the only time during FMLInitializationEvent.

Parameters:

typeReader - - ITypeReader to register.

See Also:

TypeReaders

getTypeReaders

public static java.util.List<ITypeReader> getTypeReaders()

getStackFromBook

public static net.minecraft.item.ItemStack getStackFromBook(Book book)

Obtains a new ItemStack associated with the provided book.

Parameters:

book - - The book to get an ItemStack for.

Returns:

- The ItemStack associated with the provided book.

setModel

public static void setModel(Book book,
                            net.minecraft.util.ResourceLocation modelLoc,
                            java.lang.String variantName)

Helper method for setting a model for your book.

Use if you wish to use a custom model.

Only call AFTER you have registered your book.

Parameters:

book - - Book to set model for

modelLoc - - Location of the model file

variantName - - Variant to use

setModel

public static void setModel(Book book)

Helper method for setting a model for your book.

Use if you wish to use the default model with color.

Only call AFTER you have registered your book.

Parameters:

book - - Book to set model for

initialize

public static void initialize()