From b9b8b52fffcc506100ece907bb493c864588aae7 Mon Sep 17 00:00:00 2001 From: SoyChai Date: Sun, 8 Apr 2018 14:00:41 +1000 Subject: [PATCH 1/3] attackstyles: Rename Attack Indicators plugin to Attack Styles --- .../AttackStyle.java | 2 +- .../AttackStylesConfig.java} | 8 +++---- .../AttackStylesOverlay.java} | 8 +++---- .../AttackStylesPlugin.java} | 22 +++++++++---------- .../WeaponType.java | 4 ++-- .../AttackStylesPluginTest.java} | 10 ++++----- 6 files changed, 27 insertions(+), 27 deletions(-) rename runelite-client/src/main/java/net/runelite/client/plugins/{attackindicator => attackstyles}/AttackStyle.java (97%) rename runelite-client/src/main/java/net/runelite/client/plugins/{attackindicator/AttackIndicatorConfig.java => attackstyles/AttackStylesConfig.java} (93%) rename runelite-client/src/main/java/net/runelite/client/plugins/{attackindicator/AttackIndicatorOverlay.java => attackstyles/AttackStylesOverlay.java} (91%) rename runelite-client/src/main/java/net/runelite/client/plugins/{attackindicator/AttackIndicatorPlugin.java => attackstyles/AttackStylesPlugin.java} (94%) rename runelite-client/src/main/java/net/runelite/client/plugins/{attackindicator => attackstyles}/WeaponType.java (96%) rename runelite-client/src/test/java/net/runelite/client/plugins/{attackindicator/AttackIndicatorPluginTest.java => attackstyles/AttackStylesPluginTest.java} (97%) diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/AttackStyle.java b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStyle.java similarity index 97% rename from runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/AttackStyle.java rename to runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStyle.java index 7f867ed051..c32ba11af3 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/AttackStyle.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStyle.java @@ -22,7 +22,7 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -package net.runelite.client.plugins.attackindicator; +package net.runelite.client.plugins.attackstyles; import net.runelite.api.Skill; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/AttackIndicatorConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesConfig.java similarity index 93% rename from runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/AttackIndicatorConfig.java rename to runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesConfig.java index 0e65a1d9f4..faa1b9ac6f 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/AttackIndicatorConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesConfig.java @@ -22,7 +22,7 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -package net.runelite.client.plugins.attackindicator; +package net.runelite.client.plugins.attackstyles; import net.runelite.client.config.Config; import net.runelite.client.config.ConfigGroup; @@ -30,10 +30,10 @@ import net.runelite.client.config.ConfigItem; @ConfigGroup( keyName = "attackIndicator", - name = "Attack Indicators", - description = "Configuration for the attack indicator plugin" + name = "Attack Styles", + description = "Configuration for the attack styles plugin" ) -public interface AttackIndicatorConfig extends Config +public interface AttackStylesConfig extends Config { @ConfigItem( keyName = "warnForDefensive", diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/AttackIndicatorOverlay.java b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesOverlay.java similarity index 91% rename from runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/AttackIndicatorOverlay.java rename to runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesOverlay.java index 3a3752c744..d75c7927fc 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/AttackIndicatorOverlay.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesOverlay.java @@ -22,7 +22,7 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -package net.runelite.client.plugins.attackindicator; +package net.runelite.client.plugins.attackstyles; import java.awt.Color; import java.awt.Dimension; @@ -32,15 +32,15 @@ import net.runelite.client.ui.overlay.Overlay; import net.runelite.client.ui.overlay.OverlayPosition; import net.runelite.client.ui.overlay.components.PanelComponent; -public class AttackIndicatorOverlay extends Overlay +public class AttackStylesOverlay extends Overlay { private static final int COMPONENT_WIDTH = 80; - private final AttackIndicatorPlugin plugin; + private final AttackStylesPlugin plugin; private final PanelComponent panelComponent = new PanelComponent(); @Inject - public AttackIndicatorOverlay(AttackIndicatorPlugin plugin) + public AttackStylesOverlay(AttackStylesPlugin plugin) { setPosition(OverlayPosition.ABOVE_CHATBOX_RIGHT); this.plugin = plugin; diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/AttackIndicatorPlugin.java b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesPlugin.java similarity index 94% rename from runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/AttackIndicatorPlugin.java rename to runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesPlugin.java index aa2f564741..6f0db7508a 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/AttackIndicatorPlugin.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesPlugin.java @@ -22,7 +22,7 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -package net.runelite.client.plugins.attackindicator; +package net.runelite.client.plugins.attackstyles; import com.google.common.annotations.VisibleForTesting; import com.google.common.collect.HashBasedTable; @@ -49,15 +49,15 @@ import static net.runelite.api.widgets.WidgetInfo.TO_GROUP; import net.runelite.client.config.ConfigManager; import net.runelite.client.plugins.Plugin; import net.runelite.client.plugins.PluginDescriptor; -import static net.runelite.client.plugins.attackindicator.AttackStyle.CASTING; -import static net.runelite.client.plugins.attackindicator.AttackStyle.DEFENSIVE_CASTING; -import static net.runelite.client.plugins.attackindicator.AttackStyle.OTHER; +import static net.runelite.client.plugins.attackstyles.AttackStyle.CASTING; +import static net.runelite.client.plugins.attackstyles.AttackStyle.DEFENSIVE_CASTING; +import static net.runelite.client.plugins.attackstyles.AttackStyle.OTHER; @PluginDescriptor( - name = "Attack Indicators" + name = "Attack Styles" ) @Slf4j -public class AttackIndicatorPlugin extends Plugin +public class AttackStylesPlugin extends Plugin { private int attackStyleVarbit = -1; private int equippedWeaponTypeVarbit = -1; @@ -71,19 +71,19 @@ public class AttackIndicatorPlugin extends Plugin private Client client; @Inject - private AttackIndicatorConfig config; + private AttackStylesConfig config; @Inject - private AttackIndicatorOverlay overlay; + private AttackStylesOverlay overlay; @Provides - AttackIndicatorConfig provideConfig(ConfigManager configManager) + AttackStylesConfig provideConfig(ConfigManager configManager) { - return configManager.getConfig(AttackIndicatorConfig.class); + return configManager.getConfig(AttackStylesConfig.class); } @Override - public AttackIndicatorOverlay getOverlay() + public AttackStylesOverlay getOverlay() { return overlay; } diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/WeaponType.java b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/WeaponType.java similarity index 96% rename from runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/WeaponType.java rename to runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/WeaponType.java index b6975b0dff..19369104f3 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/attackindicator/WeaponType.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/WeaponType.java @@ -22,11 +22,11 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -package net.runelite.client.plugins.attackindicator; +package net.runelite.client.plugins.attackstyles; import java.util.HashMap; import java.util.Map; -import static net.runelite.client.plugins.attackindicator.AttackStyle.*; +import static net.runelite.client.plugins.attackstyles.AttackStyle.*; public enum WeaponType { diff --git a/runelite-client/src/test/java/net/runelite/client/plugins/attackindicator/AttackIndicatorPluginTest.java b/runelite-client/src/test/java/net/runelite/client/plugins/attackstyles/AttackStylesPluginTest.java similarity index 97% rename from runelite-client/src/test/java/net/runelite/client/plugins/attackindicator/AttackIndicatorPluginTest.java rename to runelite-client/src/test/java/net/runelite/client/plugins/attackstyles/AttackStylesPluginTest.java index f85e89a37a..73e295f32b 100644 --- a/runelite-client/src/test/java/net/runelite/client/plugins/attackindicator/AttackIndicatorPluginTest.java +++ b/runelite-client/src/test/java/net/runelite/client/plugins/attackstyles/AttackStylesPluginTest.java @@ -22,7 +22,7 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -package net.runelite.client.plugins.attackindicator; +package net.runelite.client.plugins.attackstyles; import com.google.inject.Guice; import com.google.inject.testing.fieldbinder.Bind; @@ -48,7 +48,7 @@ import static org.mockito.Mockito.when; import org.mockito.runners.MockitoJUnitRunner; @RunWith(MockitoJUnitRunner.class) -public class AttackIndicatorPluginTest +public class AttackStylesPluginTest { @Mock @Bind @@ -56,10 +56,10 @@ public class AttackIndicatorPluginTest @Mock @Bind - AttackIndicatorConfig attackConfig; + AttackStylesConfig attackConfig; @Inject - AttackIndicatorPlugin attackPlugin; + AttackStylesPlugin attackPlugin; @Before public void before() @@ -102,7 +102,7 @@ public class AttackIndicatorPluginTest } /* - * Verify that attack style widgets are hidden when filtered with the AttackIndicatorPlugin. + * Verify that attack style widgets are hidden when filtered with the AttackStylesPlugin. */ @Test public void testHiddenWidget() From 972cca410bd3342741678659f7a10e86d2054432 Mon Sep 17 00:00:00 2001 From: SoyChai Date: Mon, 9 Apr 2018 11:48:43 +1000 Subject: [PATCH 2/3] attackstyles: Add a toggle to Always show style --- .../attackstyles/AttackStylesConfig.java | 11 ++++++++++ .../attackstyles/AttackStylesOverlay.java | 21 +++++++++++++------ 2 files changed, 26 insertions(+), 6 deletions(-) diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesConfig.java index faa1b9ac6f..ca0c6b5282 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesConfig.java @@ -35,6 +35,17 @@ import net.runelite.client.config.ConfigItem; ) public interface AttackStylesConfig extends Config { + @ConfigItem( + keyName = "alwaysShowStyle", + name = "Always show style", + description = "Show attack style indicator at all times", + position = 1 + ) + default boolean alwaysShowStyle() + { + return true; + } + @ConfigItem( keyName = "warnForDefensive", name = "Warn for defensive", diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesOverlay.java b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesOverlay.java index d75c7927fc..f576ca9744 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesOverlay.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesOverlay.java @@ -37,24 +37,33 @@ public class AttackStylesOverlay extends Overlay private static final int COMPONENT_WIDTH = 80; private final AttackStylesPlugin plugin; + private final AttackStylesConfig config; private final PanelComponent panelComponent = new PanelComponent(); @Inject - public AttackStylesOverlay(AttackStylesPlugin plugin) + public AttackStylesOverlay(AttackStylesPlugin plugin, AttackStylesConfig config) { setPosition(OverlayPosition.ABOVE_CHATBOX_RIGHT); this.plugin = plugin; + this.config = config; } @Override public Dimension render(Graphics2D graphics) { - final String attackStyleString = plugin.getAttackStyle().getName(); + boolean warnedSkillSelected = plugin.isWarnedSkillSelected(); - panelComponent.setTitleColor(plugin.isWarnedSkillSelected() ? Color.RED : Color.WHITE); - panelComponent.setTitle(attackStyleString); - panelComponent.setWidth(COMPONENT_WIDTH); + if (warnedSkillSelected || config.alwaysShowStyle()) + { + final String attackStyleString = plugin.getAttackStyle().getName(); - return panelComponent.render(graphics); + panelComponent.setTitleColor(warnedSkillSelected ? Color.RED : Color.WHITE); + panelComponent.setTitle(attackStyleString); + panelComponent.setWidth(COMPONENT_WIDTH); + + return panelComponent.render(graphics); + } + + return null; } } From e5904426751ce48d63b359e5521da77b19f31424 Mon Sep 17 00:00:00 2001 From: SoyChai Date: Mon, 9 Apr 2018 21:44:09 +1000 Subject: [PATCH 3/3] attackstyles: Simplify config descriptions --- .../plugins/attackstyles/AttackStylesConfig.java | 16 ++++++++-------- .../plugins/attackstyles/AttackStylesPlugin.java | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesConfig.java b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesConfig.java index ca0c6b5282..f9c63bc7b9 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesConfig.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesConfig.java @@ -48,11 +48,11 @@ public interface AttackStylesConfig extends Config @ConfigItem( keyName = "warnForDefensive", - name = "Warn for defensive", - description = "Configures whether or not users are warned for selecting a defensive combat option", + name = "Warn for defence", + description = "Show warning when a Defence skill combat option is selected", position = 2 ) - default boolean warnForDefensive() + default boolean warnForDefence() { return false; } @@ -60,7 +60,7 @@ public interface AttackStylesConfig extends Config @ConfigItem( keyName = "warnForAttack", name = "Warn for attack", - description = "Configures whether or not users are warned for selecting an attack combat option", + description = "Show warning when an Attack skill combat option is selected", position = 3 ) default boolean warnForAttack() @@ -71,7 +71,7 @@ public interface AttackStylesConfig extends Config @ConfigItem( keyName = "warnForStrength", name = "Warn for strength", - description = "Configures whether or not users are warned for selecting a strength combat option", + description = "Show warning when a Strength skill combat option is selected", position = 4 ) default boolean warnForStrength() @@ -82,7 +82,7 @@ public interface AttackStylesConfig extends Config @ConfigItem( keyName = "warnForRanged", name = "Warn for ranged", - description = "Configures whether or not users are warned for selecting a ranged combat option", + description = "Show warning when a Ranged skill combat option is selected", position = 5 ) default boolean warnForRanged() @@ -93,7 +93,7 @@ public interface AttackStylesConfig extends Config @ConfigItem( keyName = "warnForMagic", name = "Warn for magic", - description = "Configures whether or not users are warned for selecting a magic combat option", + description = "Show warning when a Magic skill combat option is selected", position = 6 ) default boolean warnForMagic() @@ -104,7 +104,7 @@ public interface AttackStylesConfig extends Config @ConfigItem( keyName = "removeWarnedStyles", name = "Remove warned styles", - description = "Configures whether or not warned styles are removed from the combat options tab", + description = "Remove warned styles from the combat options tab", position = 7 ) default boolean removeWarnedStyles() diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesPlugin.java b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesPlugin.java index 6f0db7508a..568d637982 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesPlugin.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesPlugin.java @@ -96,7 +96,7 @@ public class AttackStylesPlugin extends Plugin { updateWarnedSkills(config.warnForAttack(), Skill.ATTACK); updateWarnedSkills(config.warnForStrength(), Skill.STRENGTH); - updateWarnedSkills(config.warnForDefensive(), Skill.DEFENCE); + updateWarnedSkills(config.warnForDefence(), Skill.DEFENCE); updateWarnedSkills(config.warnForRanged(), Skill.RANGED); updateWarnedSkills(config.warnForMagic(), Skill.MAGIC); updateAttackStyle( @@ -164,7 +164,7 @@ public class AttackStylesPlugin extends Plugin { updateWarnedSkills(config.warnForAttack(), Skill.ATTACK); updateWarnedSkills(config.warnForStrength(), Skill.STRENGTH); - updateWarnedSkills(config.warnForDefensive(), Skill.DEFENCE); + updateWarnedSkills(config.warnForDefence(), Skill.DEFENCE); updateWarnedSkills(config.warnForRanged(), Skill.RANGED); updateWarnedSkills(config.warnForMagic(), Skill.MAGIC); }