Merge pull request #3105 from SRLJustin/upstream-03012022

upstream: merge

runelite-api/src/main/java/net/runelite/api/Client.java

@@ -1114,7 +1114,9 @@ public interface Client extends GameEngine
 	 * Loads a model from the cache
 	 *
 	 * @param id the ID of the model
+	 * @return the model or null if it is loading or nonexistent
 	 */
+	@Nullable
 	Model loadModel(int id);
 
 	/**
@@ -1123,7 +1125,9 @@ public interface Client extends GameEngine
 	 * @param id the ID of the model
 	 * @param colorToFind array of hsl color values to find in the model to replace
 	 * @param colorToReplace array of hsl color values to replace in the model
+	 * @return the model or null if it is loading or nonexistent
 	 */
+	@Nullable
 	Model loadModel(int id, short[] colorToFind, short[] colorToReplace);
 
 	/**

runelite-api/src/main/java/net/runelite/api/DecorativeObject.java

@@ -54,4 +54,14 @@ public interface DecorativeObject extends TileObject
 	 * account for walls of varying widths.
 	 */
 	int getYOffset();
+
+	/**
+	 * A bitfield containing various flags:
+	 * <pre>{@code
+	 * object type id = bits & 0x20
+	 * orientation (0-3) = bits >>> 6 & 3
+	 * supports items = bits >>> 8 & 1
+	 * }</pre>
+	 */
+	int getConfig();
 }

runelite-api/src/main/java/net/runelite/api/GameObject.java

@@ -93,4 +93,14 @@ public interface GameObject extends TileObject
 	 * @see net.runelite.api.coords.Angle
 	 */
 	int getModelOrientation();
+
+	/**
+	 * A bitfield containing various flags:
+	 * <pre>{@code
+	 * object type id = bits & 0x20
+	 * orientation (0-3) = bits >>> 6 & 3
+	 * supports items = bits >>> 8 & 1
+	 * }</pre>
+	 */
+	int getConfig();
 }

runelite-api/src/main/java/net/runelite/api/GroundObject.java

@@ -42,4 +42,14 @@ public interface GroundObject extends TileObject
 	 * @see net.runelite.api.model.Jarvis
 	 */
 	Shape getConvexHull();
+
+	/**
+	 * A bitfield containing various flags:
+	 * <pre>{@code
+	 * object type id = bits & 0x20
+	 * orientation (0-3) = bits >>> 6 & 3
+	 * supports items = bits >>> 8 & 1
+	 * }</pre>
+	 */
+	int getConfig();
 }

runelite-api/src/main/java/net/runelite/api/ScriptEvent.java

@@ -53,6 +53,12 @@ public interface ScriptEvent
 	 */
 	ScriptEvent setSource(Widget widget);
 
+	/**
+	 * Arguments passed to the script. Index 0 is the script being run and is not an argument.
+	 * @return
+	 */
+	Object[] getArguments();
+
 	/**
 	 * Gets the menu index of the event
 	 *
@@ -73,6 +79,11 @@ public interface ScriptEvent
 	 */
 	int getMouseX();
 
+	/**
+	 * Parent relative y coordinate for mouse related events
+	 */
+	int getMouseY();
+
 	/**
 	 * Jagex typed keycode
 	 *

runelite-api/src/main/java/net/runelite/api/WallObject.java

@@ -27,37 +27,46 @@ package net.runelite.api;
 import java.awt.Shape;
 
 /**
- * Represents the wall of a tile, which is an un-passable boundary.
+ * Represents one or two walls on a tile
  */
 public interface WallObject extends TileObject
 {
 	/**
-	 * Gets the first orientation of the wall.
-	 *
-	 * @return the first orientation, 0-2048 where 0 is north
+	 * A bitfield with the orientation of the first wall
+	 * 1 = West
+	 * 2 = North
+	 * 4 = East
+	 * 8 = South
+	 * 16 = North-west
+	 * 32 = North-east
+	 * 64 = South-east
+	 * 128 = South-west
 	 */
 	int getOrientationA();
 
 	/**
-	 * Gets the second orientation value of the wall.
-	 *
-	 * @return the second orientation, 0-2048 where 0 is north
+	 * A bitfield with the orientation of the second wall
+	 * 1 = West
+	 * 2 = North
+	 * 4 = East
+	 * 8 = South
+	 * 16 = North-west
+	 * 32 = North-east
+	 * 64 = South-east
+	 * 128 = South-west
 	 */
 	int getOrientationB();
 
 	/**
-	 * Gets the boundary configuration of the wall.
-	 *
-	 * @return the boundary configuration
+	 * A bitfield containing various flags:
+	 * <pre>{@code
+	 * object type id = bits & 0x20
+	 * orientation (0-3) = bits >>> 6 & 3
+	 * supports items = bits >>> 8 & 1
+	 * }</pre>
 	 */
 	int getConfig();
 
-	Renderable getRenderable1();
-	Renderable getRenderable2();
-
-	Model getModelA();
-	Model getModelB();
-
 	/**
 	 * Gets the convex hull of the objects model.
 	 *
@@ -66,4 +75,10 @@ public interface WallObject extends TileObject
 	 */
 	Shape getConvexHull();
 	Shape getConvexHull2();
+
+	Renderable getRenderable1();
+	Renderable getRenderable2();
+
+	Model getModelA();
+	Model getModelB();
 }

runelite-api/src/main/java/net/runelite/api/coords/WorldPoint.java

@@ -199,7 +199,7 @@ public class WorldPoint
 
 			// get the template chunk for the chunk
 			int[][][] instanceTemplateChunks = client.getInstanceTemplateChunks();
-			int templateChunk = instanceTemplateChunks[client.getPlane()][chunkX][chunkY];
+			int templateChunk = instanceTemplateChunks[plane][chunkX][chunkY];
 
 			int rotation = templateChunk >> 1 & 0x3;
 			int templateChunkY = (templateChunk >> 3 & 0x7FF) * CHUNK_SIZE;

runelite-api/src/main/java/net/runelite/api/widgets/WidgetInfo.java

@@ -551,8 +551,8 @@ public enum WidgetInfo
 	TRAILBLAZER_AREA_TELEPORT(WidgetID.TRAILBLAZER_AREAS_GROUP_ID, WidgetID.TrailblazerAreas.TELEPORT),
 
 	MULTICOMBAT_FIXED(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.MULTICOMBAT_INDICATOR),
-	MULTICOMBAT_RESIZEABLE_MODERN(WidgetID.RESIZABLE_VIEWPORT_BOTTOM_LINE_GROUP_ID, WidgetID.ResizableViewport.MULTICOMBAT_INDICATOR),
-	MULTICOMBAT_RESIZEABLE_CLASSIC(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.MULTICOMBAT_INDICATOR),
+	MULTICOMBAT_RESIZABLE_MODERN(WidgetID.RESIZABLE_VIEWPORT_BOTTOM_LINE_GROUP_ID, WidgetID.ResizableViewport.MULTICOMBAT_INDICATOR),
+	MULTICOMBAT_RESIZABLE_CLASSIC(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.MULTICOMBAT_INDICATOR),
 
 	TEMPOROSS_STATUS_INDICATOR(WidgetID.TEMPOROSS_GROUP_ID, WidgetID.TemporossStatus.STATUS_INDICATOR),