Tag more interfaces as experimental

Ladysnake · Sep 7, 2020 · e4dd7e6 · e4dd7e6
1 parent 7888ec6
commit e4dd7e6
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/...nents-base/src/main/java/dev/onyxstudios/cca/api/v3/component/ClientTickingComponent.java b/...nents-base/src/main/java/dev/onyxstudios/cca/api/v3/component/ClientTickingComponent.java
@@ -22,11 +22,19 @@
  */
 package dev.onyxstudios.cca.api.v3.component;
 
+import net.minecraft.util.Identifier;
+import org.jetbrains.annotations.ApiStatus;
+
 /**
  * A component that gets ticked alongside the provider it is attached to.
  *
+ * <p>This interface must be visible at factory registration time - which means the class implementing it
+ * must either be the parameter to {@link ComponentRegistryV3#getOrCreate(Identifier, Class)} or declared explicitly
+ * using a dedicated method on the factory registry.
+ *
  * <p>Not every provider supports client ticking. Check individual module documentation for more information.
  */
+@ApiStatus.Experimental
 public interface ClientTickingComponent extends ComponentV3 {
     void clientTick();
 }
diff --git a/...nents-base/src/main/java/dev/onyxstudios/cca/api/v3/component/ServerTickingComponent.java b/...nents-base/src/main/java/dev/onyxstudios/cca/api/v3/component/ServerTickingComponent.java
@@ -22,9 +22,17 @@
  */
 package dev.onyxstudios.cca.api.v3.component;
 
+import net.minecraft.util.Identifier;
+import org.jetbrains.annotations.ApiStatus;
+
 /**
  * A component that gets ticked alongside the provider it is attached to.
+ *
+ * <p>This interface must be visible at factory registration time - which means the class implementing it
+ * must either be the parameter to {@link ComponentRegistryV3#getOrCreate(Identifier, Class)} or declared explicitly
+ * using a dedicated method on the factory registry.
  */
+@ApiStatus.Experimental
 public interface ServerTickingComponent extends ComponentV3 {
     void tick();
 }
diff --git a/...coreboard/src/main/java/dev/onyxstudios/cca/api/v3/scoreboard/ScoreboardSyncCallback.java b/...coreboard/src/main/java/dev/onyxstudios/cca/api/v3/scoreboard/ScoreboardSyncCallback.java
@@ -26,11 +26,13 @@
 import net.fabricmc.fabric.api.event.EventFactory;
 import net.minecraft.scoreboard.Scoreboard;
 import net.minecraft.server.network.ServerPlayerEntity;
+import org.jetbrains.annotations.ApiStatus;
 
 /**
  * The callback interface for receiving scoreboard synchronization events.
  */
 @FunctionalInterface
+@ApiStatus.Experimental
 public interface ScoreboardSyncCallback {
     Event<ScoreboardSyncCallback> EVENT = EventFactory.createArrayBacked(ScoreboardSyncCallback.class, (p, t) -> {}, listeners -> (player, scoreboard) -> {
         for (ScoreboardSyncCallback callback : listeners) {

diff --git a/...nents-scoreboard/src/main/java/dev/onyxstudios/cca/api/v3/scoreboard/TeamAddCallback.java b/...nents-scoreboard/src/main/java/dev/onyxstudios/cca/api/v3/scoreboard/TeamAddCallback.java
@@ -25,11 +25,13 @@
 import net.fabricmc.fabric.api.event.Event;
 import net.fabricmc.fabric.api.event.EventFactory;
 import net.minecraft.scoreboard.Team;
+import org.jetbrains.annotations.ApiStatus;
 
 /**
  * The callback interface for receiving global team synchronization events.
  */
 @FunctionalInterface
+@ApiStatus.Experimental
 public interface TeamAddCallback {
     Event<TeamAddCallback> EVENT = EventFactory.createArrayBacked(TeamAddCallback.class, (t) -> {}, listeners -> (team) -> {
         for (TeamAddCallback callback : listeners) {