+ * This integration allows you to use ModMenu without adding a dependency to your project. If the + * Mod is installed on the Client, and the correct ModMenu-EntryPoint is registered in your fabric.mod.json + * the screen will show up. + *
+ * You only need to subclass this class, and initialize a static Field of Type {@link ModMenuApiMarker} using + * the {@link #createEntrypoint(ModMenuIntegration)}-Method. + *
+ * Example: + *
{@code public class ModMenu extends ModMenuIntegration {
+ * public static final ModMenuApiMarker entrypointObject = createEntrypoint(new EntryPoint());
+ *
+ * public EntryPoint() {
+ * super(GridScreen::new);
+ * }
+ * }
+ * You'd also need to add the ModMenu-Entrypoint to your fabric.mod.json:
+ * "entrypoints": {
+ * ...
+ * "modmenu": [ "your.mod.ModMenu::entrypointObject" ]
+ * }
+ */
+public abstract class ModMenuIntegration {
+ /**
+ * Creates a new EntryPoint Object that is accepted by ModMenu
+ * @param target The delegate Object that will receive calls from ModMenu
+ * @return A Proxy that conforms to the ModMenu spec
+ */
+ public static ModMenuApiMarker createEntrypoint(ModMenuIntegration target) {
+ Class iModMenuAPI = null;
+ //Class iModMenuAPIMarker = null;
+ try {
+ iModMenuAPI = Class.forName("com.terraformersmc.modmenu.api.ModMenuApi");
+ //iModMenuAPIMarker = Class.forName("com.terraformersmc.modmenu.util.ModMenuApiMarker");
+ }
+ catch (ClassNotFoundException e) {
+ e.printStackTrace();
+ return (ModMenuApiMarker)new Object();
+ }
+
+ Object o = Proxy.newProxyInstance(
+ ModMenuIntegration.class.getClassLoader(),
+ new Class[] {iModMenuAPI},
+ new BCLibModMenuInvocationHandler(target));
+
+ return (ModMenuApiMarker)o;
+ }
+
+ protected final ModMenuScreenFactory screenFactory;
+
+ /**
+ * Create a new ModMenu delegate
+ * @param screenFactory A Factory. The Factory receives the currently visible {@code parent}-Screen
+ * and must return a new Screen Object.
+ */
+ public ModMenuIntegration(ModMenuScreenFactory screenFactory){
+ this.screenFactory = screenFactory;
+ }
+
+ /**
+ * A Helper class to make a BCLib-Factory conform to the ModMenu-Factory Interface.
+ * @param factory
+ * @return A ModMenu Factory for a Screen
+ */
+ final protected ModMenuScreenFactory createFactory(ModMenuScreenFactory factory){
+ return ModMenuScreenFactoryImpl.create( factory );
+ }
+
+ /**
+ * Used to construct a new config screen instance when your mod's
+ * configuration button is selected on the mod menu screen. The
+ * screen instance parameter is the active mod menu screen.
+ * (Text copied from ModMenu)
+ *
+ * @return A factory for constructing config screen instances.
+ *
+ */
+ public ModMenuScreenFactory getModConfigScreenFactory() {
+ return createFactory(screenFactory);
+ }
+
+ /**
+ * Used to provide config screen factories for other mods. This takes second
+ * priority to a mod's own config screen factory provider. For example, if
+ * mod `xyz` supplies a config screen factory, mod `abc` providing a config
+ * screen to `xyz` will be pointless, as the one provided by `xyz` will be
+ * used.
+ *
+ * This method is NOT meant to be used to add a config screen factory to
+ * your own mod.
+ * (Text copied from ModMenu)
+ *
+ * @return a map of mod ids to screen factories.
+ */
+ public Map
+ * The Interface matches {@code com.terraformersmc.modmenu.api.ConfigScreenFactory}
+ */
+ @FunctionalInterface
+ public static interface ModMenuScreenFactory {
+ Screen create(Screen parent);
+ }
+
static class BCLibModMenuInvocationHandler implements InvocationHandler {
private final ModMenuIntegration target;
@@ -68,39 +177,4 @@ public class ModMenuIntegration {
}
}
}
-
- public static final ModMenuApiMarker entrypointObject = create();
-
- public static ModMenuApiMarker create() {
- Class iModMenuAPI = null;
- //Class iModMenuAPIMarker = null;
- try {
- iModMenuAPI = Class.forName("com.terraformersmc.modmenu.api.ModMenuApi");
- //iModMenuAPIMarker = Class.forName("com.terraformersmc.modmenu.util.ModMenuApiMarker");
- }
- catch (ClassNotFoundException e) {
- e.printStackTrace();
- return (ModMenuApiMarker)new Object();
- }
-
- Object o = Proxy.newProxyInstance(
- ModMenuIntegration.class.getClassLoader(),
- new Class[] {iModMenuAPI},
- new BCLibModMenuInvocationHandler(new ModMenuIntegration()));
-
- return (ModMenuApiMarker)o;
- }
-
- IModMenuScreenFactory getModConfigScreenFactory() {
- return ModMenuScreenFactory.create( MainScreen::new );
- }
-
- Map