forked from shedaniel/RoughlyEnoughItems
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement Config Addons, Close shedaniel#908
- Loading branch information
Showing
11 changed files
with
485 additions
and
1 deletion.
There are no files selected for viewing
59 changes: 59 additions & 0 deletions
59
api/src/main/java/me/shedaniel/rei/api/client/config/addon/ConfigAddon.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| /* | ||
| * This file is licensed under the MIT License, part of Roughly Enough Items. | ||
| * Copyright (c) 2018, 2019, 2020, 2021, 2022 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.config.addon; | ||
|
|
||
| import net.minecraft.client.gui.screens.Screen; | ||
| import net.minecraft.network.chat.Component; | ||
| import org.jetbrains.annotations.ApiStatus; | ||
|
|
||
| /** | ||
| * A config addon, which will be shown in the REI config screen. | ||
| * | ||
| * @since 8.3 | ||
| */ | ||
| @ApiStatus.Experimental | ||
| public interface ConfigAddon { | ||
| /** | ||
| * Returns the name of the addon, this will be shown in the addons list. | ||
| * | ||
| * @return the name of the addon | ||
| */ | ||
| Component getName(); | ||
|
|
||
| /** | ||
| * Returns the description of the addon, this will be shown in the addons list. | ||
| * | ||
| * @return the description of the addon | ||
| */ | ||
| Component getDescription(); | ||
|
|
||
| /** | ||
| * Opens the config screen for this addon, given the parent screen. | ||
| * Do not call {@link net.minecraft.client.Minecraft#setScreen(Screen)} directly, | ||
| * and make sure to set the screen as the parent screen to exit the config screen. | ||
| * | ||
| * @param parent the parent screen | ||
| */ | ||
| Screen createScreen(Screen parent); | ||
| } |
56 changes: 56 additions & 0 deletions
56
api/src/main/java/me/shedaniel/rei/api/client/config/addon/ConfigAddonRegistry.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| /* | ||
| * This file is licensed under the MIT License, part of Roughly Enough Items. | ||
| * Copyright (c) 2018, 2019, 2020, 2021, 2022 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.config.addon; | ||
|
|
||
| import me.shedaniel.rei.api.client.plugins.REIClientPlugin; | ||
| import me.shedaniel.rei.api.common.plugins.PluginManager; | ||
| import me.shedaniel.rei.api.common.registry.Reloadable; | ||
| import org.jetbrains.annotations.ApiStatus; | ||
|
|
||
| /** | ||
| * Registry for {@link ConfigAddon}s. | ||
| * Registered config addons will show up at the top of the config screen, | ||
| * and allow users to search and configure them easily. | ||
| * <p> | ||
| * REI does not provide serialization for config addons, | ||
| * that is up to the developer to implement. | ||
| * | ||
| * @since 8.3 | ||
| */ | ||
| @ApiStatus.Experimental | ||
| public interface ConfigAddonRegistry extends Reloadable<REIClientPlugin> { | ||
| /** | ||
| * @return the {@link PluginManager} instance | ||
| */ | ||
| static ConfigAddonRegistry getInstance() { | ||
| return PluginManager.getClientInstance().get(ConfigAddonRegistry.class); | ||
| } | ||
|
|
||
| /** | ||
| * Registers a config addon. The addons displayed will be sorted by their name alphabetically. | ||
| * | ||
| * @param addon the addon to register | ||
| */ | ||
| void register(ConfigAddon addon); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
runtime/src/main/java/me/shedaniel/rei/impl/client/config/addon/ConfigAddonRegistryImpl.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /* | ||
| * This file is licensed under the MIT License, part of Roughly Enough Items. | ||
| * Copyright (c) 2018, 2019, 2020, 2021, 2022 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.impl.client.config.addon; | ||
|
|
||
| import me.shedaniel.rei.api.client.config.addon.ConfigAddon; | ||
| import me.shedaniel.rei.api.client.config.addon.ConfigAddonRegistry; | ||
| import me.shedaniel.rei.api.client.plugins.REIClientPlugin; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| public class ConfigAddonRegistryImpl implements ConfigAddonRegistry { | ||
| private final List<ConfigAddon> addons = new ArrayList<>(); | ||
|
|
||
| @Override | ||
| public void startReload() { | ||
| this.addons.clear(); | ||
| } | ||
|
|
||
| @Override | ||
| public void register(ConfigAddon addon) { | ||
| this.addons.add(addon); | ||
| } | ||
|
|
||
| @Override | ||
| public void acceptPlugin(REIClientPlugin plugin) { | ||
| plugin.registerConfigAddons(this); | ||
| } | ||
|
|
||
| public List<ConfigAddon> getAddons() { | ||
| return this.addons; | ||
| } | ||
| } |
Oops, something went wrong.