de.ellpeck.rarmor.api.module

Class ActiveRarmorModule

java.lang.Object

de.ellpeck.rarmor.api.module.ActiveRarmorModule

public abstract class ActiveRarmorModule
extends java.lang.Object

A basic class for a Rarmor module. The way this works is similar to a TileEntity in that every module is a seperate instance of this class. Because of this, extensions of this class need to have a constructor that only takes in an IRarmorData or it will crash.

Extend this to make a custom module. The class then has to be registered using the RarmorAPI.registerRarmorModule method.

Field Summary

Fields

Modifier and Type	Field and Description
IRarmorData	data
boolean	invalid If this module is invalid.

Constructor Summary

Constructors

Constructor and Description
ActiveRarmorModule(IRarmorData data)

Method Summary

Modifier and Type	Method and Description
abstract RarmorModuleContainer	createContainer(net.minecraft.entity.player.EntityPlayer player, net.minecraft.inventory.Container container) Creates a new container when opening this' tab.
abstract RarmorModuleGui	createGui(net.minecraft.client.gui.inventory.GuiContainer gui) Creates a new GUI when opening this' tab.
boolean	doesRenderOnOverlay(net.minecraft.client.Minecraft mc, net.minecraft.entity.player.EntityPlayer player, IRarmorData data) Gets if this module should appear on the overlay on the top left of the screen
boolean	equals(java.lang.Object o)
abstract net.minecraft.item.ItemStack	getDisplayIcon() Gets the icon that is displayed in the overlay on the top left of the screen and the tab on the right side of the Rarmor.
abstract java.lang.String	getIdentifier() Gets the identifier of this module.
abstract boolean	hasTab(net.minecraft.entity.player.EntityPlayer player) Gets if this module should have an openable tab on the side of the Rarmor.
abstract void	onInstalled(net.minecraft.entity.Entity entity) Called when this module is installed into a Rarmor
abstract void	onUninstalled(net.minecraft.entity.Entity entity) Called when this module is uninstalled from a Rarmor
abstract void	readFromNBT(net.minecraft.nbt.NBTTagCompound compound, boolean sync) Reads this module from NBT.
abstract void	renderAdditionalOverlay(net.minecraft.client.Minecraft mc, net.minecraft.entity.player.EntityPlayer player, IRarmorData data, net.minecraft.client.gui.ScaledResolution resolution, int renderX, int renderY, float partialTicks) This can be used to render additional information to the overlay displayed on the top left of the screen
abstract void	tick(net.minecraft.world.World world, net.minecraft.entity.Entity entity, boolean isWearingHat, boolean isWearingChest, boolean isWearingPants, boolean isWearingShoes) Ticks this module.
abstract void	writeToNBT(net.minecraft.nbt.NBTTagCompound compound, boolean sync) Writes this module to NBT.

Methods inherited from class java.lang.Object

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

Field Detail

data

public final IRarmorData data

invalid

public boolean invalid

If this module is invalid. Can be set to true in the tick method to avoid concurrent modifications. If so, it will get removed from the list of modules and its item will be dropped.

Constructor Detail

ActiveRarmorModule

public ActiveRarmorModule(IRarmorData data)

Method Detail

getIdentifier

public abstract java.lang.String getIdentifier()

Gets the identifier of this module. Has to be the exact same as the one the module is registered with.

Returns:

The identifier

readFromNBT

public abstract void readFromNBT(net.minecraft.nbt.NBTTagCompound compound,
                                 boolean sync)

Reads this module from NBT.

Parameters:

compound - The compound of NBT to read from

sync - If this is for syncing or for saving to disc

writeToNBT

public abstract void writeToNBT(net.minecraft.nbt.NBTTagCompound compound,
                                boolean sync)

Writes this module to NBT.

Parameters:

compound - The compound of NBT to write to

sync - If this is for syncing or for saving to disc

createContainer

public abstract RarmorModuleContainer createContainer(net.minecraft.entity.player.EntityPlayer player,
                                                      net.minecraft.inventory.Container container)

Creates a new container when opening this' tab. This is only needed when the hasTab method returns true.

Parameters:

player - The player that is opening the tab

container - The base Rarmor container the tab is opened on

Returns:

A new module container

createGui

public abstract RarmorModuleGui createGui(net.minecraft.client.gui.inventory.GuiContainer gui)

Creates a new GUI when opening this' tab. This is only needed when the hasTab method returns true.

Parameters:

gui - The base Rarmor GUI the tab is opened on

Returns:

A new module container

onInstalled

public abstract void onInstalled(net.minecraft.entity.Entity entity)

Called when this module is installed into a Rarmor

Parameters:

entity - The entity that is installing this

onUninstalled

public abstract void onUninstalled(net.minecraft.entity.Entity entity)

Called when this module is uninstalled from a Rarmor

Parameters:

entity - The entity that is uninstalling this

hasTab

public abstract boolean hasTab(net.minecraft.entity.player.EntityPlayer player)

Gets if this module should have an openable tab on the side of the Rarmor.

Parameters:

player - The player that is trying to have a tab

Returns:

If this module has a tab

getDisplayIcon

public abstract net.minecraft.item.ItemStack getDisplayIcon()

Gets the icon that is displayed in the overlay on the top left of the screen and the tab on the right side of the Rarmor. If neither is enabled, this can return null.

Don't just return a new ItemStack here, as this is being called every tick and would produce unnecessary memory usage.

Returns:

The Item to be displayed.

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

tick

public abstract void tick(net.minecraft.world.World world,
                          net.minecraft.entity.Entity entity,
                          boolean isWearingHat,
                          boolean isWearingChest,
                          boolean isWearingPants,
                          boolean isWearingShoes)

Ticks this module. This is the equivalent of ITickable's update method.

Parameters:

world - The world

entity - The entity

isWearingHat - If the entity is currently wearing the Rarmor hat

isWearingChest - If the entity is currently wearing the Rarmor chestpalte

isWearingPants - If the entity is currently wearing the Rarmor pants

isWearingShoes - If the entity is currently wearing the Rarmor shoes

renderAdditionalOverlay

public abstract void renderAdditionalOverlay(net.minecraft.client.Minecraft mc,
                                             net.minecraft.entity.player.EntityPlayer player,
                                             IRarmorData data,
                                             net.minecraft.client.gui.ScaledResolution resolution,
                                             int renderX,
                                             int renderY,
                                             float partialTicks)

This can be used to render additional information to the overlay displayed on the top left of the screen

Parameters:

mc - The Minecraft instance

player - The player that is wearing the Rarmor

data - The data (same as this' data variable)

resolution - The current resolution

renderX - The x position to render this module at

renderY - The y position to render this module at

partialTicks - The amount of partial ticks

doesRenderOnOverlay

public boolean doesRenderOnOverlay(net.minecraft.client.Minecraft mc,
                                   net.minecraft.entity.player.EntityPlayer player,
                                   IRarmorData data)

Gets if this module should appear on the overlay on the top left of the screen

Parameters:

mc - The Minecraft instance

player - The player that is wearing the Rarmor

data - The data (same as this' data variable)

Returns:

If this should be displayed