Adding Widgets

Now that DynamicHUD is aware of your mod, you can start adding widgets. Widgets are the components that will be displayed on your HUD. This is done in the addWidgets() method of your MyIntegration class.

In this example, we will be using the included TextWidget.

MyIntegration.java

public class MyIntegration implements DynamicHudIntegration {
    TextWidget exampleWidget;

   @Override
   public void init() {
   // Learn more about the TextWidget Builder in the widgets Page.
    textWidget = new TextWidget.Builder()
                .setX(300)
                .setY(100)
                .setDraggable(true)
                .rainbow(false)
                .setDRKey("null")
                .setModID(MyMod.MOD_ID)
                .shouldScale(false)
                .build();
   }

   @Override
   public void addWidgets() {
     WidgetManager.addWidget(textWidget);
   }

   @Override
   public AbstractMoveableScreen getMovableScreen() {
    return null; // Replace with your implementation
   }
}

DRKey refers to DynamicRegistryKey which is used to support changing values.

Learn more about DynamicValueRegistry.

• TextWidget exampleWidget;: This line declares a TextWidget object named exampleWidget. TextWidget is a type of widget that can be added to the HUD.

• public void init(): This method is called when the mod is initialized by DynamicHUD. Inside this method, a new TextWidget is created using the TextWidget.Builder class. The builder is used to set various properties of the widget. Learn More about WidgetBuilder.
• public void addWidgets(): This method is called to add widgets to the HUD. Inside this method, the addWidget method of WidgetManager is called with textWidget as the argument, adding the previously created TextWidget to the HUD.