Enum Class ClientArmorRegistry

java.lang.Object
java.lang.Enum<ClientArmorRegistry>
me.desht.pneumaticcraft.client.pneumatic_armor.ClientArmorRegistry
All Implemented Interfaces:
Serializable, Comparable<ClientArmorRegistry>, Constable, IClientArmorRegistry

public enum ClientArmorRegistry extends Enum<ClientArmorRegistry> implements IClientArmorRegistry
  • Enum Constant Details

  • Method Details

    • values

      public static ClientArmorRegistry[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ClientArmorRegistry valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getInstance

      public static ClientArmorRegistry getInstance()
    • registerEntityTrackEntry

      public void registerEntityTrackEntry(Supplier<? extends IEntityTrackEntry> entry)
      Description copied from interface: IClientArmorRegistry
      Register an entity tracker for the Pneumatic Helmet. Call this from FMLCommonSetupEvent listener (do not use ParallelDispatchEvent.enqueueWork(Runnable)).
      Specified by:
      registerEntityTrackEntry in interface IClientArmorRegistry
      Parameters:
      entry - the entity tracker
    • registerBlockTrackEntry

      public void registerBlockTrackEntry(net.minecraft.resources.ResourceLocation id, Supplier<? extends IBlockTrackEntry> entry)
      Description copied from interface: IClientArmorRegistry
      Register an block track entry (i.e. a subcategory of the Block Tracker) for the Pneumatic Helmet. Call this from a FMLClientSetupEvent listener (do not use ParallelDispatchEvent.enqueueWork(Runnable)).
      Specified by:
      registerBlockTrackEntry in interface IClientArmorRegistry
      Parameters:
      id - the block entry ID
      entry - the block track entry (IBlockTrackEntry.getEntryID() must return the same ID as the id parameter
    • addHUDMessage

      public void addHUDMessage(net.minecraft.network.chat.Component title, List<net.minecraft.network.chat.Component> message, int duration, int backColor)
      Description copied from interface: IClientArmorRegistry
      Add a message for display in the Pneumatic Helmet HUD display
      Specified by:
      addHUDMessage in interface IClientArmorRegistry
      Parameters:
      title - the message title
      message - the message text (can be empty if the title suffices for a one-line message)
      duration - the duration in ticks for the message to be displayed
      backColor - the message background color, including alpha (DEFAULT_MESSAGE_BGCOLOR is the default green color used by most messages)
    • registerUpgradeHandler

      public <T extends IArmorUpgradeHandler<?>> void registerUpgradeHandler(T handler, IArmorUpgradeClientHandler<T> clientHandler)
      Description copied from interface: IClientArmorRegistry
      Registers the client handler for a Pneumatic Armor upgrade. This must be called from a FMLClientSetupEvent handler; do not use ParallelDispatchEvent.enqueueWork(Runnable). This also registers any keybindings referenced by the render handler (see IArmorUpgradeClientHandler.getInitialKeyBinding() and IArmorUpgradeClientHandler.getSubKeybinds().
      Specified by:
      registerUpgradeHandler in interface IClientArmorRegistry
      Parameters:
      handler - the common upgrade handler, previously registered with
      clientHandler - the client handler to register with the common upgrade handler
    • makeKeybindingButton

      public IKeybindingButton makeKeybindingButton(int yPos, net.minecraft.client.KeyMapping keyBinding)
      Description copied from interface: IClientArmorRegistry
      Create a new keybinding button for an IOptionPage armor GUI screen. This is intended to be called from IOptionPage.populateGui(IGuiScreen) to set up a button which can be used to change a particular key binding.
      Specified by:
      makeKeybindingButton in interface IClientArmorRegistry
      Parameters:
      yPos - y position of the button
      keyBinding - the keybinding modified by the button
      Returns:
      the new button
    • makeKeybindingCheckBox

      public ICheckboxWidget makeKeybindingCheckBox(net.minecraft.resources.ResourceLocation upgradeId, int xPos, int yPos, int color, Consumer<ICheckboxWidget> onPressed)
      Description copied from interface: IClientArmorRegistry
      Create or retrieve the toggle checkbox for the given upgrade. If the checkbox doesn't already exist, it will be created; if it exists, the existing checkbox will be returned. There is only ever one toggle checkbox in existence for any given upgrade ID / clientside upgrade handler.

      This is intended to be called from IOptionPage.populateGui(IGuiScreen) when creating the GUI for an upgrade handler.

      Specified by:
      makeKeybindingCheckBox in interface IClientArmorRegistry
      Parameters:
      upgradeId - the upgrade ID
      xPos - X position of the widget
      yPos - Y position of the widget
      color - widget's text color in ARGB format
      onPressed - called when the checkbox is toggled
    • makeHUDStatPanel

      public IGuiAnimatedStat makeHUDStatPanel(net.minecraft.network.chat.Component title, net.minecraft.world.item.ItemStack icon, IArmorUpgradeClientHandler<?> clientHandler)
      Description copied from interface: IClientArmorRegistry
      Create a stat panel for display on the Pneumatic Armor HUD.

      This panel is automatically coloured according to the player's armor eyepiece color setting, and is re-positionable by the player. See IArmorUpgradeClientHandler.getDefaultStatLayout() to define the default positioning for the panel.

      Specified by:
      makeHUDStatPanel in interface IClientArmorRegistry
      Parameters:
      title - title text to display on the stat
      icon - an icon to draw next to the title
      clientHandler - the client upgrade handler this panel is associated with
      Returns:
      the stat panel
    • makeHUDStatPanel

      public IGuiAnimatedStat makeHUDStatPanel(net.minecraft.network.chat.Component title, net.minecraft.resources.ResourceLocation icon, IArmorUpgradeClientHandler<?> clientHandler)
      Description copied from interface: IClientArmorRegistry
      Just like IClientArmorRegistry.makeHUDStatPanel(Component, ItemStack, IArmorUpgradeClientHandler) but you can pass an arbitrary texture to use as the icon. The texture should be 16x16.
      Specified by:
      makeHUDStatPanel in interface IClientArmorRegistry
      Parameters:
      title - title text to display on the stat
      icon - an icon to draw next to the title
      clientHandler - the client upgrade handler this panel is associated with
      Returns:
      the stat panel
    • makeStatMoveButton

      public net.minecraft.client.gui.components.AbstractWidget makeStatMoveButton(int x, int y, IArmorUpgradeClientHandler<?> handler)
      Description copied from interface: IClientArmorRegistry
      Create a "Move Stat Screen..." button to allow the stat panel for an upgrade to be moved. Clicking this button will automatically open the stat panel configuration GUI and allow the panel to be moved.

      Call this from IOptionPage.populateGui(IGuiScreen), and pass the return value to IGuiScreen.addWidget(AbstractWidget) to add this button to your upgrade GUI.

      Specified by:
      makeStatMoveButton in interface IClientArmorRegistry
      Parameters:
      x - button X position
      y - button Y position
      handler - the client upgrade handler (can be obtained via IOptionPage.SimpleOptionPage.getClientUpgradeHandler()
      Returns:
      the button
    • getBlockTrackerFocus

      public Optional<IClientArmorRegistry.BlockTrackerFocus> getBlockTrackerFocus()
      Description copied from interface: IClientArmorRegistry
      Get the block position and face that is currently focused on by the player via the Block Tracker upgrade. If the Block Tracker isn't currently active or the player isn't currently looking at a block which is of interest to the block tracker, this will return Optional.empty().
      Specified by:
      getBlockTrackerFocus in interface IClientArmorRegistry
      Returns:
      the block and face the player is currently looking at, or Optional.empty() if not focused on a block
    • registerSubKeyBinds

      public void registerSubKeyBinds()
    • registerKeybindsWithMinecraft

      public void registerKeybindsWithMinecraft()
    • getKeybindingForUpgrade

      public net.minecraft.client.KeyMapping getKeybindingForUpgrade(net.minecraft.resources.ResourceLocation upgradeID)
    • getClientHandler

      public <C extends IArmorUpgradeClientHandler<U>, U extends IArmorUpgradeHandler<?>> C getClientHandler(U armorUpgradeHandler, Class<C> clientClass)
    • getClientHandler

      public IArmorUpgradeClientHandler<?> getClientHandler(net.minecraft.resources.ResourceLocation id)
    • getTriggeredHandler

      public Optional<IArmorUpgradeClientHandler<?>> getTriggeredHandler(net.minecraft.client.KeyMapping keyBinding)
    • getHandlersForSlot

      public List<IArmorUpgradeClientHandler<?>> getHandlersForSlot(net.minecraft.world.entity.EquipmentSlot slot)
      Get all the client handlers for the given armor slot. This is guaranteed to be in exactly the same order as the common handlers for the same slot (as returned by ArmorUpgradeRegistry.getHandlersForSlot(EquipmentSlot)
      Parameters:
      slot - the slot to query
      Returns:
      a list of all the client upgrade handlers registered for that slot
    • refreshConfig

      public void refreshConfig()