de.ellpeck.rarmor.api.internal

Interface IRarmorData

public interface IRarmorData

An interface to accesss the Rarmor Data from the API.

This is not supposed to be implemented.

Method Summary

Modifier and Type	Method and Description
int	extractEnergy(int energy, boolean simulate) Tries to make the Rarmor this data is bound to extract a certain amount of energy
java.util.List<java.lang.String>	getActiveModulesForSlot(int slot) Gets the identifier of the module for an item that is in the specified slot
net.minecraft.item.ItemStack	getBoundStack() Gets the stack that this data is bound to
java.util.List<ActiveRarmorModule>	getCurrentModules() Gets the list of currently loaded and actively ticking modules
boolean	getDirty() Gets if this data should be saved to memory next time a world save happens
int	getEnergyStored() Gets the amount of RF or Tesla that the Rarmor this data is bound has stored
ActiveRarmorModule	getInstalledModuleWithId(java.lang.String moduleId) Checks if a module with a given id is installed
int	getMaxEnergyStored() Gets the max amount of RF or Tesla that the Rarmor this data is bound can store
java.util.Map<java.lang.String,java.lang.Integer>	getModuleIdsForSlots() Gets a map of strings that corresponds to the id of the module loaded in the current slot.
net.minecraft.inventory.IInventory	getModuleStacks() Returns the inventory containing all of the modules that are currently inside the Rarmor
int	getSelectedModule() Gets the place in the list of current modules that the currently selected module is in
int	getSlotForActiveModule(ActiveRarmorModule module) Gets the slot a module's item is currently in.
int	getTotalTickedTicks() Gets the amount of ticks that this Rarmor data has existed for.
void	installModule(net.minecraft.item.ItemStack stack, net.minecraft.entity.Entity entity, int slotIndex) Installs a module.
void	queueUpdate() Queues an update.
void	queueUpdate(boolean reloadTabs) Queues an update.
void	queueUpdate(boolean reloadTabs, int moduleIdForConfirmation) Queues an update.
void	queueUpdate(boolean reloadTabs, int moduleIdForConfirmation, boolean override) Queues an update.
void	readFromNBT(net.minecraft.nbt.NBTTagCompound compound, boolean sync) Reads this Data from NBT.
int	receiveEnergy(int energy, boolean simulate) Tries to make the Rarmor this data is bound to receive a certain amount of energy
void	selectModule(int i) Selects a module.
void	sendQueuedUpdate(net.minecraft.entity.player.EntityPlayer player) Sends an update that is queued.
void	setBoundStack(net.minecraft.item.ItemStack stack) Sets the stack that this data is bound to
void	setDirty() Sets if this data should be saved to memory next time a world save happens.
void	setDirty(boolean yes) Sets if this data should be saved to memory next time a world save happens
void	setEnergy(int energy) Sets the amount of energy that this Rarmor has currently stored
void	tick(net.minecraft.world.World world, net.minecraft.entity.Entity entity, boolean isWearingHat, boolean isWearingChest, boolean isWearingPants, boolean isWearingShoes) Ticks this data.
void	uninstallModule(ActiveRarmorModule module, net.minecraft.entity.Entity entity, boolean drop) Uninstalls a module.
void	writeToNBT(net.minecraft.nbt.NBTTagCompound compound, boolean sync) Writes this Data to NBT.

Method Detail

getCurrentModules

java.util.List<ActiveRarmorModule> getCurrentModules()

Gets the list of currently loaded and actively ticking modules

Returns:

the list of modules

getModuleIdsForSlots

java.util.Map<java.lang.String,java.lang.Integer> getModuleIdsForSlots()

Gets a map of strings that corresponds to the id of the module loaded in the current slot. This shouldn't ever really be useful to anyone who is making an add-on though.

Returns:

The map of strings

getModuleStacks

net.minecraft.inventory.IInventory getModuleStacks()

Returns the inventory containing all of the modules that are currently inside the Rarmor

Returns:

The inventory

getSlotForActiveModule

int getSlotForActiveModule(ActiveRarmorModule module)

Gets the slot a module's item is currently in.

Parameters:

module - The module

Returns:

The slot the module is in, or -1 if none.

getActiveModulesForSlot

java.util.List<java.lang.String> getActiveModulesForSlot(int slot)

Gets the identifier of the module for an item that is in the specified slot

Parameters:

slot - The slot

Returns:

The module that is in the slot

getSelectedModule

int getSelectedModule()

Gets the place in the list of current modules that the currently selected module is in

Returns:

The place in the list

writeToNBT

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

Writes this Data to NBT.

Parameters:

compound - The compound of NBT to write to

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

readFromNBT

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

Reads this Data from NBT.

Parameters:

compound - The compound of NBT to read from

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

selectModule

void selectModule(int i)

Selects a module.

Parameters:

i - The place in the list of current modules of the module that should be selected

getBoundStack

net.minecraft.item.ItemStack getBoundStack()

Gets the stack that this data is bound to

Returns:

The stack

setBoundStack

void setBoundStack(net.minecraft.item.ItemStack stack)

Sets the stack that this data is bound to

Parameters:

stack - The stack

sendQueuedUpdate

void sendQueuedUpdate(net.minecraft.entity.player.EntityPlayer player)

Sends an update that is queued.

Do not call this, it is for internal use only. An update will be sent every tick as long as the Rarmor is in the player's inventory. To send updates yourself, use queueUpdate below.

Parameters:

player - The player to send the update to

uninstallModule

void uninstallModule(ActiveRarmorModule module,
                     net.minecraft.entity.Entity entity,
                     boolean drop)

Uninstalls a module.

Parameters:

module - The module to uninstall

entity - The entity that is trying to uninstall the module

drop - If the item should be removed from the slot and dropped

installModule

void installModule(net.minecraft.item.ItemStack stack,
                   net.minecraft.entity.Entity entity,
                   int slotIndex)

Installs a module.

Parameters:

stack - The stack the module's item is in

entity - The entity that is trying to install the module

slotIndex - The slot the module should be put in

tick

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

Ticks this data. For internal use only.

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

queueUpdate

void queueUpdate()

Queues an update.

queueUpdate

void queueUpdate(boolean reloadTabs)

Queues an update.

Parameters:

reloadTabs - If the tabs on the side should be reinitiated or not

queueUpdate

void queueUpdate(boolean reloadTabs,
                 int moduleIdForConfirmation)

Queues an update. This version should never really be needed and is for internal use only.

Parameters:

reloadTabs - If the tabs on the side should be reinitiated or not

moduleIdForConfirmation - The module's id that is sent to and then back from the client to confirm that the packet was received. Use a negative number if this shouldn't happen.

queueUpdate

void queueUpdate(boolean reloadTabs,
                 int moduleIdForConfirmation,
                 boolean override)

Queues an update. This version should never really be needed and is for internal use only.

Parameters:

reloadTabs - If the tabs on the side should be reinitiated or not

moduleIdForConfirmation - The module's id that is sent to and then back from the client to confirm that the packet was received. Use a negative number if this shouldn't happen.

override - If this update should override a currently already queued one. This is useful if reloadTabs or moduleIdForConfirmation is important.

getInstalledModuleWithId

ActiveRarmorModule getInstalledModuleWithId(java.lang.String moduleId)

Checks if a module with a given id is installed

Parameters:

moduleId - The id

Returns:

The module if it is installed, null otherwise

getTotalTickedTicks

int getTotalTickedTicks()

Gets the amount of ticks that this Rarmor data has existed for.

Returns:

The ticks

getEnergyStored

int getEnergyStored()

Gets the amount of RF or Tesla that the Rarmor this data is bound has stored

Returns:

The energy

getMaxEnergyStored

int getMaxEnergyStored()

Gets the max amount of RF or Tesla that the Rarmor this data is bound can store

Returns:

The max energy

receiveEnergy

int receiveEnergy(int energy,
                  boolean simulate)

Tries to make the Rarmor this data is bound to receive a certain amount of energy

Parameters:

energy - The amount of energy to receive

simulate - If this operation should actually happen or just be simulated

Returns:

The amount that could be received

extractEnergy

int extractEnergy(int energy,
                  boolean simulate)

Tries to make the Rarmor this data is bound to extract a certain amount of energy

Parameters:

energy - The amount of energy to extract

simulate - If this operation should actually happen or just be simulated

Returns:

The amount that could be extracted

setEnergy

void setEnergy(int energy)

Sets the amount of energy that this Rarmor has currently stored

Parameters:

energy - The amount of energy this Rarmor should have

getDirty

boolean getDirty()

Gets if this data should be saved to memory next time a world save happens

Returns:

If the data is dirty

setDirty

void setDirty(boolean yes)

Sets if this data should be saved to memory next time a world save happens

Parameters:

yes - If this should happen or not

setDirty

void setDirty()

Sets if this data should be saved to memory next time a world save happens. This is a convenience method as it will always set the value to true.