me.desht.pneumaticcraft.common.pneumatic_armor.handlers

Class StepAssistHandler

java.lang.Object

me.desht.pneumaticcraft.api.pneumatic_armor.BaseArmorUpgradeHandler<IArmorExtensionData>

me.desht.pneumaticcraft.common.pneumatic_armor.handlers.StepAssistHandler

All Implemented Interfaces:

IArmorUpgradeHandler<IArmorExtensionData>

public class StepAssistHandler
extends BaseArmorUpgradeHandler<IArmorExtensionData>

Field Summary

Fields inherited from interface me.desht.pneumaticcraft.api.pneumatic_armor.IArmorUpgradeHandler

UPGRADE_PREFIX

Constructor Summary

Constructors

Constructor and Description
StepAssistHandler()

Method Summary

Modifier and Type	Method and Description
net.minecraft.inventory.EquipmentSlotType	getEquipmentSlot() Get the armor slot that this upgrade handler is attached to.
net.minecraft.util.ResourceLocation	getID() Get a unique ID for this upgrade handler.
float	getIdleAirUsage(ICommonArmorHandler armorHandler) Returns the usage in mL/tick when this upgrade handler is enabled.
EnumUpgrade[]	getRequiredUpgrades() Return the upgrades that are required to be in the armor piece to enable this module.
void	onShutdown(ICommonArmorHandler commonArmorHandler) Called when the armor is removed; carry out any necessary shutdown tasks here
void	onToggle(ICommonArmorHandler commonArmorHandler, boolean newState) Called when an upgrade is toggle on/off by the player
void	tick(ICommonArmorHandler commonArmorHandler, boolean enabled) Called every tick for a player when this upgrade is installed in their armor

Methods inherited from class me.desht.pneumaticcraft.api.pneumatic_armor.BaseArmorUpgradeHandler

getIndex, setIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.desht.pneumaticcraft.api.pneumatic_armor.IArmorUpgradeHandler

extensionData, getMaxInstallableUpgrades, getMinimumPressure, getStringKey, getTranslationKey, onDataFieldUpdated, onInit

Constructor Detail

StepAssistHandler

public StepAssistHandler()

Method Detail

getID

public net.minecraft.util.ResourceLocation getID()

Description copied from interface: IArmorUpgradeHandler

Get a unique ID for this upgrade handler.

Returns:

a unique resource location

getRequiredUpgrades

public EnumUpgrade[] getRequiredUpgrades()

Description copied from interface: IArmorUpgradeHandler

Return the upgrades that are required to be in the armor piece to enable this module.

Returns:

an array of required upgrades

getIdleAirUsage

public float getIdleAirUsage(ICommonArmorHandler armorHandler)

Description copied from interface: IArmorUpgradeHandler

Returns the usage in mL/tick when this upgrade handler is enabled. Note this is constant usage just from the upgrade being switched on, and does not take into account air used when some action is taken, e.g. flying with the jet boots upgrade is not included here.

Parameters:

armorHandler - the armor handler object (can be used to get upgrades, etc.)

Returns:

usage in mL/tick

getEquipmentSlot

public net.minecraft.inventory.EquipmentSlotType getEquipmentSlot()

Description copied from interface: IArmorUpgradeHandler

Get the armor slot that this upgrade handler is attached to.

Returns:

the armor slot

tick

public void tick(ICommonArmorHandler commonArmorHandler,
                 boolean enabled)

Description copied from interface: IArmorUpgradeHandler

Called every tick for a player when this upgrade is installed in their armor

Parameters:

commonArmorHandler - the armor handler object

enabled - true if the upgrade is currently enabled, false otherwise

onToggle

public void onToggle(ICommonArmorHandler commonArmorHandler,
                     boolean newState)

Description copied from interface: IArmorUpgradeHandler

Called when an upgrade is toggle on/off by the player

Parameters:

commonArmorHandler - the armor handler object

newState - the new state of the upgrade

onShutdown

public void onShutdown(ICommonArmorHandler commonArmorHandler)

Description copied from interface: IArmorUpgradeHandler

Called when the armor is removed; carry out any necessary shutdown tasks here

Parameters:

commonArmorHandler - the armor handler object