v0.14.15.4 - Events, Radar Packet Fix, Overlay changes

- Added 7 new events
- Fixed a critical bug w/ S2CRadarsPacket
- Updated overlays to take a new canRender parameter

Took 1 hour 3 minutes

Author: nullved

build.gradle

@@ -36,8 +36,11 @@ neoForge {
         minecraftVersion = project.parchment_minecraft_version
     }
 
+    validateAccessTransformers = true
+
     // This line is optional. Access Transformers are automatically detected
-    // accessTransformers.add('src/main/resources/META-INF/accesstransformer.cfg')
+    accessTransformers.from 'src/main/resources/META-INF/accesstransformer.cfg'
+
 
     // Default run configurations.
     // These can be tweaked, removed, or duplicated as needed.

gradle.properties

@@ -17,7 +17,7 @@ parchment_mappings_version=2024.11.17
 mod_id=pmweatherapi
 mod_name=PMWeatherAPI
 mod_license=GNU GPL 3.0
-mod_version=0.14.15.3
+mod_version=0.14.15.4
 mod_group_id=net.nullved
 mod_authors=NullVed
 mod_description=An API for interfacing with ProtoManly's Weather Mod

src/main/java/net/nullved/pmweatherapi/PMWeatherAPI.java

@@ -25,7 +25,7 @@ public PMWeatherAPI(IEventBus modEventBus, ModContainer modContainer) {
         modEventBus.addListener(this::commonSetup);
         modEventBus.addListener(this::registerPayloads);
 
-        //modEventBus.addListener(this::clientSetup);
+        // modEventBus.addListener(this::clientSetup);
 
         LOGGER.info("Initialized PMWAPI");
     }

src/main/java/net/nullved/pmweatherapi/client/event/LightningEvent.java

@@ -0,0 +1,24 @@
+package net.nullved.pmweatherapi.client.event;
+
+import dev.protomanly.pmweather.weather.Lightning;
+import net.neoforged.api.distmarker.Dist;
+import net.neoforged.api.distmarker.OnlyIn;
+import net.neoforged.bus.api.Event;
+
+/**
+ * This event only exists on the client!
+ * Called when a lightning strike happens
+ * @since 0.14.15.3
+ */
+@OnlyIn(Dist.CLIENT)
+public class LightningEvent extends Event {
+    private final Lightning lightning;
+
+    public LightningEvent(Lightning lightning) {
+        this.lightning = lightning;
+    }
+
+    public Lightning getLightning() {
+        return lightning;
+    }
+}

src/main/java/net/nullved/pmweatherapi/client/radar/RadarClientStorage.java

@@ -10,7 +10,6 @@
 import net.minecraft.server.level.ServerLevel;
 import net.minecraft.world.level.Level;
 import net.nullved.pmweatherapi.client.data.PMWClientStorages;
-import net.nullved.pmweatherapi.data.PMWStorages;
 import net.nullved.pmweatherapi.network.S2CRadarsPacket;
 import net.nullved.pmweatherapi.radar.RadarStorage;
 

src/main/java/net/nullved/pmweatherapi/client/render/IRadarOverlay.java

@@ -9,17 +9,18 @@
 
 /**
  * An interface defining a radar overlay
- * To implement this, you must override {@link #render(RenderData, BufferBuilder)} and {@link #getModID()}
+ * To implement this, you must override {@link #render(boolean, RenderData, BufferBuilder)} and {@link #getModID()}
  * @since 0.14.15.2
  */
 public interface IRadarOverlay {
     /**
      * Renders objects on top of the radar
+     * @param canRender {@code true} if either the server doesn't require WSR-88D or a WSR-88D is complete within 4 chunks of the radar
      * @param renderData The data used to call {@link BlockEntityRenderer#render(BlockEntity, float, PoseStack, MultiBufferSource, int, int)}
      * @param bufferBuilder The {@link BufferBuilder} that gets drawn to the radar
      * @since 0.14.15.2
      */
-    void render(RenderData renderData, BufferBuilder bufferBuilder);
+    void render(boolean canRender, RenderData renderData, BufferBuilder bufferBuilder);
 
     /**
      * @return The Mod ID of the mod that registered this overlay

src/main/java/net/nullved/pmweatherapi/client/render/RadarOverlays.java

@@ -3,6 +3,7 @@
 import com.mojang.blaze3d.vertex.BufferBuilder;
 import com.mojang.blaze3d.vertex.PoseStack;
 import net.minecraft.client.renderer.MultiBufferSource;
+import net.minecraft.client.renderer.blockentity.BlockEntityRenderer;
 import net.minecraft.world.level.block.entity.BlockEntity;
 import net.nullved.pmweatherapi.PMWeatherAPI;
 
@@ -28,19 +29,13 @@ public static Set<Supplier<? extends IRadarOverlay>> getOverlays() {
 
     /**
      * Renders all overlays
-     * @param blockEntity The {@link BlockEntity} associated with the render call
-     * @param partialTicks The time, in partial ticks, since last full tick
-     * @param poseStack The {@link PoseStack}
-     * @param multiBufferSource The {@link MultiBufferSource}
-     * @param combinedLightIn The current light value on the block entity
-     * @param combinedOverlayIn The current overlay of the block entity
+     * @param canRender {@code true} if either the server doesn't require WSR-88D or a WSR-88D is complete within 4 chunks of the radar
+     * @param renderData The data used to call {@link BlockEntityRenderer#render(BlockEntity, float, PoseStack, MultiBufferSource, int, int)}
      * @param bufferBuilder The {@link BufferBuilder} to render overlays to
      * @since 0.14.15.0
      */
-    public static void renderOverlays(BlockEntity blockEntity, float partialTicks, PoseStack poseStack, MultiBufferSource multiBufferSource, int combinedLightIn, int combinedOverlayIn, BufferBuilder bufferBuilder) {
-        RenderData renderData = new RenderData(blockEntity, partialTicks, poseStack, multiBufferSource, combinedLightIn, combinedOverlayIn);
-
-        OVERLAYS.forEach(overlay -> overlay.get().render(renderData, bufferBuilder));
+    public static void renderOverlays(RenderData renderData, BufferBuilder bufferBuilder, boolean canRender) {
+        OVERLAYS.forEach(overlay -> overlay.get().render(canRender, renderData, bufferBuilder));
     }
 
     /**

src/main/java/net/nullved/pmweatherapi/event/StormEvent.java

@@ -0,0 +1,75 @@
+package net.nullved.pmweatherapi.event;
+
+import dev.protomanly.pmweather.weather.Storm;
+import net.neoforged.bus.api.Event;
+
+/**
+ * Base Storm Event
+ * @see New
+ * @see Dying
+ * @see Dead
+ * @see StageChanged
+ * @since 0.14.15.4
+ */
+public abstract class StormEvent extends Event {
+    private final Storm storm;
+
+    public StormEvent(Storm storm) {
+        this.storm = storm;
+    }
+
+    public Storm getStorm() {
+        return storm;
+    }
+
+    public long getStormID() {
+        return storm.ID;
+    }
+
+    /**
+     * Called when a new {@link Storm} is created
+     * @since 0.14.15.4
+     */
+    public static class New extends StormEvent {
+        public New(Storm storm) {
+            super(storm);
+        }
+    }
+
+    /**
+     * Called every tick a {@link Storm} is dying
+     * @since 0.14.15.4
+     */
+    public static class Dying extends StormEvent {
+        public Dying(Storm storm) {
+            super(storm);
+        }
+    }
+
+    /**
+     * Called when a {@link Storm} is dead and removed
+     * @since 0.14.15.4
+     */
+    public static class Dead extends StormEvent {
+        public Dead(Storm storm) {
+            super(storm);
+        }
+    }
+
+    /**
+     * Called when a {@link Storm}'s stage changes
+     * @since 0.14.15.4
+     */
+    public static class StageChanged extends StormEvent {
+        int newStage;
+
+        public StageChanged(Storm storm, int newStage) {
+            super(storm);
+            this.newStage = newStage;
+        }
+
+        public int getNewStage() {
+            return newStage;
+        }
+    }
+}

src/main/java/net/nullved/pmweatherapi/event/VorticyEvent.java

@@ -0,0 +1,42 @@
+package net.nullved.pmweatherapi.event;
+
+import dev.protomanly.pmweather.weather.Vorticy;
+import net.neoforged.bus.api.Event;
+
+/**
+ * Base Vorticy Event
+ * @see New
+ * @see Dead
+ * @since 0.14.15.4
+ */
+public abstract class VorticyEvent extends Event {
+    private final Vorticy vorticy;
+
+    public VorticyEvent(Vorticy vorticy) {
+        this.vorticy = vorticy;
+    }
+
+    public Vorticy getVorticy() {
+        return vorticy;
+    }
+
+    /**
+     * Called when a new {@link Vorticy} is created
+     * @since 0.14.15.4
+     */
+    public static class New extends VorticyEvent {
+        public New(Vorticy vorticy) {
+            super(vorticy);
+        }
+    }
+
+    /**
+     * Called when a {@link Vorticy} dies
+     * @since 0.14.15.4
+     */
+    public static class Dead extends VorticyEvent {
+        public Dead(Vorticy vorticy) {
+            super(vorticy);
+        }
+    }
+}

src/main/java/net/nullved/pmweatherapi/example/ExampleOverlay.java

@@ -6,6 +6,8 @@
 import net.minecraft.core.BlockPos;
 import net.minecraft.world.level.block.entity.BlockEntity;
 import net.minecraft.world.phys.Vec3;
+import net.neoforged.api.distmarker.Dist;
+import net.neoforged.api.distmarker.OnlyIn;
 import net.nullved.pmweatherapi.PMWeatherAPI;
 import net.nullved.pmweatherapi.client.render.IRadarOverlay;
 import net.nullved.pmweatherapi.client.render.RenderData;
@@ -14,13 +16,16 @@
 import org.joml.Vector3f;
 
 /**
- * This is an example overlay that draws a dot at every nearby radar's position
+ * This is an example overlay that draws a dot at every lightning strike and fades out
+ * @see IRadarOverlay
  */
+@OnlyIn(Dist.CLIENT)
 public class ExampleOverlay implements IRadarOverlay {
     public static final ExampleOverlay INSTANCE = new ExampleOverlay();
 
     @Override
-    public void render(RenderData renderData, BufferBuilder bufferBuilder) {
+    public void render(boolean canRender, RenderData renderData, BufferBuilder bufferBuilder) {
+        if (!canRender) return;
         BlockEntity blockEntity = renderData.blockEntity();
         BlockPos pos = blockEntity.getBlockPos();
         RadarBlock.Mode mode = blockEntity.getBlockState().getValue(RadarBlock.RADAR_MODE);
@@ -45,7 +50,7 @@ private static void renderMarker(BufferBuilder bufferBuilder, Vec3 relative) {
         Vector3f bottomLeft = (new Vector3f(-1.0F, 0.0F, 1.0F)).mul(0.015F).add(radarPos.x, 0.005F, radarPos.z);
         Vector3f bottomRight = (new Vector3f(1.0F, 0.0F, 1.0F)).mul(0.015F).add(radarPos.x, 0.005F, radarPos.z);
         Vector3f topRight = (new Vector3f(1.0F, 0.0F, -1.0F)).mul(0.015F).add(radarPos.x, 0.005F, radarPos.z);
-        int color = 0xFF777777;
+        int color = 0xFFAAAAAA;
         bufferBuilder.addVertex(topLeft).setColor(color).addVertex(bottomLeft).setColor(color).addVertex(bottomRight).setColor(color).addVertex(topRight).setColor(color);
     }
 }