Rewrite MeteorToast via builder pattern [Addons breaking] (#5496)

Author: Big-Iron-Cheems

src/main/java/meteordevelopment/meteorclient/systems/modules/world/StashFinder.java

@@ -125,10 +125,14 @@ private void onChunkData(ChunkDataEvent event) {
             if (sendNotifications.get() && (!chunk.equals(prevChunk) || !chunk.countsEqual(prevChunk))) {
                 switch (notificationMode.get()) {
                     case Chat -> info("Found stash at (highlight)%s(default), (highlight)%s(default).", chunk.x, chunk.z);
-                    case Toast -> mc.getToastManager().add(new MeteorToast(Items.CHEST, title, "Found Stash!"));
+                    case Toast -> {
+                        MeteorToast toast = new MeteorToast.Builder(title).icon(Items.CHEST).text("Found Stash!").build();
+                        mc.getToastManager().add(toast);
+                    }
                     case Both -> {
                         info("Found stash at (highlight)%s(default), (highlight)%s(default).", chunk.x, chunk.z);
-                        mc.getToastManager().add(new MeteorToast(Items.CHEST, title, "Found Stash!"));
+                        MeteorToast toast = new MeteorToast.Builder(title).icon(Items.CHEST).text("Found Stash!").build();
+                        mc.getToastManager().add(toast);
                     }
                 }
             }

src/main/java/meteordevelopment/meteorclient/utils/player/TitleScreenCredits.java

@@ -55,7 +55,8 @@ private static void init() {
                 switch (res.statusCode()) {
                     case Http.UNAUTHORIZED -> {
                         String message = "Invalid authentication token for repository '%s'".formatted(repo.getOwnerName());
-                        mc.getToastManager().add(new MeteorToast(Items.BARRIER, "GitHub: Unauthorized", message));
+                        MeteorToast toast = new MeteorToast.Builder("GitHub: Unauthorized").icon(Items.BARRIER).text(message).build();
+                        mc.getToastManager().add(toast);
                         MeteorClient.LOG.warn(message);
                         if (System.getenv("meteor.github.authorization") == null) {
                             MeteorClient.LOG.info("Consider setting an authorization " +

src/main/java/meteordevelopment/meteorclient/utils/render/MeteorToast.java

@@ -26,28 +26,68 @@
 import static meteordevelopment.meteorclient.MeteorClient.mc;
 
 public class MeteorToast implements Toast {
-    public static final int TITLE_COLOR = Color.fromRGBA(145, 61, 226, 255);
-    public static final int TEXT_COLOR = Color.fromRGBA(220, 220, 220, 255);
+    private static final int TITLE_COLOR = Color.fromRGBA(145, 61, 226, 255);
+    private static final int TEXT_COLOR = Color.fromRGBA(220, 220, 220, 255);
     private static final Identifier TEXTURE = Identifier.of("toast/advancement");
-
-    private ItemStack icon;
-    private Text title, text;
-    private boolean justUpdated = true, playedSound;
-    private long start, duration;
-    private Toast.Visibility visibility = Visibility.HIDE;
-
-    public MeteorToast(@Nullable Item item, @NotNull String title, @Nullable String text, long duration) {
-        this.icon = item != null ? item.getDefaultStack() : null;
-        this.title = Text.literal(title).setStyle(Style.EMPTY.withColor(TextColor.fromRgb(TITLE_COLOR)));
-        this.text = text != null ? Text.literal(text).setStyle(Style.EMPTY.withColor(TextColor.fromRgb(TEXT_COLOR))) : null;
-        this.duration = duration;
+    private static final long DEFAULT_DURATION = 6000;
+    private static final SoundInstance DEFAULT_SOUND = PositionedSoundInstance.master(SoundEvents.BLOCK_NOTE_BLOCK_CHIME.value(), 1.2f, 1);
+
+    // Toast fields
+    private final @NotNull Text title;
+    private final @Nullable Text text;
+    private final @Nullable ItemStack icon;
+    private final @Nullable SoundInstance customSound;
+    private final long duration;
+
+    // State variables
+    private boolean playedSound;
+    private long start = -1;
+    private Visibility visibility = Visibility.HIDE;
+
+    private MeteorToast(Builder builder) {
+        this.title = builder.title;
+        this.text = builder.text;
+        this.icon = builder.icon;
+        this.customSound = builder.customSound;
+        this.duration = builder.duration;
     }
 
-    public MeteorToast(@Nullable Item item, @NotNull String title, @Nullable String text) {
-        this.icon = item != null ? item.getDefaultStack() : null;
-        this.title = Text.literal(title).setStyle(Style.EMPTY.withColor(TextColor.fromRgb(TITLE_COLOR)));
-        this.text = text != null ? Text.literal(text).setStyle(Style.EMPTY.withColor(TextColor.fromRgb(TEXT_COLOR))) : null;
-        this.duration = 6000;
+    public static class Builder {
+        private final @NotNull Text title;
+        private @Nullable Text text;
+        private @Nullable ItemStack icon;
+        private @Nullable SoundInstance customSound = DEFAULT_SOUND;
+        private long duration = DEFAULT_DURATION;
+
+        public Builder(@NotNull String title) {
+            this.title = Text.literal(title).setStyle(Style.EMPTY.withColor(TextColor.fromRgb(TITLE_COLOR)));
+        }
+
+        public Builder text(@Nullable String text) {
+            this.text = text != null && !text.trim().isEmpty() ?
+                Text.literal(text).setStyle(Style.EMPTY.withColor(TextColor.fromRgb(TEXT_COLOR))) :
+                null;
+            return this;
+        }
+
+        public Builder icon(@Nullable Item item) {
+            this.icon = item != null ? item.getDefaultStack() : null;
+            return this;
+        }
+
+        public Builder sound(@Nullable SoundInstance sound) {
+            this.customSound = sound;
+            return this;
+        }
+
+        public Builder duration(long duration) {
+            this.duration = Math.max(0, duration);
+            return this;
+        }
+
+        public MeteorToast build() {
+            return new MeteorToast(this);
+        }
     }
 
     @Override
@@ -57,15 +97,12 @@ public Visibility getVisibility() {
 
     @Override
     public void update(ToastManager manager, long time) {
-        if (justUpdated) {
-            start = time;
-            justUpdated = false;
-        }
+        if (start == -1) start = time;
 
-        visibility = time - start >= duration ? Toast.Visibility.HIDE : Toast.Visibility.SHOW;
+        visibility = time - start >= duration ? Visibility.HIDE : Visibility.SHOW;
 
         if (!playedSound) {
-            mc.getSoundManager().play(getSound());
+            mc.getSoundManager().play(customSound);
             playedSound = true;
         }
     }
@@ -74,41 +111,16 @@ public void update(ToastManager manager, long time) {
     public void draw(DrawContext context, TextRenderer textRenderer, long startTime) {
         context.drawGuiTexture(RenderPipelines.GUI_TEXTURED, TEXTURE, 0, 0, getWidth(), getHeight());
 
-        int x = icon != null ? 28 : 12;
+        int textX = icon != null ? 28 : 12;
         int titleY = 12;
 
         if (text != null) {
-            context.drawText(mc.textRenderer, title, x, 18, TITLE_COLOR, false);
+            context.drawText(textRenderer, text, textX, 18, TEXT_COLOR, false);
             titleY = 7;
         }
 
-        context.drawText(mc.textRenderer, title, x, titleY, TITLE_COLOR, false);
+        context.drawText(textRenderer, title, textX, titleY, TITLE_COLOR, false);
 
         if (icon != null) context.drawItem(icon, 8, 8);
     }
-
-    public void setIcon(@Nullable Item item) {
-        this.icon = item != null ? item.getDefaultStack() : null;
-        justUpdated = true;
-    }
-
-    public void setTitle(@NotNull String title) {
-        this.title = Text.literal(title).setStyle(Style.EMPTY.withColor(TextColor.fromRgb(TITLE_COLOR)));
-        justUpdated = true;
-    }
-
-    public void setText(@Nullable String text) {
-        this.text = text != null ? Text.literal(text).setStyle(Style.EMPTY.withColor(TextColor.fromRgb(TEXT_COLOR))) : null;
-        justUpdated = true;
-    }
-
-    public void setDuration(long duration) {
-        this.duration = duration;
-        justUpdated = true;
-    }
-
-    // Addons: @Override this method in a subclass if you want a different sound
-    public SoundInstance getSound() {
-        return PositionedSoundInstance.master(SoundEvents.BLOCK_NOTE_BLOCK_CHIME.value(), 1.2f, 1);
-    }
 }