CrateLimiterPlugin.java

/*
 * Copyright (c) 2020, Hydrox6 <ikada@protonmail.ch>
 * 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 io.hydrox.cratelimit;

import com.google.common.collect.ImmutableSet;
import com.google.inject.Provides;
import net.runelite.api.ChatMessageType;
import net.runelite.api.Client;
import net.runelite.api.ItemComposition;
import net.runelite.api.MenuAction;
import net.runelite.api.events.MenuOptionClicked;
import net.runelite.api.gameval.ItemID;
import net.runelite.client.chat.ChatMessageManager;
import net.runelite.client.chat.QueuedMessage;
import net.runelite.client.config.ConfigManager;
import net.runelite.client.eventbus.Subscribe;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
import javax.inject.Inject;
import java.util.Set;

@PluginDescriptor(
	name = "Crate Limiter",
	description = "Slows down the opening of crates and jars",
	tags = {"crate", "jar", "eclectic", "medium", "mediums", "rangers", "ranger", "clue", "clues", "open", "loot", "nest"}
)
public class CrateLimiterPlugin extends Plugin
{
	// These items have an Open option, but shouldn't have a speed limit
	private static final Set<Integer> OPEN_EXCEPTIONS = ImmutableSet.of(
		ItemID.LOOTING_BAG,
		ItemID.SLAYER_HERB_SACK,
		ItemID.SEED_BOX,
		ItemID.XBOWS_BOLT_POUCH,
		ItemID.COAL_BAG,
		ItemID.GEM_BAG,
		ItemID.DREAM_HUNTER_BOX,
		ItemID.BH_RUNE_POUCH,
		ItemID.BH_RUNE_POUCH_TROUVER,
		ItemID.BOOKOFSCROLLS_CHARGED,
		ItemID.BOOKOFSCROLLS_EMPTY
	);

	private static final Set<Integer> BIRD_NESTS = ImmutableSet.of(
		// Bird nests with god eggs
		ItemID.BIRD_NEST_EGG_RED,
		ItemID.BIRD_NEST_EGG_GREEN,
		ItemID.BIRD_NEST_EGG_BLUE,
		// Old bird nest with seeds (Before farming guild update, still able to be found within banks/inv)
		ItemID.BIRD_NEST_SEEDS,
		// Bird nests with rings
		ItemID.BIRD_NEST_RING,
		// Old bird nests with seeds from Wyson (Before buff on 18 Feb 2016, still able to be found within banks/inv)
		ItemID.BIRD_NEST_CHEAPSEEDS,
		// Slightly less old bird nests with seeds from Wyson (After buff but before farming guild update, still able to be found within banks/inv)
		ItemID.BIRD_NEST_DECENTSEEDS,
		// Current bird nest with seeds
		ItemID.BIRD_NEST_SEEDS_JAN2019,
		// Current bird nest with seeds from Wyson
		ItemID.BIRD_NEST_DECENTSEEDS_JAN2019
	);

	@Inject
	private Client client;

	@Inject
	private CrateLimiterConfig config;

	@Inject
	private ChatMessageManager chatMessageManager;

	private int tick = -1;

	@Provides
	CrateLimiterConfig getConfig(ConfigManager configManager)
	{
		return configManager.getConfig(CrateLimiterConfig.class);
	}

	@Subscribe
	void onMenuOptionClicked(MenuOptionClicked event)
	{
		if (event.getMenuAction() != MenuAction.CC_OP && !event.isItemOp())
		{
			return;
		}
		// Seed Pack
		if (event.getMenuOption().equals("Take"))
		{
			if (event.getItemId() != ItemID.SEEDBOX)
			{
				return;
			}
		}
		// Nests
		else if (event.getMenuOption().equals("Search"))
		{
			if (!BIRD_NESTS.contains(event.getItemId()))
			{
				return;
			}
		}
		else if (event.getMenuOption().equals("Open"))
		{
			if (OPEN_EXCEPTIONS.contains(event.getItemId()))
			{
				return;
			}
			ItemComposition comp = client.getItemDefinition(event.getItemId());
			// Bundle packs
			if (comp.getName().endsWith(" pack"))
			{
				return;
			}
			// So many coin pouches!
			else if (comp.getName().equals("Coin pouch"))
			{
				return;
			}
		}
		else if (!event.getMenuOption().equals("Loot"))
		{
			return;
		}

		if (client.getTickCount() - tick >= config.ticksPerItem())
		{
			tick = client.getTickCount();
		}
		else
		{
			event.consume();
			if (config.showMessage())
			{
				chatMessageManager.queue(QueuedMessage
					.builder()
					.value("Woah there buddy, slow down!")
					.type(ChatMessageType.ENGINE)
					.build()
				);
			}
		}
	}
}