From e07d65807b5c908ae9be9abfa09818cd19a55870 Mon Sep 17 00:00:00 2001 From: Jozufozu Date: Fri, 3 May 2024 21:59:27 -0700 Subject: [PATCH] Final warning - Address warnings generated by javadocs and mixin remaps for joml --- .../com/jozufozu/flywheel/api/visual/LitVisual.java | 8 ++++---- .../flywheel/lib/visual/SimpleDynamicVisual.java | 2 +- .../flywheel/lib/visual/SimpleTickableVisual.java | 2 +- .../flywheel/lib/visual/component/FireComponent.java | 2 +- .../lib/visual/component/ShadowComponent.java | 2 +- .../impl/mixin/fix/FixNormalScalingMixin.java | 2 +- .../impl/visualization/VisualizationHelper.java | 8 ++++---- .../impl/visualization/VisualizationManagerImpl.java | 11 ++--------- 8 files changed, 15 insertions(+), 22 deletions(-) diff --git a/common/src/api/java/com/jozufozu/flywheel/api/visual/LitVisual.java b/common/src/api/java/com/jozufozu/flywheel/api/visual/LitVisual.java index 13b3638ab..9408c99d9 100644 --- a/common/src/api/java/com/jozufozu/flywheel/api/visual/LitVisual.java +++ b/common/src/api/java/com/jozufozu/flywheel/api/visual/LitVisual.java @@ -17,10 +17,10 @@ public interface LitVisual extends Visual { * *

Even if multiple sections are updated at the same time, this method will only be called once.

* - *

The implementation is free to parallelize calls to this method, as well as call into - * {@link DynamicVisual#beginFrame} simultaneously. It is safe to query/update light here, - * but you must ensure proper synchronization if you want to mutate anything outside this - * visual or anything that is also mutated by {@link DynamicVisual#beginFrame}.

+ *

The implementation is free to parallelize calls to this method, as well as execute the plan + * returned by {@link DynamicVisual#planFrame} simultaneously. It is safe to query/update light here, + * but you must ensure proper synchronization if you want to mutate anything outside this visual or + * anything that is also mutated within {@link DynamicVisual#planFrame}.

*/ void updateLight(); diff --git a/common/src/lib/java/com/jozufozu/flywheel/lib/visual/SimpleDynamicVisual.java b/common/src/lib/java/com/jozufozu/flywheel/lib/visual/SimpleDynamicVisual.java index 9e3220c44..1abd2749d 100644 --- a/common/src/lib/java/com/jozufozu/flywheel/lib/visual/SimpleDynamicVisual.java +++ b/common/src/lib/java/com/jozufozu/flywheel/lib/visual/SimpleDynamicVisual.java @@ -14,7 +14,7 @@ public interface SimpleDynamicVisual extends DynamicVisual { * The implementation is free to parallelize calls to this method. * You must ensure proper synchronization if you need to mutate anything outside this visual. *
- * This method and {@link TickableVisual#tick} will never be called simultaneously. + * This method and {@link SimpleTickableVisual#tick} will never be called simultaneously. *
* {@link Instancer}/{@link Instance} creation/acquisition is safe here. */ diff --git a/common/src/lib/java/com/jozufozu/flywheel/lib/visual/SimpleTickableVisual.java b/common/src/lib/java/com/jozufozu/flywheel/lib/visual/SimpleTickableVisual.java index a59881bdd..baf8246e9 100644 --- a/common/src/lib/java/com/jozufozu/flywheel/lib/visual/SimpleTickableVisual.java +++ b/common/src/lib/java/com/jozufozu/flywheel/lib/visual/SimpleTickableVisual.java @@ -15,7 +15,7 @@ public interface SimpleTickableVisual extends TickableVisual { * The implementation is free to parallelize calls to this method. * You must ensure proper synchronization if you need to mutate anything outside this visual. *
- * This method and {@link DynamicVisual#beginFrame} will never be called simultaneously. + * This method and {@link SimpleDynamicVisual#beginFrame} will never be called simultaneously. *
* {@link Instancer}/{@link Instance} creation/acquisition is safe here. */ diff --git a/common/src/lib/java/com/jozufozu/flywheel/lib/visual/component/FireComponent.java b/common/src/lib/java/com/jozufozu/flywheel/lib/visual/component/FireComponent.java index 9a11224dc..8c0f3bf0d 100644 --- a/common/src/lib/java/com/jozufozu/flywheel/lib/visual/component/FireComponent.java +++ b/common/src/lib/java/com/jozufozu/flywheel/lib/visual/component/FireComponent.java @@ -63,7 +63,7 @@ public class FireComponent implements EntityComponent { /** * Update the fire instances. You'd typically call this in your visual's - * {@link com.jozufozu.flywheel.api.visual.DynamicVisual#beginFrame(DynamicVisual.Context) beginFrame} method. + * {@link com.jozufozu.flywheel.lib.visual.SimpleDynamicVisual#beginFrame(DynamicVisual.Context) beginFrame} method. * * @param context The frame context. */ diff --git a/common/src/lib/java/com/jozufozu/flywheel/lib/visual/component/ShadowComponent.java b/common/src/lib/java/com/jozufozu/flywheel/lib/visual/component/ShadowComponent.java index 305cd1b34..45d3526ca 100644 --- a/common/src/lib/java/com/jozufozu/flywheel/lib/visual/component/ShadowComponent.java +++ b/common/src/lib/java/com/jozufozu/flywheel/lib/visual/component/ShadowComponent.java @@ -108,7 +108,7 @@ public class ShadowComponent implements EntityComponent { /** * Update the shadow instances. You'd typically call this in your visual's - * {@link com.jozufozu.flywheel.api.visual.DynamicVisual#beginFrame(DynamicVisual.Context) beginFrame} method. + * {@link com.jozufozu.flywheel.lib.visual.SimpleDynamicVisual#beginFrame(DynamicVisual.Context) beginFrame} method. * * @param context The frame context. */ diff --git a/common/src/main/java/com/jozufozu/flywheel/impl/mixin/fix/FixNormalScalingMixin.java b/common/src/main/java/com/jozufozu/flywheel/impl/mixin/fix/FixNormalScalingMixin.java index b94f596c2..36abaff18 100644 --- a/common/src/main/java/com/jozufozu/flywheel/impl/mixin/fix/FixNormalScalingMixin.java +++ b/common/src/main/java/com/jozufozu/flywheel/impl/mixin/fix/FixNormalScalingMixin.java @@ -17,7 +17,7 @@ abstract class FixNormalScalingMixin { * applied, which negates the matrix again, resulting in the matrix being the * same as in the beginning. */ - @Inject(method = "scale(FFF)V", at = @At(value = "INVOKE", target = "Lorg/joml/Matrix3f;scale(F)Lorg/joml/Matrix3f;", shift = Shift.AFTER), cancellable = true) + @Inject(method = "scale(FFF)V", at = @At(value = "INVOKE", target = "Lorg/joml/Matrix3f;scale(F)Lorg/joml/Matrix3f;", shift = Shift.AFTER, remap = false), cancellable = true) private void flywheel$returnAfterNegate(float x, float y, float z, CallbackInfo ci) { ci.cancel(); } diff --git a/common/src/main/java/com/jozufozu/flywheel/impl/visualization/VisualizationHelper.java b/common/src/main/java/com/jozufozu/flywheel/impl/visualization/VisualizationHelper.java index 439d4dcd6..b9ede2802 100644 --- a/common/src/main/java/com/jozufozu/flywheel/impl/visualization/VisualizationHelper.java +++ b/common/src/main/java/com/jozufozu/flywheel/impl/visualization/VisualizationHelper.java @@ -31,8 +31,8 @@ public final class VisualizationHelper { /** * Checks if the given block entity can be visualized. - * @param type The block entity to check. - * @param The block entity. + * @param blockEntity The block entity to check. + * @param The type of the block entity. * @return {@code true} if the block entity can be visualized. */ public static boolean canVisualize(T blockEntity) { @@ -41,8 +41,8 @@ public final class VisualizationHelper { /** * Checks if the given entity can be visualized. - * @param type The entity to check. - * @param The entity. + * @param entity The entity to check. + * @param The type of the entity. * @return {@code true} if the entity can be visualized. */ public static boolean canVisualize(T entity) { diff --git a/common/src/main/java/com/jozufozu/flywheel/impl/visualization/VisualizationManagerImpl.java b/common/src/main/java/com/jozufozu/flywheel/impl/visualization/VisualizationManagerImpl.java index 73cd1b1d6..300621739 100644 --- a/common/src/main/java/com/jozufozu/flywheel/impl/visualization/VisualizationManagerImpl.java +++ b/common/src/main/java/com/jozufozu/flywheel/impl/visualization/VisualizationManagerImpl.java @@ -210,10 +210,7 @@ public class VisualizationManagerImpl implements VisualizationManager { } /** - * Tick the visuals after the game has ticked: - *

- * Call {@link TickableVisual#tick} on all visuals in this level. - *

+ * Begin execution of the tick plan. */ public void tick() { // Make sure we're done with any prior frame or tick to avoid racing. @@ -227,11 +224,7 @@ public class VisualizationManagerImpl implements VisualizationManager { } /** - * Get ready to render a frame. - * - *

Check and update the render origin. - *
- * Call {@link DynamicVisual#beginFrame} on all visuals in this level.

+ * Begin execution of the frame plan. */ public void beginFrame(RenderContext context) { // Make sure we're done with the last tick.