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/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..09b1c96090 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 SequenceDefinition { // @Import("stretches") // boolean getStretches(); @@ -20,11 +21,14 @@ public interface RSSequenceDefinition extends RSNode // int[] getInterleaveLeave(); @Import("frameIds") + @Override int[] getFrameIDs(); @Import("frameLengths") + @Override int[] getFrameLengths(); @Import("chatFrameIds") + @Override int[] getChatFrameIds(); }