amerifrance.guideapi.api.impl.abstraction

Class CategoryAbstract

java.lang.Object

amerifrance.guideapi.api.impl.abstraction.CategoryAbstract

Direct Known Subclasses:

Category

public abstract class CategoryAbstract
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<net.minecraft.util.ResourceLocation,EntryAbstract>	entries
java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
CategoryAbstract(java.util.Map<net.minecraft.util.ResourceLocation,EntryAbstract> entries, java.lang.String name)
CategoryAbstract(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addEntries(java.util.Map<net.minecraft.util.ResourceLocation,EntryAbstract> entries)
void	addEntry(net.minecraft.util.ResourceLocation key, EntryAbstract entry) Adds an entry to this category.
void	addEntry(java.lang.String key, EntryAbstract entry) Adds an entry to this category.
abstract boolean	canSee(net.minecraft.entity.player.EntityPlayer player, net.minecraft.item.ItemStack bookStack)
abstract void	draw(Book book, int categoryX, int categoryY, int categoryWidth, int categoryHeight, int mouseX, int mouseY, GuiBase guiBase, boolean drawOnLeft, net.minecraft.client.renderer.RenderItem renderItem)
abstract void	drawExtras(Book book, int categoryX, int categoryY, int categoryWidth, int categoryHeight, int mouseX, int mouseY, GuiBase guiBase, boolean drawOnLeft, net.minecraft.client.renderer.RenderItem renderItem)
boolean	equals(java.lang.Object o)
EntryAbstract	getEntry(net.minecraft.util.ResourceLocation key) Obtains an entry from this category.
EntryAbstract	getEntry(java.lang.String key) Obtains an entry from this category.
java.lang.String	getLocalizedName() Obtains a localized copy of this category's name.
java.util.List<java.lang.String>	getTooltip()
int	hashCode()
abstract void	onInit(Book book, GuiHome guiHome, net.minecraft.entity.player.EntityPlayer player, net.minecraft.item.ItemStack bookStack)
abstract void	onLeftClicked(Book book, int mouseX, int mouseY, net.minecraft.entity.player.EntityPlayer player, net.minecraft.item.ItemStack bookStack)
abstract void	onRightClicked(Book book, int mouseX, int mouseY, net.minecraft.entity.player.EntityPlayer player, net.minecraft.item.ItemStack bookStack)
void	removeEntries(java.util.List<net.minecraft.util.ResourceLocation> keys)
void	removeEntry(net.minecraft.util.ResourceLocation key)
CategoryAbstract	withKeyBase(java.lang.String keyBase) Sets the domain to use for all ResourceLocation keys passed through getEntry(String) and addEntry(String, EntryAbstract) Required in order to use those.

Methods inherited from class java.lang.Object

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

Field Detail

entries

public final java.util.Map<net.minecraft.util.ResourceLocation,EntryAbstract> entries

name

public final java.lang.String name

Constructor Detail

CategoryAbstract

public CategoryAbstract(java.util.Map<net.minecraft.util.ResourceLocation,EntryAbstract> entries,
                        java.lang.String name)

CategoryAbstract

public CategoryAbstract(java.lang.String name)

Method Detail

addEntry

public void addEntry(net.minecraft.util.ResourceLocation key,
                     EntryAbstract entry)

Adds an entry to this category.

Parameters:

key - - The key of the entry to add.

entry - - The entry to add.

addEntry

public void addEntry(java.lang.String key,
                     EntryAbstract entry)

Adds an entry to this category. Shorthand of addEntry(ResourceLocation, EntryAbstract). Requires withKeyBase(String) to have been called.

Parameters:

key - - The key of the entry to add.

entry - - The entry to add.

removeEntry

public void removeEntry(net.minecraft.util.ResourceLocation key)

addEntries

public void addEntries(java.util.Map<net.minecraft.util.ResourceLocation,EntryAbstract> entries)

removeEntries

public void removeEntries(java.util.List<net.minecraft.util.ResourceLocation> keys)

getEntry

public EntryAbstract getEntry(net.minecraft.util.ResourceLocation key)

Obtains an entry from this category. This can be null, however it is not marked as nullable to avoid annoying IDE warnings. I am making the assumption that this will only be called while creating the book and thus the caller knows it exists. If you are calling at any other time, make sure to nullcheck this.

Parameters:

key - - The key of the entry to obtain.

Returns:

the found entry.

getEntry

public EntryAbstract getEntry(java.lang.String key)

Obtains an entry from this category. Shorthand of getEntry(ResourceLocation). Requires withKeyBase(String) to have been called. This can be null, however it is not marked as nullable to avoid annoying IDE warnings. I am making the assumption that this will only be called while creating the book and thus the caller knows it exists. If you are calling at any other time, make sure to nullcheck this.

Parameters:

key - - The key of the entry to obtain.

Returns:

the found entry.

withKeyBase

public CategoryAbstract withKeyBase(java.lang.String keyBase)

Sets the domain to use for all ResourceLocation keys passed through getEntry(String) and addEntry(String, EntryAbstract) Required in order to use those.

Parameters:

keyBase - - The base domain for this entry.

Returns:

self for chaining.

getLocalizedName

public java.lang.String getLocalizedName()

Obtains a localized copy of this category's name.

Returns:

a localized copy of this category's name.

getTooltip

public java.util.List<java.lang.String> getTooltip()

draw

public abstract void draw(Book book,
                          int categoryX,
                          int categoryY,
                          int categoryWidth,
                          int categoryHeight,
                          int mouseX,
                          int mouseY,
                          GuiBase guiBase,
                          boolean drawOnLeft,
                          net.minecraft.client.renderer.RenderItem renderItem)

drawExtras

public abstract void drawExtras(Book book,
                                int categoryX,
                                int categoryY,
                                int categoryWidth,
                                int categoryHeight,
                                int mouseX,
                                int mouseY,
                                GuiBase guiBase,
                                boolean drawOnLeft,
                                net.minecraft.client.renderer.RenderItem renderItem)

canSee

public abstract boolean canSee(net.minecraft.entity.player.EntityPlayer player,
                               net.minecraft.item.ItemStack bookStack)

onLeftClicked

public abstract void onLeftClicked(Book book,
                                   int mouseX,
                                   int mouseY,
                                   net.minecraft.entity.player.EntityPlayer player,
                                   net.minecraft.item.ItemStack bookStack)

onRightClicked

public abstract void onRightClicked(Book book,
                                    int mouseX,
                                    int mouseY,
                                    net.minecraft.entity.player.EntityPlayer player,
                                    net.minecraft.item.ItemStack bookStack)

onInit

public abstract void onInit(Book book,
                            GuiHome guiHome,
                            net.minecraft.entity.player.EntityPlayer player,
                            net.minecraft.item.ItemStack bookStack)

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