diff options
Diffstat (limited to 'RoughlyEnoughItems-api/src/main/java')
59 files changed, 6969 insertions, 0 deletions
diff --git a/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/AutoTransferHandler.java b/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/AutoTransferHandler.java new file mode 100644 index 000000000..45341c88e --- /dev/null +++ b/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/AutoTransferHandler.java @@ -0,0 +1,304 @@ +/* + * This file is licensed under the MIT License, part of Roughly Enough Items. + * Copyright (c) 2018, 2019, 2020 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; + +import it.unimi.dsi.fastutil.ints.IntArrayList; +import it.unimi.dsi.fastutil.ints.IntList; +import net.fabricmc.api.EnvType; +import net.fabricmc.api.Environment; +import net.minecraft.client.MinecraftClient; +import net.minecraft.client.gui.screen.ingame.ContainerScreen; +import net.minecraft.container.Container; +import org.jetbrains.annotations.ApiStatus; +import org.jetbrains.annotations.NotNull; + +import java.util.function.Supplier; + +@Environment(EnvType.CLIENT) +public interface AutoTransferHandler { + + /** + * @return the priority of this handler, higher priorities will be called first. + */ + default double getPriority() { + return 0d; + } + + @NotNull + Result handle(@NotNull Context context); + + interface Result { + /** + * Creates a successful result, no further handlers will be called. + */ + static Result createSuccessful() { + return new ResultImpl(); + } + + /** + * Creates a successful result, no further handlers will be called. + * Will return to the previous screen rather than staying open. + * + * @deprecated use {@link #blocksFurtherHandling(boolean)} + */ + @Deprecated + static Result createSuccessfulReturningToScreen() { + return createSuccessful().blocksFurtherHandling(true); + } + + /** + * Creates a passing result, further handlers will be called. + * This will also mark the handler as not applicable. + */ + static Result createNotApplicable() { + return new ResultImpl(false); + } + + /** + * Creates a passing result, further handlers will be called. + * + * @param errorKey The error itself + */ + static Result createFailed(String errorKey) { + return new ResultImpl(errorKey, new IntArrayList(), 1744764928); + } + + /** + * Creates a passing result, further handlers will be called. + * The special color will be applied if this is the last handler. + * + * @param errorKey The error itself + * @param color A special color for the button + */ + static Result createFailedCustomButtonColor(String errorKey, int color) { + return new ResultImpl(errorKey, new IntArrayList(), color); + } + + /** + * Creates a passing result, further handlers will be called. + * + * @param errorKey The error itself + * @param redSlots A list of slots to be marked as red. Will be passed to {@link TransferRecipeCategory}. + */ + static Result createFailed(String errorKey, IntList redSlots) { + return new ResultImpl(errorKey, redSlots, 1744764928); + } + + /** + * Creates a passing result, further handlers will be called. + * The special color will be applied if this is the last handler. + * + * @param errorKey The error itself + * @param color A special color for the button + * @param redSlots A list of slots to be marked as red. Will be passed to {@link TransferRecipeCategory}. + */ + static Result createFailedCustomButtonColor(String errorKey, IntList redSlots, int color) { + return new ResultImpl(errorKey, redSlots, color); + } + + /** + * Forces this handler to be the last handler, no further handlers will be called. + */ + default Result blocksFurtherHandling() { + return blocksFurtherHandling(true); + } + + /** + * Forces this handler to be the last handler, no further handlers will be called. + */ + Result blocksFurtherHandling(boolean returnsToScreen); + + /** + * @return the color in which the button should be displayed in. + */ + int getColor(); + + /** + * @return whether this handler has successfully handled the transfer. + */ + boolean isSuccessful(); + + /** + * @return whether this handler should be the last handler. + */ + boolean isBlocking(); + + /** + * Applicable if {@link #isSuccessful()} is true. + * + * @return whether to return to the previous screen rather than staying open + */ + boolean isReturningToScreen(); + + /** + * @return whether the handler is applicable. + */ + boolean isApplicable(); + + /** + * Applicable if {@link #isSuccessful()} is false. + * + * @return the error message + */ + String getErrorKey(); + + /** + * @return a list of slots to be marked as red. Will be passed to {@link TransferRecipeCategory}. + */ + IntList getIntegers(); + } + + interface Context { + static Context create(boolean actuallyCrafting, ContainerScreen<?> containerScreen, RecipeDisplay recipeDisplay) { + return new ContextImpl(actuallyCrafting, containerScreen, () -> recipeDisplay); + } + + default MinecraftClient getMinecraft() { + return MinecraftClient.getInstance(); + } + + boolean isActuallyCrafting(); + + ContainerScreen<?> getContainerScreen(); + + @Deprecated + @ApiStatus.ScheduledForRemoval + default ContainerScreen<?> getHandledScreen() { + return getContainerScreen(); + } + + RecipeDisplay getRecipe(); + + @Deprecated + @ApiStatus.ScheduledForRemoval + default Container getScreenHandler() { + return getContainer(); + } + + default Container getContainer() { + return getHandledScreen().getContainer(); + } + } + + @ApiStatus.Internal + final class ResultImpl implements Result { + private boolean successful, applicable, returningToScreen, blocking; + private String errorKey; + private IntList integers = new IntArrayList(); + private int color; + + private ResultImpl() { + this(true, true); + } + + public ResultImpl(boolean applicable) { + this(false, applicable); + } + + public ResultImpl(boolean successful, boolean applicable) { + this.successful = successful; + this.applicable = applicable; + } + + public ResultImpl(String errorKey, IntList integers, int color) { + this.successful = false; + this.applicable = true; + this.errorKey = errorKey; + if (integers != null) + this.integers = integers; + this.color = color; + } + + @Override + public Result blocksFurtherHandling(boolean returningToScreen) { + this.blocking = true; + this.returningToScreen = returningToScreen; + return this; + } + + @Override + public int getColor() { + return color; + } + + @Override + public boolean isSuccessful() { + return successful; + } + + @Override + public boolean isBlocking() { + return successful || blocking; + } + + @Override + public boolean isApplicable() { + return applicable; + } + + @Override + public boolean isReturningToScreen() { + return returningToScreen; + } + + @Override + public String getErrorKey() { + return errorKey; + } + + @Override + public IntList getIntegers() { + return integers; + } + } + + @ApiStatus.Internal + final class ContextImpl implements Context { + private boolean actuallyCrafting; + private ContainerScreen<?> containerScreen; + private Supplier<RecipeDisplay> recipeDisplaySupplier; + + private ContextImpl(boolean actuallyCrafting, ContainerScreen<?> containerScreen, Supplier<RecipeDisplay> recipeDisplaySupplier) { + this.actuallyCrafting = actuallyCrafting; + this.containerScreen = containerScreen; + this.recipeDisplaySupplier = recipeDisplaySupplier; + } + + @Override + public boolean isActuallyCrafting() { + return actuallyCrafting; + } + + @Override + public ContainerScreen<?> getContainerScreen() { + return containerScreen; + } + + @Override + public RecipeDisplay getRecipe() { + return recipeDisplaySupplier.get(); + } + } + +} diff --git a/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/BaseBoundsHandler.java b/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/BaseBoundsHandler.java new file mode 100644 index 000000000..0448bc297 --- /dev/null +++ b/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/BaseBoundsHandler.java @@ -0,0 +1,62 @@ +/* + * This file is licensed under the MIT License, part of Roughly Enough Items. + * Copyright (c) 2018, 2019, 2020 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; + +import me.shedaniel.math.Rectangle; +import net.fabricmc.api.EnvType; +import net.fabricmc.api.Environment; + +import java.util.List; +import java.util.function.Supplier; + +@Environment(EnvType.CLIENT) +public interface BaseBoundsHandler extends OverlayDecider { + + static BaseBoundsHandler getInstance() { + return DisplayHelper.getInstance().getBaseBoundsHandler(); + } + + /** + * Gets the exclusion zones by the screen class + * + * @param currentScreenClass the current screen class + * @return the list of exclusion zones + */ + default List<Rectangle> getExclusionZones(Class<?> currentScreenClass) { + return getExclusionZones(currentScreenClass, false); + } + + List<Rectangle> getExclusionZones(Class<?> currentScreenClass, boolean sort); + + int supplierSize(); + + /** + * Register an exclusion zone + * + * @param screenClass the screen + * @param supplier the exclusion zone supplier, returns the list of exclusion zones + */ + void registerExclusionZones(Class<?> screenClass, Supplier<List<Rectangle>> supplier); + +} diff --git a/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/ButtonAreaSupplier.java b/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/ButtonAreaSupplier.java new file mode 100644 index 000000000..df6214642 --- /dev/null +++ b/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/ButtonAreaSupplier.java @@ -0,0 +1,50 @@ +/* + * This file is licensed under the MIT License, part of Roughly Enough Items. + * Copyright (c) 2018, 2019, 2020 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; + +import me.shedaniel.math.Rectangle; + +/** + * The supplier for the + button area. + */ +public interface ButtonAreaSupplier { + + /** + * Declares the button bounds + * + * @param bounds the bounds of the recipe display + * @return the bounds of the button + */ + Rectangle get(Rectangle bounds); + + /** + * Declares the button text + * + * @return the text of the button + */ + default String getButtonText() { + return "+"; + } + +} diff --git a/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/ClientHelper.java b/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/ClientHelper.java new file mode 100644 index 000000000..2cfcf3ff7 --- /dev/null +++ b/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/ClientHelper.java @@ -0,0 +1,249 @@ +/* + * This file is licensed under the MIT License, part of Roughly Enough Items. + * Copyright (c) 2018, 2019, 2020 shedaniel + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and |