From faab4589f5c372b6928829e35903a97750c33b85 Mon Sep 17 00:00:00 2001 From: Adam Date: Sun, 27 May 2018 12:16:44 -0400 Subject: [PATCH] woodcutting plugin: show redwood trees --- .../client/plugins/woodcutting/Tree.java | 62 +++++++++++++++ .../woodcutting/WoodcuttingConfig.java | 11 +++ .../woodcutting/WoodcuttingPlugin.java | 54 ++++++++++++- .../woodcutting/WoodcuttingTreesOverlay.java | 76 +++++++++++++++++++ 4 files changed, 201 insertions(+), 2 deletions(-) create mode 100644 runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/Tree.java create mode 100644 runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/WoodcuttingTreesOverlay.java diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/Tree.java b/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/Tree.java new file mode 100644 index 0000000000..021ce9da9f --- /dev/null +++ b/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/Tree.java @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2018, Mantautas Jurksa + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (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.woodcutting; + +import java.util.HashMap; +import java.util.Map; +import lombok.Getter; +import static net.runelite.api.ObjectID.REDWOOD; +import static net.runelite.api.ObjectID.REDWOOD_29670; + +@Getter +enum Tree +{ + REDWOOD_TREE_SPAWN(REDWOOD, REDWOOD_29670); + + private final int[] treeIds; + + Tree(int... treeIds) + { + this.treeIds = treeIds; + } + + private static final Map TREES = new HashMap<>(); + + static + { + for (Tree tree : values()) + { + for (int treeId : tree.treeIds) + { + TREES.put(treeId, tree); + } + } + } + + static Tree findTree(int objectId) + { + return TREES.get(objectId); + } +} \ No newline at end of file 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 479f6ce629..dc59dcf4d8 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 @@ -67,4 +67,15 @@ public interface WoodcuttingConfig extends Config { return true; } + + @ConfigItem( + position = 4, + keyName = "showRedwoods", + name = "Show Redwood trees", + description = "Configures whether to show a indicator for redwood trees" + ) + default boolean showRedwoodTrees() + { + return true; + } } \ No newline at end of file diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/WoodcuttingPlugin.java b/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/WoodcuttingPlugin.java index 6f4678f116..01a4167f96 100644 --- a/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/WoodcuttingPlugin.java +++ b/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/WoodcuttingPlugin.java @@ -28,13 +28,23 @@ import com.google.common.eventbus.Subscribe; import com.google.inject.Provides; import java.time.Duration; import java.time.Instant; +import java.util.Arrays; +import java.util.Collection; +import java.util.HashSet; +import java.util.Set; import javax.inject.Inject; import lombok.Getter; import net.runelite.api.ChatMessageType; import net.runelite.api.Client; +import net.runelite.api.GameObject; +import net.runelite.api.GameState; import net.runelite.api.Player; import net.runelite.api.events.AnimationChanged; import net.runelite.api.events.ChatMessage; +import net.runelite.api.events.GameObjectChanged; +import net.runelite.api.events.GameObjectDespawned; +import net.runelite.api.events.GameObjectSpawned; +import net.runelite.api.events.GameStateChanged; import net.runelite.api.events.GameTick; import net.runelite.client.Notifier; import net.runelite.client.config.ConfigManager; @@ -59,6 +69,9 @@ public class WoodcuttingPlugin extends Plugin @Inject private WoodcuttingOverlay overlay; + @Inject + private WoodcuttingTreesOverlay treesOverlay; + @Inject private WoodcuttingConfig config; @@ -68,6 +81,9 @@ public class WoodcuttingPlugin extends Plugin @Getter private Axe axe; + @Getter + private final Set treeObjects = new HashSet<>(); + @Provides WoodcuttingConfig getConfig(ConfigManager configManager) { @@ -75,14 +91,15 @@ public class WoodcuttingPlugin extends Plugin } @Override - public Overlay getOverlay() + public Collection getOverlays() { - return overlay; + return Arrays.asList(overlay, treesOverlay); } @Override protected void shutDown() throws Exception { + treeObjects.clear(); session = null; axe = null; } @@ -127,6 +144,39 @@ public class WoodcuttingPlugin extends Plugin } } + @Subscribe + public void onGameObjectSpawned(final GameObjectSpawned event) + { + GameObject gameObject = event.getGameObject(); + Tree tree = Tree.findTree(gameObject.getId()); + + if (tree != null) + { + treeObjects.add(gameObject); + } + } + + @Subscribe + public void onGameObjectDespawned(final GameObjectDespawned event) + { + treeObjects.remove(event.getGameObject()); + } + + @Subscribe + public void onGameObjectChanged(final GameObjectChanged event) + { + treeObjects.remove(event.getGameObject()); + } + + @Subscribe + public void onGameStateChanged(final GameStateChanged event) + { + if (event.getGameState() != GameState.LOGGED_IN) + { + treeObjects.clear(); + } + } + @Subscribe public void onAnimationChanged(final AnimationChanged event) { diff --git a/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/WoodcuttingTreesOverlay.java b/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/WoodcuttingTreesOverlay.java new file mode 100644 index 0000000000..7265bb71b6 --- /dev/null +++ b/runelite-client/src/main/java/net/runelite/client/plugins/woodcutting/WoodcuttingTreesOverlay.java @@ -0,0 +1,76 @@ +/* + * Copyright (c) 2018, Tomas Slusny + * Copyright (c) 2018, Adam + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (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.woodcutting; + +import java.awt.Dimension; +import java.awt.Graphics2D; +import javax.inject.Inject; +import net.runelite.api.Client; +import net.runelite.api.GameObject; +import net.runelite.client.game.ItemManager; +import net.runelite.client.ui.overlay.Overlay; +import net.runelite.client.ui.overlay.OverlayLayer; +import net.runelite.client.ui.overlay.OverlayPosition; +import net.runelite.client.ui.overlay.OverlayUtil; + +class WoodcuttingTreesOverlay extends Overlay +{ + private final Client client; + private final WoodcuttingConfig config; + private final ItemManager itemManager; + private final WoodcuttingPlugin plugin; + + @Inject + private WoodcuttingTreesOverlay(final Client client, final WoodcuttingConfig config, final ItemManager itemManager, final WoodcuttingPlugin plugin) + { + this.client = client; + this.config = config; + this.itemManager = itemManager; + this.plugin = plugin; + setLayer(OverlayLayer.ABOVE_SCENE); + setPosition(OverlayPosition.DYNAMIC); + } + + @Override + public Dimension render(Graphics2D graphics) + { + if (plugin.getSession() == null || !config.showRedwoodTrees()) + { + return null; + } + + for (GameObject treeObject : plugin.getTreeObjects()) + { + if (treeObject.getWorldLocation().distanceTo(client.getLocalPlayer().getWorldLocation()) <= 12) + { + Axe axe = plugin.getAxe(); + OverlayUtil.renderImageLocation(client, graphics, treeObject.getLocalLocation(), itemManager.getImage(axe.getItemId()), 120); + } + } + + return null; + } +}