ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

client: add random event plugin

Browse Source
This commit is contained in:
trimbe
2019-10-05 15:48:26 -04:00
committed by Adam
parent a63389866a
commit eaeda0b69b
2 changed files with 383 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

156
runelite-client/src/main/java/net/runelite/client/plugins/randomevents/RandomEventConfig.java Normal file
View File

@@ -0,0 +1,156 @@
/*
* Copyright (c) 2018, trimbe <github.com/trimbe>
* 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.randomevents;
import net.runelite.client.config.Config;
import net.runelite.client.config.ConfigGroup;
import net.runelite.client.config.ConfigItem;
@ConfigGroup("randomevents")
public interface RandomEventConfig extends Config
{
@ConfigItem(
keyName = "removeMenuOptions",
name = "Remove others' menu options",
description = "Remove menu options from random events for other players.",
position = 0
)
default boolean removeMenuOptions()
{
return true;
}
@ConfigItem(
keyName = "notifyDunce",
name = "Notify on Surprise Exam",
description = "",
position = 1
)
default boolean notifyDunce()
{
return false;
}
@ConfigItem(
keyName = "notifyGenie",
name = "Notify on Genie",
description = "",
position = 2
)
default boolean notifyGenie()
{
return false;
}
@ConfigItem(
keyName = "notifyDemon",
name = "Notify on Drill Demon",
description = "",
position = 3
)
default boolean notifyDemon()
{
return false;
}
@ConfigItem(
keyName = "notifyForester",
name = "Notify on Freaky Forester",
description = "",
position = 4
)
default boolean notifyForester()
{
return false;
}
@ConfigItem(
keyName = "notifyFrog",
name = "Notify on Kiss the Frog",
description = "",
position = 5
)
default boolean notifyFrog()
{
return false;
}
@ConfigItem(
keyName = "notifyGravedigger",
name = "Notify on Gravedigger",
description = "",
position = 6
)
default boolean notifyGravedigger()
{
return false;
}
@ConfigItem(
keyName = "notifyMoM",
name = "Notify on Mysterious Old Man",
description = "",
position = 7
)
default boolean notifyMoM()
{
return false;
}
@ConfigItem(
keyName = "notifyBob",
name = "Notify on Evil Bob",
description = "",
position = 8
)
default boolean notifyBob()
{
return false;
}
@ConfigItem(
keyName = "notifyQuiz",
name = "Notify on Quiz Master",
description = "",
position = 9
)
default boolean notifyQuiz()
{
return false;
}
@ConfigItem(
keyName = "notifyAll",
name = "Notify for all events",
description = "",
position = 10
)
default boolean notifyAllEvents()
{
return false;
}
}

227
runelite-client/src/main/java/net/runelite/client/plugins/randomevents/RandomEventPlugin.java Normal file
View File

@@ -0,0 +1,227 @@
/*
* Copyright (c) 2018, trimbe <github.com/trimbe>
* 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.randomevents;
import com.google.common.collect.ImmutableSet;
import com.google.inject.Provides;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import javax.inject.Inject;
import net.runelite.api.Actor;
import net.runelite.api.Client;
import net.runelite.api.MenuAction;
import net.runelite.api.NPC;
import net.runelite.api.NpcID;
import net.runelite.api.Player;
import net.runelite.api.events.GameTick;
import net.runelite.api.events.InteractingChanged;
import net.runelite.api.events.MenuEntryAdded;
import net.runelite.api.events.NpcSpawned;
import net.runelite.client.Notifier;
import net.runelite.client.config.ConfigManager;
import net.runelite.client.eventbus.Subscribe;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
@PluginDescriptor(
name = "Random Events",
description = "Notify when random events appear and remove talk/dismiss options on events that aren't yours.",
enabledByDefault = false
)
public class RandomEventPlugin extends Plugin
{
private static final Set<Integer> EVENT_NPCS = ImmutableSet.of(
NpcID.DR_JEKYLL, NpcID.DR_JEKYLL_314,
NpcID.BEE_KEEPER_6747,
NpcID.CAPT_ARNAV,
NpcID.SERGEANT_DAMIEN_6743,
NpcID.DRUNKEN_DWARF,
NpcID.FREAKY_FORESTER_6748,
NpcID.GENIE, NpcID.GENIE_327,
NpcID.EVIL_BOB, NpcID.EVIL_BOB_6754,
NpcID.POSTIE_PETE_6738,
NpcID.LEO_6746,
NpcID.MYSTERIOUS_OLD_MAN_6750, NpcID.MYSTERIOUS_OLD_MAN_6751,
NpcID.MYSTERIOUS_OLD_MAN_6752, NpcID.MYSTERIOUS_OLD_MAN_6753,
NpcID.PILLORY_GUARD,
NpcID.FLIPPA_6744,
NpcID.QUIZ_MASTER_6755,
NpcID.RICK_TURPENTINE, NpcID.RICK_TURPENTINE_376,
NpcID.SANDWICH_LADY,
NpcID.DUNCE_6749,
NpcID.NILES, NpcID.NILES_5439,
NpcID.MILES, NpcID.MILES_5440,
NpcID.GILES, NpcID.GILES_5441,
NpcID.FROG_5429
);
private static final Set<String> EVENT_OPTIONS = ImmutableSet.of(
"Talk-to",
"Dismiss"
);
private static final int RANDOM_EVENT_TIMEOUT = 150;
private Map<NPC, Integer> spawnedNpcs = new HashMap<>();
private NPC currentRandomEvent;
// event npcs teleport to you to stay in range, we need to throttle spawns
private int lastEventTick = -RANDOM_EVENT_TIMEOUT;
@Inject
private Client client;
@Inject
private Notifier notifier;
@Inject
private RandomEventConfig config;
@Provides
RandomEventConfig getConfig(ConfigManager configManager)
{
return configManager.getConfig(RandomEventConfig.class);
}
@Override
protected void shutDown() throws Exception
{
lastEventTick = 0;
currentRandomEvent = null;
spawnedNpcs.clear();
}
@Subscribe
public void onNpcSpawned(NpcSpawned event)
{
NPC npc = event.getNpc();
if (!EVENT_NPCS.contains(npc.getId()))
{
return;
}
// only occasionally do event npcs spawn with non-null interacting
if (npc.getInteracting() == client.getLocalPlayer())
{
if (client.getTickCount() - lastEventTick > RANDOM_EVENT_TIMEOUT)
{
currentRandomEvent = npc;
lastEventTick = client.getTickCount();
}
}
else
{
spawnedNpcs.put(npc, client.getTickCount());
}
}
@Subscribe
public void onInteractingChanged(InteractingChanged event)
{
Actor source = event.getSource();
Actor target = event.getTarget();
if (spawnedNpcs.containsKey(source))
{
Player player = client.getLocalPlayer();
if (player == target && client.getTickCount() - lastEventTick > RANDOM_EVENT_TIMEOUT)
{
currentRandomEvent = (NPC) source;
if (shouldNotify(currentRandomEvent.getId()))
{
notifier.notify("Random event spawned: " + currentRandomEvent.getName());
}
}
}
}
@Subscribe
public void onGameTick(GameTick event)
{
if (!spawnedNpcs.isEmpty())
{
// allow 2 ticks for interacting to get set
spawnedNpcs.entrySet().removeIf(entry -> client.getTickCount() - entry.getValue() >= 2);
}
if (client.getTickCount() - lastEventTick > RANDOM_EVENT_TIMEOUT)
{
currentRandomEvent = null;
}
}
@Subscribe
public void onMenuEntryAdded(MenuEntryAdded event)
{
if (event.getType() >= MenuAction.NPC_FIRST_OPTION.getId()
&& event.getType() <= MenuAction.NPC_FIFTH_OPTION.getId()
&& EVENT_OPTIONS.contains(event.getOption()))
{
NPC npc = client.getCachedNPCs()[event.getIdentifier()];
if (npc != null && EVENT_NPCS.contains(npc.getId()) && npc != currentRandomEvent && config.removeMenuOptions())
{
client.setMenuEntries(Arrays.copyOf(client.getMenuEntries(), client.getMenuEntries().length - 1));
}
}
}
private boolean shouldNotify(int id)
{
if (config.notifyAllEvents())
{
return true;
}
switch (id)
{
case NpcID.SERGEANT_DAMIEN_6743:
return config.notifyDemon();
case NpcID.FREAKY_FORESTER_6748:
return config.notifyForester();
case NpcID.FROG_5429:
return config.notifyFrog();
case NpcID.GENIE:
case NpcID.GENIE_327:
return config.notifyGenie();
case NpcID.EVIL_BOB:
case NpcID.EVIL_BOB_6754:
return config.notifyBob();
case NpcID.LEO_6746:
return config.notifyGravedigger();
case NpcID.MYSTERIOUS_OLD_MAN_6750:
case NpcID.MYSTERIOUS_OLD_MAN_6751:
case NpcID.MYSTERIOUS_OLD_MAN_6752:
case NpcID.MYSTERIOUS_OLD_MAN_6753:
return config.notifyMoM();
case NpcID.QUIZ_MASTER_6755:
return config.notifyQuiz();
case NpcID.DUNCE_6749:
return config.notifyDunce();
default:
return false;
}
}
}