Introduce System Favorites

2 files changed, 42 insertions, 1 deletions

diff --git a/api/src/main/java/me/shedaniel/rei/api/client/favorites/FavoriteEntryType.java b/api/src/main/java/me/shedaniel/rei/api/client/favorites/FavoriteEntryType.java
index 7c60253b9..a317787fc 100644
--- a/api/src/main/java/me/shedaniel/rei/api/client/favorites/FavoriteEntryType.java
+++ b/api/src/main/java/me/shedaniel/rei/api/client/favorites/FavoriteEntryType.java
@@ -76,7 +76,8 @@ public interface FavoriteEntryType<T extends FavoriteEntry> {
     interface Registry extends Reloadable<REIClientPlugin> {
         void register(ResourceLocation id, FavoriteEntryType<?> type);
         
-        @Nullable <A extends FavoriteEntry> FavoriteEntryType<A> get(ResourceLocation id);
+        @Nullable
+        <A extends FavoriteEntry> FavoriteEntryType<A> get(ResourceLocation id);
         
         @Nullable
         ResourceLocation getId(FavoriteEntryType<?> type);
@@ -84,6 +85,8 @@ public interface FavoriteEntryType<T extends FavoriteEntry> {
         Section getOrCrateSection(Component text);
         
         Iterable<Section> sections();
+        
+        <A extends FavoriteEntry> void registerSystemFavorites(SystemFavoriteEntryProvider<A> provider);
     }
     
     @ApiStatus.NonExtendable
diff --git a/api/src/main/java/me/shedaniel/rei/api/client/favorites/SystemFavoriteEntryProvider.java b/api/src/main/java/me/shedaniel/rei/api/client/favorites/SystemFavoriteEntryProvider.java
new file mode 100644
index 000000000..c5249d616
--- /dev/null
+++ b/api/src/main/java/me/shedaniel/rei/api/client/favorites/SystemFavoriteEntryProvider.java
@@ -0,0 +1,38 @@
+/*
+ * This file is licensed under the MIT License, part of Roughly Enough Items.
+ * Copyright (c) 2018, 2019, 2020, 2021 shedaniel
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package me.shedaniel.rei.api.client.favorites;
+
+import org.jetbrains.annotations.ApiStatus;
+
+import java.util.List;
+
+@FunctionalInterface
+@ApiStatus.Experimental
+public interface SystemFavoriteEntryProvider<T extends FavoriteEntry> {
+    List<T> provide();
+    
+    default long updateInterval() {
+        return 250;
+    }
+}