Interface IRadarOverlay

All Known Implementing Classes:
ExampleOverlay, IDOverlay

public interface IRadarOverlay
An interface defining a radar overlay To implement this, you must override render(boolean, RenderData, BufferBuilder, Object...) and getModID()
Since:
0.14.15.2
  • Method Summary

    Modifier and Type
    Method
    Description
    default net.minecraft.resources.ResourceLocation
    The ID of this overlay, defined by getModID() and getIDPath()
    default String
    If not overriden, this method returns the class name of the implementor converted to snake case
     
    default RadarMode
    Get the RadarMode of the radar
    void
    render(boolean canRender, RenderData renderData, com.mojang.blaze3d.vertex.BufferBuilder bufferBuilder, Object... args)
    Renders objects on top of the radar
    default void
    renderText(net.minecraft.network.chat.Component component, RenderData renderData)
    Render the text given in the given Component
    default void
    renderText(net.minecraft.network.chat.Component component, RenderData renderData, com.mojang.blaze3d.vertex.PoseStack poseStack)
    Render the text given in the given Component
    default void
    renderTexture(net.minecraft.resources.ResourceLocation texture, RenderData renderData)
    Render a texture at the given ResourceLocation
    default void
    renderTexture(net.minecraft.resources.ResourceLocation texture, RenderData renderData, int color)
    Render a texture at the given ResourceLocation
    default void
    renderTexture(net.minecraft.resources.ResourceLocation texture, RenderData renderData, com.mojang.blaze3d.vertex.PoseStack poseStack)
    Render a texture at the given ResourceLocation
    default void
    renderTexture(net.minecraft.resources.ResourceLocation texture, RenderData renderData, com.mojang.blaze3d.vertex.PoseStack poseStack, int color)
    Render a texture at the given ResourceLocation
  • Method Details

    • render

      void render(boolean canRender, RenderData renderData, com.mojang.blaze3d.vertex.BufferBuilder bufferBuilder, Object... args)
      Renders objects on top of the radar
      Parameters:
      canRender - true if either the server doesn't require WSR-88D or a WSR-88D is complete within 4 chunks of the radar
      renderData - The data used to call BlockEntityRenderer.render(BlockEntity, float, PoseStack, MultiBufferSource, int, int)
      bufferBuilder - The BufferBuilder that gets drawn to the radar
      args - The arguments to pass to the Radar Overlay
      Since:
      0.14.15.2
    • getRadarMode

      default RadarMode getRadarMode(RenderData renderData)
      Get the RadarMode of the radar
      Parameters:
      renderData - The RenderData
      Returns:
      The radar's RadarMode
      Since:
      0.14.16.2
    • renderTexture

      default void renderTexture(net.minecraft.resources.ResourceLocation texture, RenderData renderData, com.mojang.blaze3d.vertex.PoseStack poseStack, int color)
      Render a texture at the given ResourceLocation
      Parameters:
      texture - The ResourceLocation of the texture
      renderData - The RenderData
      poseStack - The PoseStack to render with
      color - The color
      Since:
      0.15.3.3
    • renderTexture

      default void renderTexture(net.minecraft.resources.ResourceLocation texture, RenderData renderData, com.mojang.blaze3d.vertex.PoseStack poseStack)
      Render a texture at the given ResourceLocation
      Parameters:
      texture - The ResourceLocation of the texture
      renderData - The RenderData
      poseStack - The PoseStack to render with
      Since:
      0.15.3.3
    • renderTexture

      default void renderTexture(net.minecraft.resources.ResourceLocation texture, RenderData renderData, int color)
      Render a texture at the given ResourceLocation
      Parameters:
      texture - The ResourceLocation of the texture
      renderData - The RenderData
      color - The color
      Since:
      0.15.3.3
    • renderTexture

      default void renderTexture(net.minecraft.resources.ResourceLocation texture, RenderData renderData)
      Render a texture at the given ResourceLocation
      Parameters:
      texture - The ResourceLocation of the texture
      renderData - The RenderData
      Since:
      0.15.3.3
    • renderText

      default void renderText(net.minecraft.network.chat.Component component, RenderData renderData, com.mojang.blaze3d.vertex.PoseStack poseStack)
      Render the text given in the given Component
      Parameters:
      component - The Component to render
      renderData - The RenderData
      poseStack - The PoseStack to render with
      Since:
      0.14.16.2
    • renderText

      default void renderText(net.minecraft.network.chat.Component component, RenderData renderData)
      Render the text given in the given Component
      Parameters:
      component - The Component to render
      renderData - The RenderData
      Since:
      0.14.16.2
    • getModID

      String getModID()
      Returns:
      The Mod ID of the mod that registered this overlay
      Since:
      0.14.15.2
    • getIDPath

      default String getIDPath()
      If not overriden, this method returns the class name of the implementor converted to snake case
      Returns:
      The path to use for this overlay's ID
      Since:
      0.14.15.2
    • getID

      default net.minecraft.resources.ResourceLocation getID()
      The ID of this overlay, defined by getModID() and getIDPath()
      Returns:
      The ResourceLocation of this overlay
      Since:
      0.14.15.2