Apollo Mod Status API

Author: ItsNature

.github/workflows/deploy.yml

@@ -41,7 +41,7 @@ jobs:
                 fi
 
         -   name: Gradle Publish
-            if: "${{ github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/version/') }}"
+            if: "${{ github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/version/') || github.ref == 'refs/heads/feature/mod-status' }}"
             run: ./gradlew publish
 
         -   name: Gradle Release

api/src/main/java/com/lunarclient/apollo/event/mods/ApolloUpdateModOptionEvent.java

@@ -0,0 +1,74 @@
+/*
+ * This file is part of Apollo, licensed under the MIT License.
+ *
+ * Copyright (c) 2023 Moonsworth
+ *
+ * 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 com.lunarclient.apollo.event.mods;
+
+import com.lunarclient.apollo.event.Event;
+import com.lunarclient.apollo.option.Option;
+import com.lunarclient.apollo.option.Options;
+import com.lunarclient.apollo.player.ApolloPlayer;
+import lombok.Value;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Represents an event that is fired when an option is updated.
+ *
+ * @since 1.2.1
+ */
+@Value
+public final class ApolloUpdateModOptionEvent implements Event {
+
+    // TODO: not needed?
+    /**
+     * The {@link Options} container that the option is in.
+     *
+     * @return the options container
+     * @since 1.2.1
+     */
+    Options container;
+
+    /**
+     * The {@link ApolloPlayer} that the option was updated for.
+     *
+     * @return the player
+     * @since 1.2.1
+     */
+    ApolloPlayer player;
+
+    /**
+     * The {@link Option} that was updated.
+     *
+     * @return the option
+     * @since 1.2.1
+     */
+    Option<?, ?, ?> option;
+
+    /**
+     * The new value of the option.
+     *
+     * @return the new value
+     * @since 1.2.1
+     */
+    @Nullable Object value;
+
+}

api/src/main/java/com/lunarclient/apollo/mods/ModStatus.java

@@ -0,0 +1,49 @@
+/*
+ * This file is part of Apollo, licensed under the MIT License.
+ *
+ * Copyright (c) 2023 Moonsworth
+ *
+ * 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 com.lunarclient.apollo.mods;
+
+import com.lunarclient.apollo.option.Option;
+import lombok.NonNull;
+import org.jetbrains.annotations.ApiStatus;
+
+/**
+ * Represents the current values for Lunar Client mod options.
+ *
+ * @since 1.2.1
+ */
+@ApiStatus.NonExtendable
+public interface ModStatus {
+
+    /**
+     * Gets the value of the specified {@link Option}.
+     *
+     * @param option the option
+     * @param <T>    the value type
+     * @param <C>    the option type
+     * @return the value of the option
+     * @since 1.2.1
+     */
+    public <T, C extends Option<T, ?, ?>> T get(@NonNull C option);
+
+}

api/src/main/java/com/lunarclient/apollo/mods/Mods.java

@@ -110,8 +110,12 @@
 import com.lunarclient.apollo.mods.impl.ModWeatherChanger;
 import com.lunarclient.apollo.mods.impl.ModWorldeditCui;
 import com.lunarclient.apollo.mods.impl.ModZoom;
+import com.lunarclient.apollo.option.Option;
+import java.lang.reflect.Field;
 import java.util.Arrays;
+import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
 
 /**
  * Mod container.
@@ -120,100 +124,132 @@
  */
 public final class Mods {
 
+    private static final Map<String, Option<?, ?, ?>> OPTIONS = Mods.collectModOptions();
+
     /**
      * List of all current mod classes.
      *
      * @since 1.0.0
      */
     public static final List<Class<?>> ALL_MODS = Arrays.asList(
-            ModReplaymod.class,
-            ModOneSevenVisuals.class,
-            ModFps.class,
-            ModCps.class,
-            ModSba.class,
-            ModToggleSneak.class,
-            ModZoom.class,
-            ModHypixelMod.class,
-            ModHypixelBedwars.class,
-            ModQuickplay.class,
-            ModArmorstatus.class,
-            ModKeystrokes.class,
-            ModCoordinates.class,
-            ModDayCounter.class,
-            ModCrosshair.class,
-            ModPotionEffects.class,
-            ModDirectionHud.class,
-            ModWaypoints.class,
-            ModHitColor.class,
-            ModScoreboard.class,
-            ModTitles.class,
-            ModItemCounter.class,
-            ModPing.class,
-            ModMotionBlur.class,
-            ModPackOrganizer.class,
-            ModChat.class,
-            ModTab.class,
-            ModNametag.class,
-            ModShulkerPreview.class,
-            ModScrollableTooltips.class,
-            ModUhcOverlay.class,
-            ModParticleChanger.class,
-            ModNickHider.class,
-            ModCooldowns.class,
-            ModWorldeditCui.class,
-            ModClock.class,
-            ModStopwatch.class,
-            ModPlaytime.class,
-            ModMemory.class,
-            ModCombo.class,
-            ModReachDisplay.class,
-            ModTimeChanger.class,
-            ModServerAddress.class,
-            ModSaturation.class,
-            ModColorSaturation.class,
-            ModItemPhysics.class,
-            ModTntCountdown.class,
-            ModItemTracker.class,
-            ModShinyPots.class,
-            Mod3dSkins.class,
-            ModGlintColorizer.class,
-            ModMomentum.class,
-            ModBlockOutline.class,
-            ModScreenshot.class,
-            ModFov.class,
-            ModFog.class,
-            ModAutoTextHotkey.class,
-            ModAutoTextActions.class,
-            ModMumbleLink.class,
-            ModTotemCounter.class,
-            Mod2dItems.class,
-            ModBossbar.class,
-            ModFreelook.class,
-            ModPvpInfo.class,
-            ModSnaplook.class,
-            ModTeamView.class,
-            ModPackDisplay.class,
-            ModMenuBlur.class,
-            ModMinimap.class,
-            ModHitbox.class,
-            ModLighting.class,
-            ModWeatherChanger.class,
-            ModChunkBorders.class,
-            ModSoundChanger.class,
-            ModWaila.class,
-            ModNeu.class,
-            ModHurtCam.class,
-            ModTierTagger.class,
-            ModDamageTint.class,
-            ModMobSize.class,
-            ModSkyblock.class,
-            ModHorseStats.class,
-            ModRewind.class,
-            ModAudioSubtitles.class,
-            ModKillSounds.class,
-            ModInventoryMod.class,
-            ModRadio.class
-        );
+        ModReplaymod.class,
+        ModOneSevenVisuals.class,
+        ModFps.class,
+        ModCps.class,
+        ModSba.class,
+        ModToggleSneak.class,
+        ModZoom.class,
+        ModHypixelMod.class,
+        ModHypixelBedwars.class,
+        ModQuickplay.class,
+        ModArmorstatus.class,
+        ModKeystrokes.class,
+        ModCoordinates.class,
+        ModDayCounter.class,
+        ModCrosshair.class,
+        ModPotionEffects.class,
+        ModDirectionHud.class,
+        ModWaypoints.class,
+        ModHitColor.class,
+        ModScoreboard.class,
+        ModTitles.class,
+        ModItemCounter.class,
+        ModPing.class,
+        ModMotionBlur.class,
+        ModPackOrganizer.class,
+        ModChat.class,
+        ModTab.class,
+        ModNametag.class,
+        ModShulkerPreview.class,
+        ModScrollableTooltips.class,
+        ModUhcOverlay.class,
+        ModParticleChanger.class,
+        ModNickHider.class,
+        ModCooldowns.class,
+        ModWorldeditCui.class,
+        ModClock.class,
+        ModStopwatch.class,
+        ModPlaytime.class,
+        ModMemory.class,
+        ModCombo.class,
+        ModReachDisplay.class,
+        ModTimeChanger.class,
+        ModServerAddress.class,
+        ModSaturation.class,
+        ModColorSaturation.class,
+        ModItemPhysics.class,
+        ModTntCountdown.class,
+        ModItemTracker.class,
+        ModShinyPots.class,
+        Mod3dSkins.class,
+        ModGlintColorizer.class,
+        ModMomentum.class,
+        ModBlockOutline.class,
+        ModScreenshot.class,
+        ModFov.class,
+        ModFog.class,
+        ModAutoTextHotkey.class,
+        ModAutoTextActions.class,
+        ModMumbleLink.class,
+        ModTotemCounter.class,
+        Mod2dItems.class,
+        ModBossbar.class,
+        ModFreelook.class,
+        ModPvpInfo.class,
+        ModSnaplook.class,
+        ModTeamView.class,
+        ModPackDisplay.class,
+        ModMenuBlur.class,
+        ModMinimap.class,
+        ModHitbox.class,
+        ModLighting.class,
+        ModWeatherChanger.class,
+        ModChunkBorders.class,
+        ModSoundChanger.class,
+        ModWaila.class,
+        ModNeu.class,
+        ModHurtCam.class,
+        ModTierTagger.class,
+        ModDamageTint.class,
+        ModMobSize.class,
+        ModSkyblock.class,
+        ModHorseStats.class,
+        ModRewind.class,
+        ModAudioSubtitles.class,
+        ModKillSounds.class,
+        ModInventoryMod.class,
+        ModRadio.class
+    );
+
+    /**
+     * Returns a new map containing all mod options.
+     *
+     * @return a linked hash map of mod option keys to options
+     * @since 1.2.1
+     */
+    public static Map<String, Option<?, ?, ?>> getOptions() {
+        return new LinkedHashMap<>(OPTIONS);
+    }
+
+    private static Map<String, Option<?, ?, ?>> collectModOptions() {
+        Map<String, Option<?, ?, ?>> options = new LinkedHashMap<>();
+
+        for (Class<?> mod : Mods.ALL_MODS) {
+            Field[] fields = mod.getDeclaredFields();
+
+            for (Field field : fields) {
+                try {
+                    field.setAccessible(true);
+                    Option<?, ?, ?> option = (Option<?, ?, ?>) field.get(Option.class);
+                    options.put(option.getKey(), option);
+                } catch (IllegalAccessException e) {
+                    e.printStackTrace();
+                }
+            }
+        }
+
+        return options;
+    }
 
     private Mods() {
     }

api/src/main/java/com/lunarclient/apollo/module/ApolloModule.java

@@ -120,7 +120,17 @@ protected ApolloModule() {
      * @since 1.0.0
      */
     protected void registerOptions(Option<?, ?, ?>... options) {
-        this.optionKeys.addAll(Arrays.asList(options));
+        this.registerOptions(Arrays.asList(options));
+    }
+
+    /**
+     * Registers {@link Option}s for this module.
+     *
+     * @param options the option keys
+     * @since 1.2.1
+     */
+    protected void registerOptions(Collection<Option<?, ?, ?>> options) {
+        this.optionKeys.addAll(options);
     }
 
     /**