Package me.desht.pneumaticcraft.client.pneumatic_armor.upgrade_handler

Class KickClientHandler

java.lang.Object
me.desht.pneumaticcraft.api.client.pneumatic_helmet.IArmorUpgradeClientHandler.AbstractHandler<T>
me.desht.pneumaticcraft.api.client.pneumatic_helmet.IArmorUpgradeClientHandler.SimpleToggleableHandler<KickHandler>
me.desht.pneumaticcraft.client.pneumatic_armor.upgrade_handler.KickClientHandler
All Implemented Interfaces:
IArmorUpgradeClientHandler<KickHandler>
public class KickClientHandler extends IArmorUpgradeClientHandler.SimpleToggleableHandler<KickHandler>

  • Constructor Details

    • KickClientHandler

      public KickClientHandler()

  • Method Details

    • getTriggerKeyBinding

      public Optional<net.minecraft.client.KeyMapping> getTriggerKeyBinding()
      Description copied from interface: IArmorUpgradeClientHandler
      Get the keybind used to trigger this upgrade's action, if any. This is distinct from the toggle keybind (which switches an upgrade on or off); the trigger keybind triggers an action, e.g. Hacking, Pneumatic Kick...
      Returns:
      an optional keybinding name

    • onTriggered

      public void onTriggered(ICommonArmorHandler armorHandler)
      Description copied from interface: IArmorUpgradeClientHandler
      Called when the registered triggered keybind (if any) is pressed.
      Parameters:
      armorHandler - the client-side common armor handler object for the player

    • getGuiOptionsPage

      public IOptionPage getGuiOptionsPage(IGuiScreen screen)
      Description copied from interface: IArmorUpgradeClientHandler
      When you have some configurable options for your upgrade handler, return a new instance of an IOptionPage. When you do so, it will automatically get picked up by the armor GUI handler, and a button for the upgrade will be displayed in the main armor GUI.
      Specified by:
      getGuiOptionsPage in interface IArmorUpgradeClientHandler<KickHandler>
      Overrides:
      getGuiOptionsPage in class IArmorUpgradeClientHandler.SimpleToggleableHandler<KickHandler>
      Parameters:
      screen - an instance of the gui Screen object
      Returns:
      an options page, or null if the upgrade does not have an options page

    • isToggleable

      public boolean isToggleable()
      Description copied from interface: IArmorUpgradeClientHandler
      Is this upgrade toggleable, i.e. can it be switched on & off? Toggleable upgrades will have a checkbox in their GUI page with a possible associated keybinding. Non-toggleable upgrades generally have a bindable hotkey to trigger a one-off action (e.g. hacking, chestplate launcher...). The default return value for this method is true, which is the most common case. Override to return false for non-toggleable upgrades.
      Returns:
      true if the upgrade is toggleable, false otherwise