A ticking time bomb

- Add context object back to SimpleTickableVisual#tick
- Document base *Visual plan methods

common/src/api/java/com/jozufozu/flywheel/api/visual/DynamicVisual.java

@@ -3,6 +3,8 @@ package com.jozufozu.flywheel.api.visual;
 import org.jetbrains.annotations.ApiStatus;
 import org.joml.FrustumIntersection;
 
+import com.jozufozu.flywheel.api.instance.Instance;
+import com.jozufozu.flywheel.api.instance.Instancer;
 import com.jozufozu.flywheel.api.task.Plan;
 
 import net.minecraft.client.Camera;
@@ -14,6 +16,16 @@ import net.minecraft.client.Camera;
  * parameterization.
  */
 public interface DynamicVisual extends Visual {
+	/**
+	 * Invoked every frame.
+	 * <br>
+	 * The implementation is free to parallelize the invocation of this plan.
+	 * You must ensure proper synchronization if you need to mutate anything outside this visual.
+	 * <br>
+	 * This plan and the one returned by {@link TickableVisual#planTick} will never be invoked simultaneously.
+	 * <br>
+	 * {@link Instancer}/{@link Instance} creation/acquisition is safe here.
+	 */
 	Plan<Context> planFrame();
 
 	/**

common/src/api/java/com/jozufozu/flywheel/api/visual/TickableVisual.java

@@ -2,6 +2,8 @@ package com.jozufozu.flywheel.api.visual;
 
 import org.jetbrains.annotations.ApiStatus;
 
+import com.jozufozu.flywheel.api.instance.Instance;
+import com.jozufozu.flywheel.api.instance.Instancer;
 import com.jozufozu.flywheel.api.task.Plan;
 
 /**
@@ -9,6 +11,16 @@ import com.jozufozu.flywheel.api.task.Plan;
  * the end of every tick.
  */
 public interface TickableVisual extends Visual {
+	/**
+	 * Invoked every tick.
+	 * <br>
+	 * The implementation is free to parallelize the invocation of this plan.
+	 * You must ensure proper synchronization if you need to mutate anything outside this visual.
+	 * <br>
+	 * This plan and the one returned by {@link DynamicVisual#planFrame} will never be invoked simultaneously.
+	 * <br>
+	 * {@link Instancer}/{@link Instance} creation/acquisition is safe here.
+	 */
 	Plan<Context> planTick();
 
 	/**

common/src/lib/java/com/jozufozu/flywheel/lib/visual/SimpleTickableVisual.java

@@ -18,7 +18,7 @@ public interface SimpleTickableVisual extends TickableVisual {
 	 * <br>
 	 * {@link Instancer}/{@link Instance} creation/acquisition is safe here.
 	 */
-	void tick();
+	void tick(Context context);
 
 	@Override
 	default Plan<Context> planTick() {

common/src/main/java/com/jozufozu/flywheel/vanilla/MinecartVisual.java

@@ -3,6 +3,7 @@ package com.jozufozu.flywheel.vanilla;
 import org.jetbrains.annotations.Nullable;
 
 import com.jozufozu.flywheel.api.visual.DynamicVisual;
+import com.jozufozu.flywheel.api.visual.TickableVisual;
 import com.jozufozu.flywheel.api.visualization.VisualizationContext;
 import com.jozufozu.flywheel.lib.instance.InstanceTypes;
 import com.jozufozu.flywheel.lib.instance.TransformedInstance;
@@ -99,7 +100,7 @@ public class MinecartVisual<T extends AbstractMinecart> extends SimpleEntityVisu
 	}
 
 	@Override
-	public void tick() {
+	public void tick(TickableVisual.Context context) {
 		BlockState displayBlockState = entity.getDisplayBlockState();
 
 		if (displayBlockState != blockState) {