From bed56b9a49c4232c1b0c7f96914f8624c31784e4 Mon Sep 17 00:00:00 2001 From: Hydrox6 Date: Tue, 28 Jan 2020 21:00:22 +0000 Subject: [PATCH] plugins: add units to configs --- .../java/net/runelite/client/config/RuneLiteConfig.java | 3 ++- .../net/runelite/client/plugins/agility/AgilityConfig.java | 4 +++- .../net/runelite/client/plugins/cooking/CookingConfig.java | 4 +++- .../net/runelite/client/plugins/discord/DiscordConfig.java | 4 +++- .../client/plugins/experiencedrop/XpDropConfig.java | 2 ++ .../net/runelite/client/plugins/fishing/FishingConfig.java | 4 +++- .../client/plugins/grounditems/GroundItemsConfig.java | 2 ++ .../client/plugins/idlenotifier/IdleNotifierConfig.java | 6 +++++- .../client/plugins/motherlode/MotherlodeConfig.java | 4 +++- .../client/plugins/regenmeter/RegenMeterConfig.java | 4 +++- .../net/runelite/client/plugins/slayer/SlayerConfig.java | 4 +++- .../runelite/client/plugins/smelting/SmeltingConfig.java | 4 +++- .../client/plugins/stretchedmode/StretchedModeConfig.java | 4 +++- .../client/plugins/timetracking/TimeTrackingConfig.java | 4 +++- .../client/plugins/wintertodt/WintertodtConfig.java | 2 ++ .../client/plugins/woodcutting/WoodcuttingConfig.java | 4 +++- .../runelite/client/plugins/xpglobes/XpGlobesConfig.java | 4 ++++ .../runelite/client/plugins/xptracker/XpTrackerConfig.java | 2 ++ 18 files changed, 52 insertions(+), 13 deletions(-) diff --git a/runelite-client/src/main/java/net/runelite/client/config/RuneLiteConfig.java b/runelite-client/src/main/java/net/runelite/client/config/RuneLiteConfig.java index 839b8eff30..42198a248e 100644 --- a/runelite-client/src/main/java/net/runelite/client/config/RuneLiteConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/config/RuneLiteConfig.java @@ -268,10 +268,11 @@ public interface RuneLiteConfig extends Config @ConfigItem( keyName = "infoBoxSize", - name = "Infobox size (px)", + name = "Infobox size", description = "Configures the size of each infobox in pixels", position = 42 ) + @Units(Units.PIXELS) default int infoBoxSize() { return 35; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/agility/AgilityConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/agility/AgilityConfig.java index ea608764ae..9c3fca73ad 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/agility/AgilityConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/agility/AgilityConfig.java @@ -28,6 +28,7 @@ import java.awt.Color; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("agility") public interface AgilityConfig extends Config @@ -56,10 +57,11 @@ public interface AgilityConfig extends Config @ConfigItem( keyName = "lapTimeout", - name = "Hide Lap Count (minutes)", + name = "Hide Lap Count", description = "Time until the lap counter hides/resets", position = 2 ) + @Units(Units.MINUTES) default int lapTimeout() { return 5; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/cooking/CookingConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/cooking/CookingConfig.java index 2a12ac1ede..a1281a8e89 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/cooking/CookingConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/cooking/CookingConfig.java @@ -28,6 +28,7 @@ package net.runelite.client.plugins.cooking; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("cooking") public interface CookingConfig extends Config @@ -35,9 +36,10 @@ public interface CookingConfig extends Config @ConfigItem( position = 1, keyName = "statTimeout", - name = "Reset stats (minutes)", + name = "Reset stats", description = "Configures the time until the session resets and the overlay is hidden (0 = Disable feature)" ) + @Units(Units.MINUTES) default int statTimeout() { return 5; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/discord/DiscordConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/discord/DiscordConfig.java index de79193a43..682d8c472c 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/discord/DiscordConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/discord/DiscordConfig.java @@ -27,16 +27,18 @@ package net.runelite.client.plugins.discord; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("discord") public interface DiscordConfig extends Config { @ConfigItem( keyName = "actionTimeout", - name = "Action timeout (minutes)", + name = "Action timeout", description = "Configures after how long of not updating status will be reset (in minutes)", position = 1 ) + @Units(Units.MINUTES) default int actionTimeout() { return 5; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/experiencedrop/XpDropConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/experiencedrop/XpDropConfig.java index ec1f1acc45..568a656ae2 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/experiencedrop/XpDropConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/experiencedrop/XpDropConfig.java @@ -28,6 +28,7 @@ import java.awt.Color; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("xpdrop") public interface XpDropConfig extends Config @@ -82,6 +83,7 @@ public interface XpDropConfig extends Config description = "Configures how many ticks should pass between fake XP drops, 0 to disable", position = 4 ) + @Units(Units.TICKS) default int fakeXpDropDelay() { return 0; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/fishing/FishingConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/fishing/FishingConfig.java index 5ccee0e752..4c9153f42a 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/fishing/FishingConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/fishing/FishingConfig.java @@ -28,6 +28,7 @@ import java.awt.Color; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("fishing") public interface FishingConfig extends Config @@ -112,9 +113,10 @@ public interface FishingConfig extends Config @ConfigItem( position = 7, keyName = "statTimeout", - name = "Reset stats (minutes)", + name = "Reset stats", description = "The time until fishing session data is reset in minutes." ) + @Units(Units.MINUTES) default int statTimeout() { return 5; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/grounditems/GroundItemsConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/grounditems/GroundItemsConfig.java index 41cc1afa7f..f8752f0d6b 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/grounditems/GroundItemsConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/grounditems/GroundItemsConfig.java @@ -29,6 +29,7 @@ import java.awt.Color; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; import net.runelite.client.plugins.grounditems.config.ItemHighlightMode; import net.runelite.client.plugins.grounditems.config.MenuHighlightMode; import net.runelite.client.plugins.grounditems.config.PriceDisplayMode; @@ -343,6 +344,7 @@ public interface GroundItemsConfig extends Config description = "Decrease this number if you accidentally hide ground items often. (0 = Disabled)", position = 26 ) + @Units(Units.MILLISECONDS) default int doubleTapDelay() { return 250; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/idlenotifier/IdleNotifierConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/idlenotifier/IdleNotifierConfig.java index 200d00da4f..564cbb609b 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/idlenotifier/IdleNotifierConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/idlenotifier/IdleNotifierConfig.java @@ -27,6 +27,7 @@ package net.runelite.client.plugins.idlenotifier; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("idlenotifier") public interface IdleNotifierConfig extends Config @@ -77,10 +78,11 @@ public interface IdleNotifierConfig extends Config @ConfigItem( keyName = "timeout", - name = "Idle Notification Delay (ms)", + name = "Idle Notification Delay", description = "The notification delay after the player is idle", position = 5 ) + @Units(Units.MILLISECONDS) default int getIdleNotificationDelay() { return 5000; @@ -114,6 +116,7 @@ public interface IdleNotifierConfig extends Config position = 8, description = "The amount of remaining oxygen to send a notification at. A value of 0 will disable notification." ) + @Units(Units.PERCENT) default int getOxygenThreshold() { return 0; @@ -125,6 +128,7 @@ public interface IdleNotifierConfig extends Config position = 9, description = "The amount of spec energy reached to send a notification at. A value of 0 will disable notification." ) + @Units(Units.PERCENT) default int getSpecEnergyThreshold() { return 0; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/motherlode/MotherlodeConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/motherlode/MotherlodeConfig.java index 10d41810e4..a32ec18c0f 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/motherlode/MotherlodeConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/motherlode/MotherlodeConfig.java @@ -28,6 +28,7 @@ package net.runelite.client.plugins.motherlode; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("motherlode") public interface MotherlodeConfig extends Config @@ -54,9 +55,10 @@ public interface MotherlodeConfig extends Config @ConfigItem( keyName = "statTimeout", - name = "Reset stats (minutes)", + name = "Reset stats", description = "Configures the time until statistics are reset" ) + @Units(Units.MINUTES) default int statTimeout() { return 5; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/regenmeter/RegenMeterConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/regenmeter/RegenMeterConfig.java index 2e8b577381..a206557fcb 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/regenmeter/RegenMeterConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/regenmeter/RegenMeterConfig.java @@ -27,6 +27,7 @@ package net.runelite.client.plugins.regenmeter; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("regenmeter") public interface RegenMeterConfig extends Config @@ -60,9 +61,10 @@ public interface RegenMeterConfig extends Config @ConfigItem( keyName = "notifyBeforeHpRegenDuration", - name = "Hitpoint Regen Notification (seconds)", + name = "Hitpoint Regen Notification", description = "Notify approximately when your next hitpoint is about to regen. A value of 0 will disable notification." ) + @Units(Units.SECONDS) default int getNotifyBeforeHpRegenSeconds() { return 0; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/slayer/SlayerConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/slayer/SlayerConfig.java index 47aa58a1ab..3abe33b392 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/slayer/SlayerConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/slayer/SlayerConfig.java @@ -29,6 +29,7 @@ import java.awt.Color; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("slayer") public interface SlayerConfig extends Config @@ -69,9 +70,10 @@ public interface SlayerConfig extends Config @ConfigItem( position = 4, keyName = "statTimeout", - name = "InfoBox Expiry (minutes)", + name = "InfoBox Expiry", description = "Set the time until the InfoBox expires" ) + @Units(Units.MINUTES) default int statTimeout() { return 5; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/smelting/SmeltingConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/smelting/SmeltingConfig.java index 9671f29e1a..8a0004a06e 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/smelting/SmeltingConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/smelting/SmeltingConfig.java @@ -27,6 +27,7 @@ package net.runelite.client.plugins.smelting; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("smelting") public interface SmeltingConfig extends Config @@ -34,9 +35,10 @@ public interface SmeltingConfig extends Config @ConfigItem( position = 1, keyName = "statTimeout", - name = "Reset stats (minutes)", + name = "Reset stats", description = "The time it takes for the current smelting session to be reset" ) + @Units(Units.MINUTES) default int statTimeout() { return 5; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/stretchedmode/StretchedModeConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/stretchedmode/StretchedModeConfig.java index fc79768cf2..3e3433d33b 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/stretchedmode/StretchedModeConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/stretchedmode/StretchedModeConfig.java @@ -28,6 +28,7 @@ package net.runelite.client.plugins.stretchedmode; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("stretchedmode") public interface StretchedModeConfig extends Config @@ -64,9 +65,10 @@ public interface StretchedModeConfig extends Config @ConfigItem( keyName = "scalingFactor", - name = "Resizable Scaling (%)", + name = "Resizable Scaling", description = "In resizable mode, the game is reduced in size this much before it's stretched." ) + @Units(Units.PERCENT) default int scalingFactor() { return 50; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/timetracking/TimeTrackingConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/timetracking/TimeTrackingConfig.java index 056217673f..099c7a8f70 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/timetracking/TimeTrackingConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/timetracking/TimeTrackingConfig.java @@ -27,6 +27,7 @@ package net.runelite.client.plugins.timetracking; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("timetracking") public interface TimeTrackingConfig extends Config @@ -72,10 +73,11 @@ public interface TimeTrackingConfig extends Config @ConfigItem( keyName = "defaultTimerMinutes", - name = "Default Time (Minutes)", + name = "Default Time", description = "The default time for the timer in minutes", position = 4 ) + @Units(Units.MINUTES) default int defaultTimerMinutes() { return 5; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/wintertodt/WintertodtConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/wintertodt/WintertodtConfig.java index 6b1adb7e9d..65a26893bc 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/wintertodt/WintertodtConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/wintertodt/WintertodtConfig.java @@ -30,6 +30,7 @@ import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; import net.runelite.client.config.Range; +import net.runelite.client.config.Units; import net.runelite.client.plugins.wintertodt.config.WintertodtNotifyMode; @ConfigGroup("wintertodt") @@ -66,6 +67,7 @@ public interface WintertodtConfig extends Config @Range( max = 60 ) + @Units(Units.SECONDS) default int roundNotification() { return 5; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/WoodcuttingConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/WoodcuttingConfig.java index 7f992744c6..9385d4d9da 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/WoodcuttingConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/WoodcuttingConfig.java @@ -27,6 +27,7 @@ package net.runelite.client.plugins.woodcutting; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("woodcutting") public interface WoodcuttingConfig extends Config @@ -34,9 +35,10 @@ public interface WoodcuttingConfig extends Config @ConfigItem( position = 1, keyName = "statTimeout", - name = "Reset stats (minutes)", + name = "Reset stats", description = "Configures the time until statistic is reset. Also configures when tree indicator is hidden" ) + @Units(Units.MINUTES) default int statTimeout() { return 5; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/xpglobes/XpGlobesConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/xpglobes/XpGlobesConfig.java index 8e5f08b03b..dd5773044a 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/xpglobes/XpGlobesConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/xpglobes/XpGlobesConfig.java @@ -29,6 +29,7 @@ import net.runelite.client.config.Alpha; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("xpglobes") public interface XpGlobesConfig extends Config @@ -141,6 +142,7 @@ public interface XpGlobesConfig extends Config description = "Change the stroke width of the progress arc", position = 9 ) + @Units(Units.PIXELS) default int progressArcStrokeWidth() { return 2; @@ -152,6 +154,7 @@ public interface XpGlobesConfig extends Config description = "Change the size of the xp orbs", position = 10 ) + @Units(Units.PIXELS) default int xpOrbSize() { return 40; @@ -163,6 +166,7 @@ public interface XpGlobesConfig extends Config description = "Change the duration the xp orbs are visible", position = 11 ) + @Units(Units.SECONDS) default int xpOrbDuration() { return 10; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/xptracker/XpTrackerConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/xptracker/XpTrackerConfig.java index 9f4cedef32..7a4ccf8406 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/xptracker/XpTrackerConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/xptracker/XpTrackerConfig.java @@ -28,6 +28,7 @@ import lombok.AllArgsConstructor; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; import net.runelite.client.config.ConfigItem; +import net.runelite.client.config.Units; @ConfigGroup("xpTracker") public interface XpTrackerConfig extends Config @@ -87,6 +88,7 @@ public interface XpTrackerConfig extends Config name = "Auto pause after", description = "Configures how many minutes passes before pausing a skill while in game and there's no XP, 0 means disabled" ) + @Units(Units.MINUTES) default int pauseSkillAfter() { return 0;