diff --git a/runelite-api/src/main/java/net/runelite/api/Hitsplat.java b/runelite-api/src/main/java/net/runelite/api/Hitsplat.java new file mode 100644 index 0000000000..af73dc1cab --- /dev/null +++ b/runelite-api/src/main/java/net/runelite/api/Hitsplat.java @@ -0,0 +1,70 @@ +/* + * Copyright (c) 2018, Woox + * 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; + +import lombok.Getter; + +public class Hitsplat +{ + public enum HitsplatType + { + BLOCK, // Blue + DAMAGE, // Red + POISON, // Green + VENOM, // Darkgreen + DISEASE, // Yellow + HEAL; // Purple + + public static HitsplatType fromInteger(int type) + { + switch (type) + { + case 0: return BLOCK; + case 1: return DAMAGE; + case 2: return POISON; + case 4: return DISEASE; + case 5: return VENOM; + case 6: return HEAL; + } + return null; + } + } + + @Getter + private HitsplatType hitsplatType; + + @Getter + private int amount; + + @Getter + private int disappearsOnGameCycle; + + public Hitsplat(HitsplatType hitsplatType, int amount, int disappearsOnGameCycle) + { + this.hitsplatType = hitsplatType; + this.amount = amount; + this.disappearsOnGameCycle = disappearsOnGameCycle; + } +} \ No newline at end of file diff --git a/runelite-api/src/main/java/net/runelite/api/events/HitsplatApplied.java b/runelite-api/src/main/java/net/runelite/api/events/HitsplatApplied.java new file mode 100644 index 0000000000..18f02e584e --- /dev/null +++ b/runelite-api/src/main/java/net/runelite/api/events/HitsplatApplied.java @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2018, Woox + * 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.Actor; +import net.runelite.api.Hitsplat; + +@Data +public class HitsplatApplied +{ + private Actor actor; + private Hitsplat hitsplat; +} \ No newline at end of file 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 0905c8a694..69d5eef6c3 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 @@ -39,6 +39,7 @@ import java.awt.RenderingHints; import net.runelite.api.Actor; import net.runelite.api.ChatMessageType; import net.runelite.api.Client; +import net.runelite.api.Hitsplat; import net.runelite.api.ItemComposition; import net.runelite.api.KeyFocusListener; import net.runelite.api.MainBufferProvider; @@ -55,6 +56,7 @@ import net.runelite.api.events.ActorDeath; import net.runelite.api.events.ChatMessage; import net.runelite.api.events.FocusChanged; import net.runelite.api.events.GameTick; +import net.runelite.api.events.HitsplatApplied; import net.runelite.api.events.MenuOpened; import net.runelite.api.events.MenuOptionClicked; import net.runelite.api.events.PostItemComposition; @@ -455,4 +457,29 @@ public class Hooks event.setMenuEntries(client.getMenuEntries()); eventBus.post(event); } + + /** + * Called after a hitsplat has been processed on an actor. + * Note that this event runs even if the hitsplat didn't show up, + * i.e. the actor already had 4 visible hitsplats. + * + * @param actor The actor the hitsplat was applied to + * @param type The hitsplat type (i.e. color) + * @param value The value of the hitsplat (i.e. how high the hit was) + * @param var3 + * @param var4 + * @param gameCycle The gamecycle the hitsplat was applied on + * @param duration The amount of gamecycles the hitsplat will last for + */ + public static void onActorHitsplat(Actor actor, int type, int value, int var3, int var4, + int gameCycle, int duration) + { + Hitsplat hitsplat = new Hitsplat(Hitsplat.HitsplatType.fromInteger(type), value, + gameCycle + duration); + + HitsplatApplied event = new HitsplatApplied(); + event.setActor(actor); + event.setHitsplat(hitsplat); + eventBus.post(event); + } }