From 41f005827c8739ff0875c50f3d8081bdd1aa2082 Mon Sep 17 00:00:00 2001 From: Adam Date: Sat, 27 Jan 2018 13:01:11 -0500 Subject: [PATCH] Add runelite vm opcode and event --- .../main/java/net/runelite/api/Opcodes.java | 30 +++++++++++ .../net/runelite/api/events/ScriptEvent.java | 35 ++++++++++++ .../net/runelite/client/callback/Hooks.java | 24 +++++++++ .../net/runelite/client/callback/Hooks.java | 6 +++ .../java/net/runelite/mixins/VmMixin.java | 53 +++++++++++++++++++ 5 files changed, 148 insertions(+) create mode 100644 runelite-api/src/main/java/net/runelite/api/Opcodes.java create mode 100644 runelite-api/src/main/java/net/runelite/api/events/ScriptEvent.java create mode 100644 runelite-mixins/src/main/java/net/runelite/mixins/VmMixin.java diff --git a/runelite-api/src/main/java/net/runelite/api/Opcodes.java b/runelite-api/src/main/java/net/runelite/api/Opcodes.java new file mode 100644 index 0000000000..6cb4bfcbfb --- /dev/null +++ b/runelite-api/src/main/java/net/runelite/api/Opcodes.java @@ -0,0 +1,30 @@ +/* + * 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.api; + +public class Opcodes +{ + public static final int RUNELITE_EXECUTE = 6599; +} diff --git a/runelite-api/src/main/java/net/runelite/api/events/ScriptEvent.java b/runelite-api/src/main/java/net/runelite/api/events/ScriptEvent.java new file mode 100644 index 0000000000..db6887c25e --- /dev/null +++ b/runelite-api/src/main/java/net/runelite/api/events/ScriptEvent.java @@ -0,0 +1,35 @@ +/* + * 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.api.events; + +import lombok.Data; +import net.runelite.api.Script; + +@Data +public class ScriptEvent +{ + private Script script; + private String eventName; +} diff --git a/runelite-client/src/main/java/net/runelite/client/callback/Hooks.java b/runelite-client/src/main/java/net/runelite/client/callback/Hooks.java index 4b1b2cd296..d9a73fb7ac 100644 --- a/runelite-client/src/main/java/net/runelite/client/callback/Hooks.java +++ b/runelite-client/src/main/java/net/runelite/client/callback/Hooks.java @@ -44,6 +44,8 @@ import net.runelite.api.PacketBuffer; import net.runelite.api.Point; import net.runelite.api.Projectile; import net.runelite.api.Region; +import net.runelite.api.Script; +import net.runelite.api.events.ScriptEvent; import net.runelite.client.RuneLite; import net.runelite.client.chat.ChatMessageManager; import net.runelite.client.game.DeathChecker; @@ -151,6 +153,28 @@ public class Hooks } } + /** + * + * @param opcode + * @param script + * @param isOne + * @return 0 halts, 1 continues, 2 throws + */ + public static int runeliteExecute(int opcode, Script script, boolean isOne) + { + String[] stringStack = client.getStringStack(); + int stackSize = client.getStringStackSize(); + String eventName = stringStack[--stackSize]; + client.setStringStackSize(stackSize); + + ScriptEvent event = new ScriptEvent(); + event.setScript(script); + event.setEventName(eventName); + eventBus.post(event); + + return 1; + } + public static void menuActionHook(int actionParam, int widgetId, int menuAction, int id, String menuOption, String menuTarget, int var6, int var7) { /* Along the way, the RuneScape client may change a menuAction by incrementing it with 2000. diff --git a/runelite-mixins/src/main/java/net/runelite/client/callback/Hooks.java b/runelite-mixins/src/main/java/net/runelite/client/callback/Hooks.java index 03d5b49020..a904a09c54 100644 --- a/runelite-mixins/src/main/java/net/runelite/client/callback/Hooks.java +++ b/runelite-mixins/src/main/java/net/runelite/client/callback/Hooks.java @@ -25,6 +25,7 @@ package net.runelite.client.callback; import com.google.common.eventbus.EventBus; +import net.runelite.api.Script; import org.slf4j.Logger; /** @@ -37,4 +38,9 @@ public class Hooks public static Logger log; public static EventBus eventBus; + + public static int runeliteExecute(int opcode, Script script, boolean isOne) + { + throw new RuntimeException(); + } } diff --git a/runelite-mixins/src/main/java/net/runelite/mixins/VmMixin.java b/runelite-mixins/src/main/java/net/runelite/mixins/VmMixin.java new file mode 100644 index 0000000000..c81b206c41 --- /dev/null +++ b/runelite-mixins/src/main/java/net/runelite/mixins/VmMixin.java @@ -0,0 +1,53 @@ +/* + * 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.mixins; + +import static net.runelite.api.Opcodes.RUNELITE_EXECUTE; +import net.runelite.api.Script; +import net.runelite.api.mixins.Copy; +import net.runelite.api.mixins.Mixin; +import net.runelite.api.mixins.Replace; +import net.runelite.client.callback.Hooks; +import net.runelite.rs.api.RSClient; + +@Mixin(RSClient.class) +public abstract class VmMixin +{ + @Copy("execute6500") + static int rs$execute6500(int opcode, Script script, boolean isOne) + { + throw new RuntimeException(); + } + + @Replace("execute6500") + static int rl$execute6500(int opcode, Script script, boolean isOne) + { + if (opcode == RUNELITE_EXECUTE) + { + return Hooks.runeliteExecute(opcode, script, isOne); + } + return rs$execute6500(opcode, script, isOne); + } +}