Package net.fabricmc.fabric.api.client.rendering.v1

Interface IdentifiedLayer

All Superinterfaces:
LayeredDrawer.Layer
public interface IdentifiedLayer extends LayeredDrawer.Layer
A hud layer that has an identifier attached for use in LayeredDrawerWrapper.

The identifiers in this interface are the vanilla hud layers in the order they are drawn in. The first layer is drawn first, which means it is at the bottom. All vanilla layers except SLEEP are in sub drawers and have a render condition attached (GameOptions.hudHidden). Operations relative to any layer will generally inherit that layer's render condition. There is currently no mechanism to change the render condition of a layer.

For common use cases and more details on how this API deals with render condition, see LayeredDrawerWrapper.

  • Field Details

    • MISC_OVERLAYS

      static final Identifier MISC_OVERLAYS
      The identifier for the vanilla miscellaneous overlays (such as vignette, spyglass, and powder snow) layer.

    • CROSSHAIR

      static final Identifier CROSSHAIR
      The identifier for the vanilla crosshair layer.

    • HOTBAR_AND_BARS

      static final Identifier HOTBAR_AND_BARS
      The identifier for the vanilla hotbar, spectator hud, experience bar, and status bars layer.

    • EXPERIENCE_LEVEL

      static final Identifier EXPERIENCE_LEVEL
      The identifier for the vanilla experience level layer.

    • STATUS_EFFECTS

      static final Identifier STATUS_EFFECTS
      The identifier for the vanilla status effects layer.

    • BOSS_BAR

      static final Identifier BOSS_BAR
      The identifier for the vanilla boss bar layer.

    • SLEEP

      static final Identifier SLEEP
      The identifier for the vanilla sleep overlay layer.

    • DEMO_TIMER

      static final Identifier DEMO_TIMER
      The identifier for the vanilla demo timer layer.

    • DEBUG

      static final Identifier DEBUG
      The identifier for the vanilla debug hud layer.

    • SCOREBOARD

      static final Identifier SCOREBOARD
      The identifier for the vanilla scoreboard layer.

    • OVERLAY_MESSAGE

      static final Identifier OVERLAY_MESSAGE
      The identifier for the vanilla overlay message layer.

    • TITLE_AND_SUBTITLE

      static final Identifier TITLE_AND_SUBTITLE
      The identifier for the vanilla title and subtitle layer.

      Note that this is not the sound subtitles.

    • CHAT

      static final Identifier CHAT
      The identifier for the vanilla chat layer.

    • PLAYER_LIST

      static final Identifier PLAYER_LIST
      The identifier for the vanilla player list layer.

    • SUBTITLES

      static final Identifier SUBTITLES
      The identifier for the vanilla sound subtitles layer.

  • Method Details

    • id

      Identifier id()
      Returns:
      the identifier of the layer

    • of

      static IdentifiedLayer of(Identifier id, LayeredDrawer.Layer layer)
      Wraps a hud layer in an identified layer.
      Parameters:
      id - the identifier to give the layer
      layer - the layer to wrap
      Returns:
      the identified layer