From a12a668cd1867d8df6ed03fc60d1767c7e45140c Mon Sep 17 00:00:00 2001 From: Noodleeater Date: Sat, 20 Feb 2021 20:43:36 +0000 Subject: [PATCH] rl-api: add some graphics-related accessors and interfaces --- .../main/java/net/runelite/api/Client.java | 12 +++++ .../java/net/runelite/api/GameObject.java | 8 +++ .../net/runelite/api/SequenceDefinition.java | 52 +++++++++++++++++++ .../src/main/java/net/runelite/api/Tile.java | 10 ++++ .../java/net/runelite/rs/api/RSClient.java | 5 ++ .../net/runelite/rs/api/RSGameObject.java | 1 + .../runelite/rs/api/RSSequenceDefinition.java | 10 +++- 7 files changed, 97 insertions(+), 1 deletion(-) create mode 100644 runelite-api/src/main/java/net/runelite/api/SequenceDefinition.java diff --git a/runelite-api/src/main/java/net/runelite/api/Client.java b/runelite-api/src/main/java/net/runelite/api/Client.java index 1a1ec1a921..d6d193c325 100644 --- a/runelite-api/src/main/java/net/runelite/api/Client.java +++ b/runelite-api/src/main/java/net/runelite/api/Client.java @@ -1861,6 +1861,11 @@ public interface Client extends GameEngine */ void draw2010Menu(int alpha); + /** + * Get client pixels. Each integer represents an ARGB colored pixel. + */ + int[] getGraphicsPixels(); + /** * Draws a menu in the OSRS interface style. * @@ -2102,6 +2107,13 @@ public interface Client extends GameEngine List getOutdatedScripts(); + /** + * Gets a Frames object. File Ids for animations frames are grouped together into a Frames object. getFrames will get the group of frames that the frameId belongs to. + */ + Frames getFrames(int frameId); + + SequenceDefinition getSequenceDefinition(int id); + /** * various archives you might want to use for reading data from cache */ diff --git a/runelite-api/src/main/java/net/runelite/api/GameObject.java b/runelite-api/src/main/java/net/runelite/api/GameObject.java index 23a6948d69..3e3c78112e 100644 --- a/runelite-api/src/main/java/net/runelite/api/GameObject.java +++ b/runelite-api/src/main/java/net/runelite/api/GameObject.java @@ -73,4 +73,12 @@ public interface GameObject extends TileObject int getRsOrientation(); Model getModel(); + + /** + * A bitfield containing various flags: + * object type id = bits & 0x20 + * orientation (0-3) = bits >>> 6 & 3 + * the bitfield may contain other flags in addition to those mentioned above + */ + int getFlags(); } diff --git a/runelite-api/src/main/java/net/runelite/api/SequenceDefinition.java b/runelite-api/src/main/java/net/runelite/api/SequenceDefinition.java new file mode 100644 index 0000000000..ee6e626721 --- /dev/null +++ b/runelite-api/src/main/java/net/runelite/api/SequenceDefinition.java @@ -0,0 +1,52 @@ +/* + * Copyright (c) 2021, Noodleeater + * 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; + +/** + * Represents a Sequence of animation frame Ids. + * It stores animation frames Ids and the length of time between each frame. + */ +public interface SequenceDefinition extends DualNode +{ + /** + * Get the number of frames in the animation sequence + */ + int getFrameCount(); + + /** + * Get id of all frames in the animation sequence + */ + int[] getFrameIDs(); + + /** + * Get the length in game ticks, that each animation frame is displayed for. + */ + int[] getFrameLengths(); + + /** + * Get id of all frames in the animation sequence for the chat head's model animation. + */ + int[] getChatFrameIds(); +} diff --git a/runelite-api/src/main/java/net/runelite/api/Tile.java b/runelite-api/src/main/java/net/runelite/api/Tile.java index 46ada0f10e..625c5ffd32 100644 --- a/runelite-api/src/main/java/net/runelite/api/Tile.java +++ b/runelite-api/src/main/java/net/runelite/api/Tile.java @@ -101,6 +101,16 @@ public interface Tile extends TileObject */ int getRenderLevel(); + /** + * Get the minimum plane this tile will be rendered on. + * Example: This tile is on plane 1. The local player is on plane 0, and hide roofs option is turned on. + * If minPlane is 0, this tile will not be rendered. + * If minPlane is 1, this tile will be rendered. + * + * @return the minPlane + */ + int getPhysicalLevel(); + /** * Computes and returns whether this tile has line of sight to another. * diff --git a/runescape-api/src/main/java/net/runelite/rs/api/RSClient.java b/runescape-api/src/main/java/net/runelite/rs/api/RSClient.java index 66318eef50..e6cd459c59 100644 --- a/runescape-api/src/main/java/net/runelite/rs/api/RSClient.java +++ b/runescape-api/src/main/java/net/runelite/rs/api/RSClient.java @@ -774,6 +774,7 @@ public interface RSClient extends RSGameEngine, Client void setAnimOffsetZ(int animOffsetZ); @Import("getFrames") + @Override RSFrames getFrames(int frameId); @Import("sceneMinimapSprite") @@ -962,6 +963,7 @@ public interface RSClient extends RSGameEngine, Client boolean getViewportContainsMouse(); @Import("Rasterizer2D_pixels") + @Override int[] getGraphicsPixels(); @Import("Rasterizer2D_width") @@ -1341,6 +1343,9 @@ public interface RSClient extends RSGameEngine, Client @Import("getParamDefinition") RSParamComposition getRSParamComposition(int id); + @Import("SequenceDefinition_get") + RSSequenceDefinition getSequenceDefinition(int id); + @Construct RSIntegerNode newIntegerNode(int contents); diff --git a/runescape-api/src/main/java/net/runelite/rs/api/RSGameObject.java b/runescape-api/src/main/java/net/runelite/rs/api/RSGameObject.java index ae132af104..7bea92ce91 100644 --- a/runescape-api/src/main/java/net/runelite/rs/api/RSGameObject.java +++ b/runescape-api/src/main/java/net/runelite/rs/api/RSGameObject.java @@ -43,5 +43,6 @@ public interface RSGameObject extends GameObject long getHash(); @Import("flags") + @Override int getFlags(); } diff --git a/runescape-api/src/main/java/net/runelite/rs/api/RSSequenceDefinition.java b/runescape-api/src/main/java/net/runelite/rs/api/RSSequenceDefinition.java index 14268ff5ba..1137851b39 100644 --- a/runescape-api/src/main/java/net/runelite/rs/api/RSSequenceDefinition.java +++ b/runescape-api/src/main/java/net/runelite/rs/api/RSSequenceDefinition.java @@ -1,8 +1,9 @@ package net.runelite.rs.api; +import net.runelite.api.SequenceDefinition; import net.runelite.mapping.Import; -public interface RSSequenceDefinition extends RSNode +public interface RSSequenceDefinition extends RSNode, SequenceDefinition { // @Import("stretches") // boolean getStretches(); @@ -19,12 +20,19 @@ public interface RSSequenceDefinition extends RSNode // @Import("interleaveLeave") // int[] getInterleaveLeave(); + @Import("frameCount") + @Override + int getFrameCount(); + @Import("frameIds") + @Override int[] getFrameIDs(); @Import("frameLengths") + @Override int[] getFrameLengths(); @Import("chatFrameIds") + @Override int[] getChatFrameIds(); }