@deafwave/osrs-botmaker-types 0.5.5 → 0.5.7

package/dist/src/types/runelite/net/runelite/api/Client.d.ts

@@ -28,22 +28,24 @@ declare namespace net.runelite.api {
 	/**
 	 * Represents the RuneScape client.
 	 */
-	export class Client
-		extends com.jagex.oldscape.pub.OAuthApi,
-			GameEngine {
+	export class Client extends com.jagex.oldscape.pub.OAuthApi, GameEngine {
 		/**
 		 * The injected client invokes these callbacks to send events to us
 		 */
 		getCallbacks(): net.runelite.api.hooks.Callbacks;
+
 		/**
 		 * The injected client invokes these callbacks for scene drawing, which is
 		 * used by the gpu plugin to override the client's normal scene drawing code
 		 */
 		getDrawCallbacks(): net.runelite.api.hooks.DrawCallbacks;
-		setDrawCallbacks(
-			drawCallbacks: net.runelite.api.hooks.DrawCallbacks,
-		): void;
+
+		setDrawCallbacks(drawCallbacks: net.runelite.api.hooks.DrawCallbacks): void;
+
 		getBuildID(): string;
+
+		getEnvironment(): number;
+
 		/**
 		 * Gets the current modified level of a skill.
 		 *
@@ -51,6 +53,7 @@ declare namespace net.runelite.api {
 		 * @return the modified skill level
 		 */
 		getBoostedSkillLevel(skill: Skill): number;
+
 		/**
 		 * Gets the real level of a skill.
 		 *
@@ -58,12 +61,14 @@ declare namespace net.runelite.api {
 		 * @return the skill level
 		 */
 		getRealSkillLevel(skill: Skill): number;
+
 		/**
 		 * Calculates the total level from real skill levels.
 		 *
 		 * @return the total level
 		 */
 		getTotalLevel(): number;
+
 		/**
 		 * Adds a new chat message to the chatbox.
 		 *
@@ -73,12 +78,8 @@ declare namespace net.runelite.api {
 		 * @param sender the sender/channel name
 		 * @return the message node for the message
 		 */
-		addChatMessage(
-			type: ChatMessageType,
-			name: string,
-			message: string,
-			sender: string | null,
-		): MessageNode;
+		addChatMessage(type: ChatMessageType, name: string, message: string, sender: string): MessageNode;
+
 		/**
 		 * Adds a new chat message to the chatbox.
 		 *
@@ -89,91 +90,98 @@ declare namespace net.runelite.api {
 		 * @param postEvent whether to post the chat message event
 		 * @return the message node for the message
 		 */
-		addChatMessage(
-			type: ChatMessageType,
-			name: string,
-			message: string,
-			sender: string,
-			postEvent: boolean,
-		): MessageNode;
+		addChatMessage(type: ChatMessageType, name: string, message: string, sender: string, postEvent: boolean): MessageNode;
+
 		/**
 		 * Gets the current game state.
 		 *
 		 * @return the game state
 		 */
 		getGameState(): GameState;
+
 		/**
 		 * Sets the current game state
 		 *
 		 * @param gameState
 		 */
 		setGameState(gameState: GameState): void;
+
 		/**
 		 * Causes the client to shutdown. It is faster than
 		 * {@link java.applet.Applet#stop()} because it doesn't wait for 4000ms.
 		 * This will call {@link System#exit} when it is done
 		 */
 		stopNow(): void;
+
 		/**
 		 * Gets the display name of the active account when launched from the Jagex launcher.
 		 *
 		 * @return The active account's display name, or {@code null} if not launched from the Jagex launcher
 		 */
 		getLauncherDisplayName(): string | null;
+
 		/**
 		 * DEPRECATED. See getAccountHash instead.
 		 * Gets the current logged in username.
 		 *
 		 * @return the logged in username
 		 * @see OAuthApi#getAccountHash()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getUsername(): string;
+
 		/**
 		 * Sets the current logged in username.
 		 *
 		 * @param name the logged in username
 		 */
 		setUsername(name: string): void;
+
 		/**
 		 * Sets the password on login screen.
 		 *
 		 * @param password the login screen password
 		 */
 		setPassword(password: string): void;
+
 		/**
 		 * Sets the 6 digit pin used for authenticator on login screen.
 		 *
 		 * @param otp one time password
 		 */
 		setOtp(otp: string): void;
+
 		/**
 		 * Gets currently selected login field. 0 is username, and 1 is password.
 		 *
 		 * @return currently selected login field
 		 */
 		getCurrentLoginField(): number;
+
 		/**
 		 * Gets index of current login state. 2 is username/password form, 4 is authenticator form
 		 *
 		 * @return current login state index
 		 */
 		getLoginIndex(): number;
+
 		/**
 		 * Gets the account type of the logged in player.
 		 *
 		 * @return the account type
 		 * @deprecated see Varbits#ACCOUNT_TYPE
 		 */
-		/** @deprecated */
 		getAccountType(): net.runelite.api.vars.AccountType;
+
 		getCanvas(): java.awt.Canvas;
+
 		/**
 		 * Gets the current FPS (frames per second).
 		 *
 		 * @return the FPS
 		 */
 		getFPS(): number;
+
 		/**
 		 * Gets the x-axis coordinate of the camera.
 		 * <p>
@@ -183,12 +191,14 @@ declare namespace net.runelite.api {
 		 * @return the camera x coordinate
 		 */
 		getCameraX(): number;
+
 		/**
 		 * Floating point camera position, x-axis
 		 * @see #getCameraX()
 		 * @return
 		 */
 		getCameraFpX(): number;
+
 		/**
 		 * Gets the y-axis coordinate of the camera.
 		 * <p>
@@ -198,12 +208,14 @@ declare namespace net.runelite.api {
 		 * @return the camera y coordinate
 		 */
 		getCameraY(): number;
+
 		/**
 		 * Floating point camera position, y-axis
 		 * @see #getCameraY()
 		 * @return
 		 */
 		getCameraFpY(): number;
+
 		/**
 		 * Gets the z-axis coordinate of the camera.
 		 * <p>
@@ -213,12 +225,14 @@ declare namespace net.runelite.api {
 		 * @return the camera z coordinate
 		 */
 		getCameraZ(): number;
+
 		/**
 		 * Floating point camera position, z-axis
 		 * @see #getCameraZ()
 		 * @return
 		 */
 		getCameraFpZ(): number;
+
 		/**
 		 * Gets the pitch of the camera.
 		 * <p>
@@ -228,95 +242,111 @@ declare namespace net.runelite.api {
 		 * @return the camera pitch
 		 */
 		getCameraPitch(): number;
+
 		/**
 		 * Floating point camera pitch.
 		 * @see #getCameraPitch()
 		 * @return
 		 */
 		getCameraFpPitch(): number;
+
 		/**
 		 * Gets the yaw of the camera.
 		 *
 		 * @return the camera yaw
 		 */
 		getCameraYaw(): number;
+
 		/**
 		 * Floating point camera yaw
 		 * @see #getCameraYaw()
 		 * @return
 		 */
 		getCameraFpYaw(): number;
+
 		/**
 		 * Gets the current world number of the logged in player.
 		 *
 		 * @return the logged in world number
 		 */
 		getWorld(): number;
+
 		/**
 		 * Gets the canvas height
 		 * @return
 		 */
 		getCanvasHeight(): number;
+
 		/**
 		 * Gets the canvas width
 		 * @return
 		 */
 		getCanvasWidth(): number;
+
 		/**
 		 * Gets the height of the viewport.
 		 *
 		 * @return the viewport height
 		 */
 		getViewportHeight(): number;
+
 		/**
 		 * Gets the width of the viewport.
 		 *
 		 * @return the viewport width
 		 */
 		getViewportWidth(): number;
+
 		/**
 		 * Gets the x-axis offset of the viewport.
 		 *
 		 * @return the x-axis offset
 		 */
 		getViewportXOffset(): number;
+
 		/**
 		 * Gets the y-axis offset of the viewport.
 		 *
 		 * @return the y-axis offset
 		 */
 		getViewportYOffset(): number;
+
 		/**
 		 * Gets the scale of the world (zoom value).
 		 *
 		 * @return the world scale
 		 */
 		getScale(): number;
+
 		/**
 		 * Gets the current position of the mouse on the canvas.
 		 *
 		 * @return the mouse canvas position
 		 */
 		getMouseCanvasPosition(): Point;
+
 		/**
 		 * Gets the logged in player instance.
 		 *
 		 * @return the logged in player
 		 */
 		getLocalPlayer(): Player;
+
 		/**
 		 * Get the local player's follower, such as a pet
 		 * @return
 		 */
 		getFollower(): NPC | null;
+
 		/**
 		 * Gets the item composition corresponding to an items ID.
 		 *
 		 * @param id the item ID
 		 * @return the corresponding item composition
-		 * @see ItemID
+		 * @see net.runelite.api.gameval.ItemID
 		 */
 		getItemDefinition(id: number): ItemComposition;
+
 		/**
 		 * Creates an item icon sprite with passed variables.
 		 *
@@ -336,20 +366,23 @@ declare namespace net.runelite.api {
 			shadowColor: number,
 			stackable: number,
 			noted: boolean,
-			scale: number,
+			scale: number
 		): SpritePixels | null;
+
 		/**
 		 * Get the item model cache. These models are used for drawing widgets of type {@link net.runelite.api.widgets.WidgetType#MODEL}
 		 * and inventory item icons
 		 * @return
 		 */
 		getItemModelCache(): NodeCache;
+
 		/**
 		 * Get the item sprite cache. These are 2d SpritePixels which are used to raster item images on the inventory and
 		 * on widgets of type {@link net.runelite.api.widgets.WidgetType#GRAPHIC}
 		 * @return
 		 */
 		getItemSpriteCache(): NodeCache;
+
 		/**
 		 * Loads and creates the sprite images of the passed archive and file IDs.
 		 *
@@ -358,45 +391,49 @@ declare namespace net.runelite.api {
 		 * @param fileId the sprites file ID
 		 * @return the sprite image of the file
 		 */
-		getSprites(
-			source: IndexDataBase,
-			archiveId: number,
-			fileId: number,
-		): SpritePixels[] | null;
+		getSprites(source: IndexDataBase, archiveId: number, fileId: number): SpritePixels[] | null;
+
 		/**
 		 * Gets the sprite index.
 		 */
 		getIndexSprites(): IndexDataBase;
+
 		/**
 		 * Gets the script index.
 		 */
 		getIndexScripts(): IndexDataBase;
+
 		/**
 		 * Gets the config index.
 		 */
 		getIndexConfig(): IndexDataBase;
+
 		/**
 		 * Gets an index by id
 		 */
 		getIndex(id: number): IndexDataBase;
+
 		/**
 		 * Gets the current mouse button that is pressed.
 		 *
 		 * @return the pressed mouse button
 		 */
 		getMouseCurrentButton(): number;
+
 		/**
 		 * Checks whether a widget is currently being dragged.
 		 *
 		 * @return true if dragging a widget, false otherwise
 		 */
 		isDraggingWidget(): boolean;
+
 		/**
 		 * Gets the widget currently being dragged.
 		 *
 		 * @return the dragged widget, null if not dragging any widget
 		 */
 		getDraggedWidget(): net.runelite.api.widgets.Widget | null;
+
 		/**
 		 * Gets the widget that is being dragged on.
 		 * <p>
@@ -406,12 +443,14 @@ declare namespace net.runelite.api {
 		 * @return the dragged on widget, null if not dragging any widget
 		 */
 		getDraggedOnWidget(): net.runelite.api.widgets.Widget | null;
+
 		/**
 		 * Sets the widget that is being dragged on.
 		 *
 		 * @param widget the new dragged on widget
 		 */
 		setDraggedOnWidget(widget: net.runelite.api.widgets.Widget): void;
+
 		/**
 		 * Get the number of client cycles the current dragged widget
 		 * has been dragged for.
@@ -419,26 +458,28 @@ declare namespace net.runelite.api {
 		 * @return
 		 */
 		getDragTime(): number;
+
 		/**
 		 * Gets Interface ID of the root widget
 		 */
 		getTopLevelInterfaceId(): number;
+
 		/**
 		 * Gets the root widgets.
 		 *
 		 * @return the root widgets
 		 */
 		getWidgetRoots(): net.runelite.api.widgets.Widget[];
+
 		/**
 		 * Gets a widget corresponding to the passed widget info.
 		 *
 		 * @param widget the widget info
 		 * @return the widget
+		 * @deprecated
 		 */
-		/** @deprecated */
-		getWidget(
-			widget: net.runelite.api.widgets.WidgetInfo,
-		): net.runelite.api.widgets.Widget | null;
+		getWidget(widget: net.runelite.api.widgets.WidgetInfo): net.runelite.api.widgets.Widget | null;
+
 		/**
 		 * Gets a widget by its raw group ID and child ID.
 		 *
@@ -446,16 +487,15 @@ declare namespace net.runelite.api {
 		 * @param childId the child widget ID
 		 * @return the widget corresponding to the group and child pair
 		 */
-		getWidget(
-			groupId: number,
-			childId: number,
-		): net.runelite.api.widgets.Widget | null;
+		getWidget(groupId: number, childId: number): net.runelite.api.widgets.Widget | null;
+
 		/**
 		 * Gets a widget by its component id.
 		 *
 		 * @param componentId the component id
 		 */
 		getWidget(componentId: number): net.runelite.api.widgets.Widget | null;
+
 		/**
 		 * Gets an array containing the x-axis canvas positions
 		 * of all widgets.
@@ -463,6 +503,7 @@ declare namespace net.runelite.api {
 		 * @return array of x-axis widget coordinates
 		 */
 		getWidgetPositionsX(): number[];
+
 		/**
 		 * Gets an array containing the y-axis canvas positions
 		 * of all widgets.
@@ -470,18 +511,21 @@ declare namespace net.runelite.api {
 		 * @return array of y-axis widget coordinates
 		 */
 		getWidgetPositionsY(): number[];
+
 		/**
 		 * Gets the current run energy of the logged in player.
 		 *
-		 * @return the run energy in units of 1/100th of an percentage (max 10000)
+		 * @return the run energy in units of 1/100th of an percentage
 		 */
 		getEnergy(): number;
+
 		/**
 		 * Gets the current weight of the logged in player.
 		 *
 		 * @return the weight
 		 */
 		getWeight(): number;
+
 		/**
 		 * Gets an array of options that can currently be used on other players.
 		 * <p>
@@ -491,37 +535,54 @@ declare namespace net.runelite.api {
 		 * @return an array of options
 		 */
 		getPlayerOptions(): string[];
+
 		/**
 		 * Gets an array of whether an option is enabled or not.
 		 *
 		 * @return the option priorities
 		 */
 		getPlayerOptionsPriorities(): boolean[];
+
 		/**
 		 * Gets an array of player menu types.
 		 *
 		 * @return the player menu types
 		 */
 		getPlayerMenuTypes(): number[];
+
 		/**
 		 * Gets a list of all RuneScape worlds.
 		 *
 		 * @return world list
 		 */
 		getWorldList(): World[];
+
+		/**
+		 * Get the client menu.
+		 */
+		getMenu(): Menu;
+
 		/**
 		 * Create a new menu entry
 		 * @param idx the index to create the menu entry at. Accepts negative indexes eg. -1 inserts at the end.
 		 * @return the newly created menu entry
+		 * @see #getMenu()
+		 * @see Menu#createMenuEntry(int)
+		 * @deprecated
 		 */
 		createMenuEntry(idx: number): MenuEntry;
+
 		/**
 		 * Gets an array of currently open right-click menu entries that can be
 		 * clicked and activated.
 		 *
 		 * @return array of open menu entries
+		 * @see #getMenu()
+		 * @see Menu#getMenuEntries()
+		 * @deprecated
 		 */
 		getMenuEntries(): MenuEntry[];
+
 		/**
 		 * Sets the array of open menu entries.
 		 * <p>
@@ -529,79 +590,103 @@ declare namespace net.runelite.api {
 		 * event, since setting the menu entries will be overwritten the next frame
 		 *
 		 * @param entries new array of open menu entries
+		 * @see #getMenu()
+		 * @see Menu#setMenuEntries(MenuEntry[])
+		 * @deprecated
 		 */
 		setMenuEntries(entries: MenuEntry[]): void;
+
 		/**
 		 * Checks whether a right-click menu is currently open.
 		 *
 		 * @return true if a menu is open, false otherwise
 		 */
 		isMenuOpen(): boolean;
+
 		/**
 		 * Returns whether the currently open menu is scrollable.
 		 * @return
 		 */
 		isMenuScrollable(): boolean;
+
 		/**
 		 * Get the number of entries the currently open menu has been scrolled down.
 		 * @return
 		 */
 		getMenuScroll(): number;
+
 		/**
 		 * Set the number of entries the currently open menu has been scrolled down.
 		 * @param scroll
 		 */
 		setMenuScroll(scroll: number): void;
+
 		/**
 		 * Get the menu x location. Only valid if the menu is open.
 		 *
 		 * @return the menu x location
+		 * @see Menu#getMenuX()
+		 * @deprecated
 		 */
 		getMenuX(): number;
+
 		/**
 		 * Get the menu y location. Only valid if the menu is open.
 		 *
 		 * @return the menu y location
+		 * @see Menu#getMenuY()
+		 * @deprecated
 		 */
 		getMenuY(): number;
+
 		/**
 		 * Get the menu height. Only valid if the menu is open.
 		 *
 		 * @return the menu height
+		 * @see Menu#getMenuHeight()
+		 * @deprecated
 		 */
 		getMenuHeight(): number;
+
 		/**
 		 * Get the menu width. Only valid if the menu is open.
 		 *
 		 * @return the menu width
+		 * @see Menu#getMenuWidth()
+		 * @deprecated
 		 */
 		getMenuWidth(): number;
+
 		/**
 		 * Gets the angle of the map, or target camera yaw.
 		 *
 		 * @return the map angle
 		 * @see #getCameraYawTarget()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getMapAngle(): number;
+
 		/**
 		 * Checks whether the client window is currently resized.
 		 *
 		 * @return true if resized, false otherwise
 		 */
 		isResized(): boolean;
+
 		/**
 		 * Gets the client revision number.
 		 *
 		 * @return the revision
 		 */
 		getRevision(): number;
+
 		/**
 		 * Gets an array of all client varplayers.
 		 *
 		 * @return local player variables
 		 */
 		getVarps(): number[];
+
 		/**
 		 * Get an array of all server varplayers. These vars are only
 		 * modified by the server, and so represent the server's idea of
@@ -609,19 +694,22 @@ declare namespace net.runelite.api {
 		 * @return the server varps
 		 */
 		getServerVarps(): number[];
+
 		/**
 		 * Gets an array of all client variables.
 		 */
-		getVarcMap(): Record<number, Record<string, any>>;
+		getVarcMap(): Record<number, any>;
+
 		/**
 		 * Gets a value corresponding to the passed varbit.
 		 *
 		 * @param varbit the varbit id
 		 * @return the value
 		 * @see Client#getVarbitValue(int)
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getVar(varbit: number): number;
+
 		/**
 		 * Gets the value of the given varbit.
 		 *
@@ -629,6 +717,7 @@ declare namespace net.runelite.api {
 		 * @return the value
 		 */
 		getVarbitValue(varbit: number): number;
+
 		/**
 		 * Gets the value of the given varbit.
 		 * This returns the server's idea of the value, not the client's. This is
@@ -638,6 +727,7 @@ declare namespace net.runelite.api {
 		 * @return the value
 		 */
 		getServerVarbitValue(varbit: number): number;
+
 		/**
 		 * Gets the value of a given VarPlayer.
 		 *
@@ -645,6 +735,7 @@ declare namespace net.runelite.api {
 		 * @return the value
 		 */
 		getVarpValue(varpId: number): number;
+
 		/**
 		 * Gets the value of a given VarPlayer.
 		 * This returns the server's idea of the value, not the client's. This is
@@ -655,34 +746,39 @@ declare namespace net.runelite.api {
 		 * @return the value
 		 */
 		getServerVarpValue(varpId: number): number;
+
 		/**
 		 * Gets the value of a given VarClientInt
 		 *
-		 * @param var the {@link VarClientInt}
+		 * @param var the {@link net.runelite.api.gameval.VarClientID}
 		 * @return the value
 		 */
 		getVarcIntValue(variable: number): number;
+
 		/**
 		 * Gets the value of a given VarClientStr
 		 *
-		 * @param var the {@link VarClientStr}
+		 * @param var the {@link net.runelite.api.gameval.VarClientID}
 		 * @return the value
 		 */
 		getVarcStrValue(variable: number): string;
+
 		/**
 		 * Sets a VarClientString to the passed value
 		 *
-		 * @param var the {@link VarClientStr}
+		 * @param var the {@link net.runelite.api.gameval.VarClientID}
 		 * @param value the new value
 		 */
 		setVarcStrValue(variable: number, value: string): void;
+
 		/**
 		 * Sets a VarClientInt to the passed value
 		 *
-		 * @param var the {@link VarClientInt}
+		 * @param var the {@link net.runelite.api.gameval.VarClientID}
 		 * @param value the new value
 		 */
 		setVarcIntValue(variable: number, value: number): void;
+
 		/**
 		 * Sets the value of a varbit
 		 *
@@ -690,6 +786,7 @@ declare namespace net.runelite.api {
 		 * @param value the new value
 		 */
 		setVarbit(varbit: number, value: number): void;
+
 		/**
 		 * Gets the varbit composition for a given varbit id
 		 *
@@ -697,30 +794,34 @@ declare namespace net.runelite.api {
 		 * @return
 		 */
 		getVarbit(id: number): VarbitComposition | null;
+
 		/**
 		 * Gets the value of a given variable.
 		 *
 		 * @param varps passed varbits
 		 * @param varbitId the variable ID
 		 * @return the value
-		 * @see Varbits
+		 * @see net.runelite.api.gameval.VarbitID
 		 */
 		getVarbitValue(varps: number[], varbitId: number): number;
+
 		/**
 		 * Sets the value of a given variable.
 		 *
 		 * @param varps passed varbits
 		 * @param varbit the variable
 		 * @param value the value
-		 * @see Varbits
+		 * @see net.runelite.api.gameval.VarbitID
 		 */
 		setVarbitValue(varps: number[], varbit: number, value: number): void;
+
 		/**
 		 * Mark the given varp as changed, causing var listeners to be
 		 * triggered next tick
 		 * @param varp
 		 */
 		queueChangedVarp(varp: number): void;
+
 		/**
 		 * Open an interface.
 		 * @param componentId component id to open the interface at
@@ -731,11 +832,8 @@ declare namespace net.runelite.api {
 		 * @return the {@link WidgetNode} for the interface. This should be closed later by calling
 		 * {{@link #closeInterface(WidgetNode, boolean)}.
 		 */
-		openInterface(
-			componentId: number,
-			interfaceId: number,
-			modalMode: number,
-		): WidgetNode;
+		openInterface(componentId: number, interfaceId: number, modalMode: number): WidgetNode;
+
 		/**
 		 * Close an interface
 		 * @param interfaceNode the {@link WidgetNode} linking the interface into the component tree
@@ -743,12 +841,21 @@ declare namespace net.runelite.api {
 		 * @throws IllegalArgumentException if the interfaceNode is not linked into the component tree
 		 */
 		closeInterface(interfaceNode: WidgetNode, unload: boolean): void;
+
 		/**
 		 * Gets the widget flags table.
 		 *
 		 * @return the widget flags table
 		 */
-		getWidgetFlags(): HashTable<IntegerNode>;
+		getWidgetFlags(): HashTable<net.runelite.api.widgets.WidgetConfigNode>;
+
+		/**
+		 * Get the widget config for a given widget
+		 * @param w
+		 * @return
+		 */
+		getWidgetConfig(w: net.runelite.api.widgets.Widget): net.runelite.api.widgets.WidgetConfigNode | null;
+
 		/**
 		 * Gets the widget node component table.
 		 *
@@ -756,19 +863,23 @@ declare namespace net.runelite.api {
 		 * @see WidgetNode
 		 */
 		getComponentTable(): HashTable<WidgetNode>;
+
 		/**
 		 * Gets an array of current grand exchange offers.
 		 *
 		 * @return all grand exchange offers
 		 */
 		getGrandExchangeOffers(): GrandExchangeOffer[];
+
 		/**
 		 * Checks whether or not a prayer is currently active.
 		 *
 		 * @param prayer the prayer
 		 * @return true if the prayer is active, false otherwise
+		 * @deprecated this method does not properly handle deadeye/eagle eye or mystic vigour/might
 		 */
 		isPrayerActive(prayer: Prayer): boolean;
+
 		/**
 		 * Gets the current experience towards a skill.
 		 *
@@ -776,93 +887,102 @@ declare namespace net.runelite.api {
 		 * @return the experience
 		 */
 		getSkillExperience(skill: Skill): number;
+
 		/**
 		 * Get the total experience of the player
 		 *
 		 * @return
 		 */
 		getOverallExperience(): number;
+
 		/**
 		 * Refreshes the chat.
 		 */
 		refreshChat(): void;
+
 		/**
 		 * Gets the map of chat buffers.
 		 *
 		 * @return the chat buffers
 		 */
 		getChatLineMap(): Record<number, ChatLineBuffer>;
+
 		/**
 		 * Map of message node id to message node
 		 *
 		 * @return the map
 		 */
 		getMessages(): IterableHashTable<MessageNode>;
+
 		/**
 		 * Gets the object composition corresponding to an objects ID.
 		 *
 		 * @param objectId the object ID
 		 * @return the corresponding object composition
-		 * @see ObjectID
+		 * @see net.runelite.api.gameval.ObjectID
 		 */
 		getObjectDefinition(objectId: number): ObjectComposition;
+
 		/**
 		 * Gets the NPC composition corresponding to an NPCs ID.
 		 *
 		 * @param npcId the npc ID
 		 * @return the corresponding NPC composition
-		 * @see NpcID
+		 * @see net.runelite.api.gameval.NpcID
 		 */
 		getNpcDefinition(npcId: number): NPCComposition;
+
 		/**
 		 * Gets the {@link StructComposition} for a given struct ID
 		 *
 		 * @see StructID
 		 */
 		getStructComposition(structID: number): StructComposition;
+
 		/**
 		 * Gets the client's cache of in memory struct compositions
 		 */
 		getStructCompositionCache(): NodeCache;
+
 		/**
 		 * Gets a entry out of a DBTable Row
 		 */
-		getDBTableField(
-			rowID: number,
-			column: number,
-			tupleIndex: number,
-		): Record<string, any>[];
+		getDBTableField(rowID: number, column: number, tupleIndex: number): any[];
+
 		getDBRowConfig(rowID: number): net.runelite.api.dbtable.DBRowConfig;
+
 		/**
 		 * Uses an index to find rows containing a certain value in a column.
 		 * An index must exist for this column.
 		 */
-		getDBRowsByValue(
-			table: number,
-			column: number,
-			tupleIndex: number,
-			value: Record<string, any>,
-		): Array<number>;
+		getDBRowsByValue(table: number, column: number, tupleIndex: number, value: any): number[];
+
+		/**
+		 * Gets all rows in a DBTable
+		 */
+		getDBTableRows(table: number): number[];
+
 		/**
 		 * Get a map element config by id
 		 *
 		 * @param id the id
 		 */
-		getMapElementConfig(
-			id: number,
-		): net.runelite.api.worldmap.MapElementConfig;
+		getMapElementConfig(id: number): net.runelite.api.worldmap.MapElementConfig;
+
 		/**
 		 * Gets a sprite of the map scene
 		 *
 		 * @return the sprite
 		 */
 		getMapScene(): IndexedSprite[];
+
 		/**
 		 * Gets an array of currently drawn mini-map dots.
 		 *
 		 * @return all mini-map dots
 		 */
 		getMapDots(): SpritePixels[];
+
 		/**
 		 * Gets the local clients game cycle.
 		 * <p>
@@ -871,30 +991,35 @@ declare namespace net.runelite.api {
 		 * @return the game cycle
 		 */
 		getGameCycle(): number;
+
 		/**
 		 * Gets an array of current map icon sprites.
 		 *
 		 * @return the map icons
 		 */
 		getMapIcons(): SpritePixels[];
+
 		/**
 		 * Gets an array of mod icon sprites.
 		 *
 		 * @return the mod icons
 		 */
 		getModIcons(): IndexedSprite[];
+
 		/**
 		 * Replaces the current mod icons with a new array.
 		 *
 		 * @param modIcons the new mod icons
 		 */
 		setModIcons(modIcons: IndexedSprite[]): void;
+
 		/**
 		 * Creates an empty indexed sprite.
 		 *
 		 * @return the sprite
 		 */
 		createIndexedSprite(): IndexedSprite;
+
 		/**
 		 * Creates a sprite image with given width and height containing the
 		 * pixels.
@@ -904,21 +1029,35 @@ declare namespace net.runelite.api {
 		 * @param height the height
 		 * @return the sprite image
 		 */
-		createSpritePixels(
-			pixels: number[],
-			width: number,
-			height: number,
-		): SpritePixels;
+		createSpritePixels(pixels: number[], width: number, height: number): SpritePixels;
+
 		/**
 		 * Gets the location of the local player.
 		 *
 		 * @return the local player location
 		 */
 		getLocalDestinationLocation(): net.runelite.api.coords.LocalPoint | null;
+
 		/**
 		 * Creates a RuneLiteObject, which is a modified {@link GraphicsObject}
 		 */
 		createRuneLiteObject(): RuneLiteObject;
+
+		/**
+		 * Registers a new {@link RuneLiteObjectController} to its corresponding {@link WorldView}.
+		 */
+		registerRuneLiteObject(controller: RuneLiteObjectController): void;
+
+		/**
+		 * Removes a new {@link RuneLiteObjectController} from its corresponding {@link WorldView}.
+		 */
+		removeRuneLiteObject(controller: RuneLiteObjectController): void;
+
+		/**
+		 * Checks whether a {@link RuneLiteObjectController} is registered to any {@link WorldView}.
+		 */
+		isRuneLiteObjectRegistered(controller: RuneLiteObjectController): boolean;
+
 		/**
 		 * Loads an unlit model from the cache. The returned model shares
 		 * data such as faces, face colors, face transparencies, and vertex points with
@@ -931,8 +1070,13 @@ declare namespace net.runelite.api {
 		 * @return the model or null if it is loading or nonexistent
 		 */
 		loadModelData(id: number): ModelData | null;
+
 		mergeModels(models: ModelData[], length: number): ModelData;
 		mergeModels(...models: ModelData[]): ModelData;
+
+		mergeModels(models: Model[], length: number): Model;
+		mergeModels(...models: Model[]): Model;
+
 		/**
 		 * Loads and lights a model from the cache
 		 *
@@ -942,6 +1086,7 @@ declare namespace net.runelite.api {
 		 * @return the model or null if it is loading or nonexistent
 		 */
 		loadModel(id: number): Model | null;
+
 		/**
 		 * Loads a model from the cache and also recolors it
 		 *
@@ -950,28 +1095,28 @@ declare namespace net.runelite.api {
 		 * @param colorToReplace array of hsl color values to replace in the model
 		 * @return the model or null if it is loading or nonexistent
 		 */
-		loadModel(
-			id: number,
-			colorToFind: number[],
-			colorToReplace: number[],
-		): Model | null;
+		loadModel(id: number, colorToFind: number[], colorToReplace: number[]): Model | null;
+
 		/**
 		 * Loads an animation from the cache
 		 *
 		 * @param id the ID of the animation. Any int is allowed, but implementations in the client
-		 * should be defined in {@link AnimationID}
+		 * should be defined in {@link net.runelite.api.gameval.AnimationID}
 		 */
 		loadAnimation(id: number): Animation;
+
 		/**
 		 * Gets the music volume
 		 * @return volume 0-255 inclusive
 		 */
 		getMusicVolume(): number;
+
 		/**
 		 * Sets the music volume
 		 * @param volume 0-255 inclusive
 		 */
 		setMusicVolume(volume: number): void;
+
 		/**
 		 * Play a sound effect at the player's current location. This is how UI,
 		 * and player-generated (e.g. mining, woodcutting) sound effects are
@@ -981,6 +1126,7 @@ declare namespace net.runelite.api {
 		 * {@link SoundEffectID} for some common ones
 		 */
 		playSoundEffect(id: number): void;
+
 		/**
 		 * Play a sound effect from some point in the world.
 		 *
@@ -992,6 +1138,7 @@ declare namespace net.runelite.api {
 		 * from
 		 */
 		playSoundEffect(id: number, x: number, y: number, range: number): void;
+
 		/**
 		 * Play a sound effect from some point in the world.
 		 *
@@ -1003,13 +1150,8 @@ declare namespace net.runelite.api {
 		 * from
 		 * @param delay the amount of frames before the sound starts playing
 		 */
-		playSoundEffect(
-			id: number,
-			x: number,
-			y: number,
-			range: number,
-			delay: number,
-		): void;
+		playSoundEffect(id: number, x: number, y: number, range: number, delay: number): void;
+
 		/**
 		 * Plays a sound effect, even if the player's sound effect volume is muted.
 		 *
@@ -1018,12 +1160,20 @@ declare namespace net.runelite.api {
 		 *               in the settings interface. if the sound effect volume is not muted, uses the set volume
 		 */
 		playSoundEffect(id: number, volume: number): void;
+
+		/**
+		 * Get the currently playing midi requests.
+		 * @return
+		 */
+		getActiveMidiRequests(): MidiRequest[];
+
 		/**
 		 * Gets the clients graphic buffer provider.
 		 *
 		 * @return the buffer provider
 		 */
 		getBufferProvider(): BufferProvider;
+
 		/**
 		 * Gets the amount of client ticks since the last mouse movement occurred.
 		 *
@@ -1031,11 +1181,13 @@ declare namespace net.runelite.api {
 		 * @see Constants#CLIENT_TICK_LENGTH
 		 */
 		getMouseIdleTicks(): number;
+
 		/**
 		 * Gets the time at which the last mouse press occurred in milliseconds since
 		 * the UNIX epoch.
 		 */
 		getMouseLastPressedMillis(): number;
+
 		/**
 		 * Gets the amount of client ticks since the last keyboard press occurred.
 		 *
@@ -1043,6 +1195,7 @@ declare namespace net.runelite.api {
 		 * @see Constants#CLIENT_TICK_LENGTH
 		 */
 		getKeyboardIdleTicks(): number;
+
 		/**
 		 * Changes how game behaves based on memory mode. Low memory mode skips
 		 * drawing of all floors and renders ground textures in low quality.
@@ -1050,57 +1203,68 @@ declare namespace net.runelite.api {
 		 * @param lowMemory if we are running in low memory mode or not
 		 */
 		changeMemoryMode(lowMemory: boolean): void;
+
 		/**
 		 * Get the item container for an inventory.
 		 *
 		 * @param inventory the inventory type
 		 * @return the item container
-		 * @see InventoryID
+		 * @see net.runelite.api.gameval.InventoryID
 		 */
 		getItemContainer(inventory: InventoryID): ItemContainer | null;
+
 		/**
 		 * Get an item container by id
 		 *
 		 * @param id the inventory id
 		 * @return the item container
-		 * @see InventoryID
+		 * @see net.runelite.api.gameval.InventoryID
 		 */
 		getItemContainer(id: number): ItemContainer | null;
+
 		/**
 		 * Get all item containers
 		 * @return
 		 */
 		getItemContainers(): HashTable<ItemContainer>;
+
 		/**
 		 * Gets the length of the cs2 vm's int stack
 		 */
 		getIntStackSize(): number;
+
 		/**
 		 * Sets the length of the cs2 vm's int stack
 		 */
 		setIntStackSize(stackSize: number): void;
+
 		/**
 		 * Gets the cs2 vm's int stack
 		 */
 		getIntStack(): number[];
+
 		/**
-		 * Gets the length of the cs2 vm's string stack
+		 * Gets the length of the cs2 vm's object stack
 		 */
-		getStringStackSize(): number;
+		getObjectStackSize(): number;
+
 		/**
-		 * Sets the length of the cs2 vm's string stack
+		 * Sets the length of the cs2 vm's object stack
 		 */
-		setStringStackSize(stackSize: number): void;
+		setObjectStackSize(stackSize: number): void;
+
 		/**
-		 * Gets the cs2 vm's string stack
+		 * Gets the cs2 vm's object stack
 		 */
-		getStringStack(): string[];
+		getObjectStack(): any[];
+
 		/**
 		 * Get the size of one of the cs2 vm's arrays.
 		 * @param arrayId the array id
 		 * @return
 		 */
 		getArraySizes(arrayId: number): number;
+
 		/**
 		 * Get one of the cs2 vm's arrays. Use {@link #getArraySizes(int)} to get
 		 * the array length.
@@ -1108,18 +1272,21 @@ declare namespace net.runelite.api {
 		 * @return
 		 */
 		getArray(arrayId: number): number[];
+
 		/**
 		 * Gets the cs2 vm's active widget
 		 *
 		 * This is used for all {@code cc_*} operations with a {@code 0} operand
 		 */
 		getScriptActiveWidget(): net.runelite.api.widgets.Widget;
+
 		/**
 		 * Gets the cs2 vm's "dot" widget
 		 *
 		 * This is used for all {@code .cc_*} operations with a {@code 1} operand
 		 */
 		getScriptDotWidget(): net.runelite.api.widgets.Widget;
+
 		/**
 		 * Checks whether a player is on the friends list.
 		 *
@@ -1128,30 +1295,35 @@ declare namespace net.runelite.api {
 		 * @return true if the player is friends
 		 */
 		isFriended(name: string, mustBeLoggedIn: boolean): boolean;
+
 		/**
 		 * Retrieve the friends chat manager
 		 *
 		 * @return
 		 */
 		getFriendsChatManager(): FriendsChatManager | null;
+
 		/**
 		 * Retrieve the nameable container containing friends
 		 *
 		 * @return
 		 */
 		getFriendContainer(): FriendContainer;
+
 		/**
 		 * Retrieve the nameable container containing ignores
 		 *
 		 * @return
 		 */
 		getIgnoreContainer(): NameableContainer<Ignore>;
+
 		/**
 		 * Gets the clients saved preferences.
 		 *
 		 * @return the client preferences
 		 */
 		getPreferences(): Preferences;
+
 		/**
 		 * Get the target camera yaw.
 		 * The target yaw is the yaw the camera should use based on player input.
@@ -1161,6 +1333,7 @@ declare namespace net.runelite.api {
 		 * @return the target camera yaw
 		 */
 		getCameraYawTarget(): number;
+
 		/**
 		 * Get the target camera pitch
 		 * The target pitch is the pitch the camera should use based on player input.
@@ -1170,29 +1343,34 @@ declare namespace net.runelite.api {
 		 * @return the target camera pitch
 		 */
 		getCameraPitchTarget(): number;
+
 		/**
 		 * Set the target camera yaw
 		 *
 		 * @param cameraYawTarget target camera yaw
 		 */
 		setCameraYawTarget(cameraYawTarget: number): void;
+
 		/**
 		 * Set the target camera pitch
 		 *
 		 * @param cameraPitchTarget target camera pitch
 		 */
 		setCameraPitchTarget(cameraPitchTarget: number): void;
+
 		/**
 		 * Sets the camera speed
 		 * @param speed
 		 */
 		setCameraSpeed(speed: number): void;
+
 		/**
 		 * Sets the mask for which mouse buttons control the camera.
 		 * Use 0 for the default behavior of mouse button 4 if "middle mouse moves camera" is on.
 		 * @param mask
 		 */
 		setCameraMouseButtonMask(mask: number): void;
+
 		/**
 		 * Sets whether the camera pitch can exceed the normal limits set
 		 * by the RuneScape client.
@@ -1200,38 +1378,45 @@ declare namespace net.runelite.api {
 		 * @param enabled new camera pitch relaxer value
 		 */
 		setCameraPitchRelaxerEnabled(enabled: boolean): void;
+
 		/**
 		 * Sets if the moving the camera horizontally should be backwards
 		 */
 		setInvertYaw(invertYaw: boolean): void;
+
 		/**
 		 * Sets if the moving the camera vertically should be backwards
 		 */
 		setInvertPitch(invertPitch: boolean): void;
+
 		/**
 		 * Gets the world map overview.
 		 *
 		 * @return the world map overview
 		 * @see #getWorldMap()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getRenderOverview(): RenderOverview;
+
 		/**
 		 * Get the world map
 		 */
 		getWorldMap(): net.runelite.api.worldmap.WorldMap;
+
 		/**
 		 * Checks whether the client is in stretched mode.
 		 *
 		 * @return true if the client is in stretched mode, false otherwise
 		 */
 		isStretchedEnabled(): boolean;
+
 		/**
 		 * Sets the client stretched mode state.
 		 *
 		 * @param state new stretched mode state
 		 */
 		setStretchedEnabled(state: boolean): void;
+
 		/**
 		 * Checks whether the client is using fast
 		 * rendering techniques when stretching the canvas.
@@ -1239,6 +1424,7 @@ declare namespace net.runelite.api {
 		 * @return true if stretching is fast rendering, false otherwise
 		 */
 		isStretchedFast(): boolean;
+
 		/**
 		 * Sets whether to use fast rendering techniques
 		 * when stretching the canvas.
@@ -1246,6 +1432,7 @@ declare namespace net.runelite.api {
 		 * @param state new fast rendering state
 		 */
 		setStretchedFast(state: boolean): void;
+
 		/**
 		 * Sets whether to force integer scale factor by rounding scale
 		 * factors towards {@code zero} when stretching.
@@ -1253,18 +1440,21 @@ declare namespace net.runelite.api {
 		 * @param state new integer scaling state
 		 */
 		setStretchedIntegerScaling(state: boolean): void;
+
 		/**
 		 * Sets whether to keep aspect ratio when stretching.
 		 *
 		 * @param state new keep aspect ratio state
 		 */
 		setStretchedKeepAspectRatio(state: boolean): void;
+
 		/**
 		 * Sets the scaling factor when scaling resizable mode.
 		 *
 		 * @param factor new scaling factor
 		 */
 		setScalingFactor(factor: number): void;
+
 		/**
 		 * Invalidates cached dimensions that are
 		 * used for stretching and scaling.
@@ -1274,18 +1464,21 @@ declare namespace net.runelite.api {
 		 *               false otherwise.
 		 */
 		invalidateStretching(resize: boolean): void;
+
 		/**
 		 * Gets the current stretched dimensions of the client.
 		 *
 		 * @return the stretched dimensions
 		 */
 		getStretchedDimensions(): java.awt.Dimension;
+
 		/**
 		 * Gets the real dimensions of the client before being stretched.
 		 *
 		 * @return the real dimensions
 		 */
 		getRealDimensions(): java.awt.Dimension;
+
 		/**
 		 * Changes the selected world to log in to.
 		 * <p>
@@ -1295,10 +1488,12 @@ declare namespace net.runelite.api {
 		 * @param world the world to switch to
 		 */
 		changeWorld(world: World): void;
+
 		/**
 		 * Creates a new instance of a world.
 		 */
 		createWorld(): World;
+
 		/**
 		 * Draws an instance map for the current viewed plane.
 		 *
@@ -1306,6 +1501,7 @@ declare namespace net.runelite.api {
 		 * @return the map sprite
 		 */
 		drawInstanceMap(z: number): SpritePixels;
+
 		/**
 		 * Executes a client script from the cache
 		 *
@@ -1316,112 +1512,95 @@ declare namespace net.runelite.api {
 		 * @param args the script id, then any additional arguments to execute the script with
 		 * @see ScriptID
 		 */
-		runScript(...args: Record<string, any>): void;
+		runScript(...args: any[]): void;
+
 		/**
 		 * Creates a blank ScriptEvent for executing a ClientScript2 script
 		 *
 		 * @param args the script id, then any additional arguments to execute the script with
 		 * @see ScriptID
 		 */
-		createScriptEvent(...args: Record<string, any>[]): ScriptEvent;
+		createScriptEvent(...args: any[]): ScriptEvent;
+
 		/**
 		 * Checks whether or not there is any active hint arrow.
 		 *
 		 * @return true if there is a hint arrow, false otherwise
 		 */
 		hasHintArrow(): boolean;
+
 		/**
 		 * Gets the type of hint arrow currently displayed.
 		 *
 		 * @return the hint arrow type
 		 */
 		getHintArrowType(): number;
+
 		/**
 		 * Clears the current hint arrow.
 		 */
 		clearHintArrow(): void;
+
 		/**
 		 * Sets a hint arrow to point to the passed location.
 		 *
 		 * @param point the location
 		 */
 		setHintArrow(point: net.runelite.api.coords.WorldPoint): void;
+
 		/**
 		 * Sets the hint arrow to the passsed point
 		 *
 		 * @param point
 		 */
 		setHintArrow(point: net.runelite.api.coords.LocalPoint): void;
+
 		/**
 		 * Sets a hint arrow to point to the passed player.
 		 *
 		 * @param player the player
 		 */
 		setHintArrow(player: Player): void;
+
 		/**
 		 * Sets a hint arrow to point to the passed NPC.
 		 *
 		 * @param npc the NPC
 		 */
 		setHintArrow(npc: NPC): void;
+
 		/**
 		 * Gets the world point that the hint arrow is directed at.
 		 *
 		 * @return hint arrow target
 		 */
 		getHintArrowPoint(): net.runelite.api.coords.WorldPoint;
+
 		/**
 		 * Gets the player that the hint arrow is directed at.
 		 *
 		 * @return hint arrow target
 		 */
 		getHintArrowPlayer(): Player;
+
 		/**
 		 * Gets the NPC that the hint arrow is directed at.
 		 *
 		 * @return hint arrow target
 		 */
 		getHintArrowNpc(): NPC;
-		/**
-		 * Checks whether animation smoothing is enabled for players.
-		 *
-		 * @return true if player animation smoothing is enabled, false otherwise
-		 */
-		isInterpolatePlayerAnimations(): boolean;
-		/**
-		 * Sets the animation smoothing state for players.
-		 *
-		 * @param interpolate the new smoothing state
-		 */
-		setInterpolatePlayerAnimations(interpolate: boolean): void;
-		/**
-		 * Checks whether animation smoothing is enabled for NPC.
-		 *
-		 * @return true if NPC animation smoothing is enabled, false otherwise
-		 */
-		isInterpolateNpcAnimations(): boolean;
-		/**
-		 * Sets the animation smoothing state for NPCs.
-		 *
-		 * @param interpolate the new smoothing state
-		 */
-		setInterpolateNpcAnimations(interpolate: boolean): void;
-		/**
-		 * Checks whether animation smoothing is enabled for objects.
-		 *
-		 * @return true if object animation smoothing is enabled, false otherwise
-		 */
-		isInterpolateObjectAnimations(): boolean;
-		/**
-		 * Sets the animation smoothing state for objects.
-		 *
-		 * @param interpolate the new smoothing state
-		 */
-		setInterpolateObjectAnimations(interpolate: boolean): void;
+
+		getAnimationInterpolationFilter(): (id: number) => boolean;
+		setAnimationInterpolationFilter(filter: (id: number) => boolean): void;
+
 		getBoostedSkillLevels(): number[];
+
 		getRealSkillLevels(): number[];
+
 		getSkillExperiences(): number[];
+
 		queueChangedSkill(skill: Skill): void;
+
 		/**
 		 * Gets a mapping of sprites to override.
 		 * <p>
@@ -1429,6 +1608,7 @@ declare namespace net.runelite.api {
 		 * and the value the sprite to replace it with.
 		 */
 		getSpriteOverrides(): Record<number, SpritePixels>;
+
 		/**
 		 * Gets a mapping of widget sprites to override.
 		 * <p>
@@ -1436,146 +1616,182 @@ declare namespace net.runelite.api {
 		 * and the value the sprite to replace the widgets sprite with.
 		 */
 		getWidgetSpriteOverrides(): Record<number, SpritePixels>;
+
 		/**
 		 * Sets the compass sprite.
 		 *
 		 * @param spritePixels the new sprite
 		 */
 		setCompass(spritePixels: SpritePixels): void;
+
 		/**
 		 * Returns widget sprite cache, to be used with {@link Client#getSpriteOverrides()}
 		 *
 		 * @return the cache
 		 */
 		getWidgetSpriteCache(): NodeCache;
+
 		/**
 		 * Gets the current server tick count.
 		 *
 		 * @return the tick count
 		 */
 		getTickCount(): number;
+
 		/**
 		 * Sets the current server tick count.
 		 *
 		 * @param tickCount the new tick count
 		 */
 		setTickCount(tickCount: number): void;
+
 		/**
 		 * Sets the inventory drag delay in client game cycles (20ms).
 		 *
 		 * @param delay the number of game cycles to delay dragging
+		 * @deprecated
 		 */
-		/** @deprecated */
 		setInventoryDragDelay(delay: number): void;
+
+		/**
+		 * Get the hostname of the current world
+		 * @return
+		 */
+		getWorldHost(): string;
+
 		/**
 		 * Gets a set of current world types that apply to the logged in world.
 		 *
 		 * @return the types for current world
 		 */
-		getWorldType(): EnumSet<WorldType>;
+		getWorldType(): Set<WorldType>;
+
 		/**
 		 * Get the camera mode
 		 * @return 0 for normal, 1 for free camera
 		 */
 		getCameraMode(): number;
+
 		/**
 		 * Set the camera mode
 		 * @param mode 0 for normal, 1 for free camera
 		 */
 		setCameraMode(mode: number): void;
+
 		/**
 		 * Get the camera focus point x
 		 * Typically this is the player position, but can be other points in cutscenes or in free camera mode.
 		 * @return
 		 */
 		getCameraFocalPointX(): number;
+
 		/**
 		 * Sets the camera focus point x. Requires the {@link #getCameraMode()} to be free camera.
 		 * @param x
 		 */
 		setCameraFocalPointX(x: number): void;
+
 		/**
 		 * Get the camera focus point y
 		 * Typically this is the player position, but can be other points in cutscenes or in free camera mode.
 		 * @return
 		 */
 		getCameraFocalPointY(): number;
+
 		/**
 		 * Sets the camera focus point y. Requires the {@link #getCameraMode()} to be free camera.
 		 * @param y
 		 */
 		setCameraFocalPointY(y: number): void;
+
 		/**
 		 * Get the camera focus point z
 		 * Typically this is the player position, but can be other points in cutscenes or in free camera mode.
 		 * @return
 		 */
 		getCameraFocalPointZ(): number;
+
 		/**
 		 * Sets the camera focus point z. Requires the {@link #getCameraMode()} to be free camera.
 		 * @param z
 		 */
 		setCameraFocalPointZ(z: number): void;
+
 		/**
 		 * Sets the normal moving speed when using oculus orb (default value is 12)
 		 */
 		setFreeCameraSpeed(speed: number): void;
+
 		/**
 		 * Gets the enabled state for the Oculus orb mode
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getOculusOrbState(): number;
+
 		/**
 		 * Sets the enabled state for the Oculus orb state
 		 *
 		 * @param state boolean enabled value
+		 * @deprecated
 		 */
-		/** @deprecated */
 		setOculusOrbState(state: number): void;
+
 		/**
 		 * Sets the normal moving speed when using oculus orb (default value is 12)
+		 * @deprecated
 		 */
-		/** @deprecated */
 		setOculusOrbNormalSpeed(speed: number): void;
+
 		/**
 		 * Gets local X coord where the camera is pointing when the Oculus orb is active
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getOculusOrbFocalPointX(): number;
+
 		/**
 		 * Gets local Y coord where the camera is pointing when the Oculus orb is active
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getOculusOrbFocalPointY(): number;
+
 		/**
 		 * Opens in-game world hopper interface
 		 */
 		openWorldHopper(): void;
+
 		/**
 		 * Hops using in-game world hopper widget to another world
 		 * @param world target world to hop to
 		 */
 		hopToWorld(world: World): void;
+
 		/**
 		 * Sets the RGB color of the skybox
 		 */
 		setSkyboxColor(skyboxColor: number): void;
+
 		/**
 		 * Gets the RGB color of the skybox
 		 */
 		getSkyboxColor(): number;
+
 		isGpu(): boolean;
 		setGpuFlags(gpuflags: number): void;
+
 		setExpandedMapLoading(chunks: number): void;
 		getExpandedMapLoading(): number;
+
 		get3dZoom(): number;
 		getCenterX(): number;
 		getCenterY(): number;
+
 		getTextureProvider(): TextureProvider;
+
 		getRasterizer3D_clipMidX2(): number;
 		getRasterizer3D_clipNegativeMidX(): number;
 		getRasterizer3D_clipNegativeMidY(): number;
 		getRasterizer3D_clipMidY2(): number;
+
 		checkClickbox(
 			projection: Projection,
 			model: Model,
@@ -1583,82 +1799,101 @@ declare namespace net.runelite.api {
 			x: number,
 			y: number,
 			z: number,
-			hash: number,
+			hash: number
 		): void;
+
 		/**
 		 * Is a widget is in target mode?
 		 */
 		isWidgetSelected(): boolean;
+
 		/**
 		 * Sets if a widget is in target mode
 		 */
 		setWidgetSelected(selected: boolean): void;
+
 		/**
 		 * Get the selected widget, such as a selected spell or selected item (eg. "Use")
 		 * @return the selected widget
 		 */
 		getSelectedWidget(): net.runelite.api.widgets.Widget | null;
+
 		/**
 		 * Returns client item composition cache
 		 */
 		getItemCompositionCache(): NodeCache;
+
 		/**
 		 * Returns client object composition cache
 		 * @return
 		 */
 		getObjectCompositionCache(): NodeCache;
+
 		/**
 		 * Returns the client {@link Animation} cache
 		 */
 		getAnimationCache(): NodeCache;
+
 		/**
 		 * Returns the array of cross sprites that appear and animate when left-clicking
 		 */
 		getCrossSprites(): SpritePixels[];
+
 		getEnum(id: number): EnumComposition;
+
 		/**
 		 * Draws a menu in the 2010 interface style.
 		 *
 		 * @param alpha background transparency of the menu
 		 */
 		draw2010Menu(alpha: number): void;
+
 		/**
 		 * Draws a menu in the OSRS interface style.
 		 *
 		 * @param alpha background transparency of the menu
 		 */
 		drawOriginalMenu(alpha: number): void;
+
 		resetHealthBarCaches(): void;
+
 		/**
 		 * Returns the max item index + 1 from cache
 		 */
 		getItemCount(): number;
+
 		/**
 		 * Makes all widgets behave as if they are {@link WidgetConfig#WIDGET_USE_TARGET}
 		 */
 		setAllWidgetsAreOpTargetable(value: boolean): void;
+
 		/**
 		 * Sets the result count for GE search
 		 */
 		setGeSearchResultCount(count: number): void;
+
 		/**
 		 * Sets the array of item ids for GE search
 		 */
 		setGeSearchResultIds(ids: number[]): void;
+
 		/**
 		 * Sets the starting index in the item id array for GE search
 		 */
 		setGeSearchResultIndex(index: number): void;
+
 		/**
 		 * Sets the image to be used for the login screen, provided as SpritePixels
 		 * If the image is larger than half the width of fixed mode,
 		 * it won't get mirrored to the other side of the screen
 		 */
 		setLoginScreen(pixels: SpritePixels): void;
+
 		/**
 		 * Sets whether the flames on the login screen should be rendered
 		 */
 		setShouldRenderLoginScreenFire(val: boolean): void;
+
 		/**
 		 * Test if a key is pressed
 		 * @param keycode the keycode
@@ -1666,6 +1901,7 @@ declare namespace net.runelite.api {
 		 * @see KeyCode
 		 */
 		isKeyPressed(keycode: number): boolean;
+
 		/**
 		 * Get the list of message ids for the recently received cross-world messages. The upper 32 bits of the
 		 * id is the world id, the lower is a sequence number per-world.
@@ -1673,93 +1909,108 @@ declare namespace net.runelite.api {
 		 * @return
 		 */
 		getCrossWorldMessageIds(): number[];
+
 		/**
 		 * Get the index of the next message to be inserted in the cross world message id list
 		 *
 		 * @return
 		 */
 		getCrossWorldMessageIdsIndex(): number;
+
 		/**
 		 * Get the primary clan channel the player is in.
 		 * @return
 		 */
 		getClanChannel(): net.runelite.api.clan.ClanChannel | null;
+
 		/**
 		 * Get the guest clan channel the player is in.
 		 * @return
 		 */
 		getGuestClanChannel(): net.runelite.api.clan.ClanChannel | null;
+
 		/**
 		 * Get clan settings for the clan the user is in.
 		 * @return
 		 */
 		getClanSettings(): net.runelite.api.clan.ClanSettings | null;
+
 		/**
 		 * Get the guest clan's settings.
 		 * @return
 		 */
 		getGuestClanSettings(): net.runelite.api.clan.ClanSettings | null;
+
 		/**
 		 * Get clan channel by id.
 		 * @param clanId the clan id
 		 * @return
 		 * @see net.runelite.api.clan.ClanID
 		 */
-		getClanChannel(
-			clanId: number,
-		): net.runelite.api.clan.ClanChannel | null;
+		getClanChannel(clanId: number): net.runelite.api.clan.ClanChannel | null;
+
 		/**
 		 * Get clan settings by id
 		 * @param clanId the clan id
 		 * @return
 		 * @see net.runelite.api.clan.ClanID
 		 */
-		getClanSettings(
-			clanId: number,
-		): net.runelite.api.clan.ClanSettings | null;
+		getClanSettings(clanId: number): net.runelite.api.clan.ClanSettings | null;
+
 		setUnlockedFps(unlock: boolean): void;
 		setUnlockedFpsTarget(fps: number): void;
+
 		/**
 		 * Gets the ambient sound effects
 		 * @return
+		 * @deprecated
 		 */
 		getAmbientSoundEffects(): java.util.Deque<AmbientSoundEffect>;
+
 		/**
 		 * Set the amount of time until the client automatically logs out due to idle input.
 		 * @param ticks client ticks
 		 */
 		setIdleTimeout(ticks: number): void;
+
 		/**
 		 * Get the amount of time until the client automatically logs out due to idle input.
 		 * @return client ticks
 		 */
 		getIdleTimeout(): number;
+
 		/**
 		 * Get whether minimap zoom is enabled
 		 * @return
 		 */
 		isMinimapZoom(): boolean;
+
 		/**
 		 * Set whether minimap zoom is enabled
 		 * @param minimapZoom
 		 */
 		setMinimapZoom(minimapZoom: boolean): void;
+
 		/**
 		 * Gets the number of pixels per tile on the minimap. The default is 4.
 		 * @return
 		 */
 		getMinimapZoom(): number;
+
 		/**
 		 * Set the number of pixels per tile on the minimap. The default is 4.
 		 * @param zoom
 		 */
 		setMinimapZoom(zoom: number): void;
+
 		/**
 		 * Sets a callback to override the drawing of tiles on the minimap.
 		 * Will be called per tile per frame.
 		 */
-		setMinimapTileDrawer(drawTile: any): void;
+		setMinimapTileDrawer(drawTile: TileFunction): void;
+
 		getRasterizer(): Rasterizer;
+
 		menuAction(
 			p0: number,
 			p1: number,
@@ -1767,19 +2018,48 @@ declare namespace net.runelite.api {
 			id: number,
 			itemId: number,
 			option: string,
-			target: string,
+			target: string
 		): void;
+
 		/**
 		 * Get worldview by id
 		 * @param id id, or -1 for top level worldview
 		 * @return
 		 */
 		getWorldView(id: number): WorldView;
+
 		/**
 		 * Get the top level world view
 		 * @return
 		 */
 		getTopLevelWorldView(): WorldView;
+
+		/**
+		 * Whether camera shaking effects are disabled at e.g. Barrows, ToA
+		 * @return
+		 */
+		isCameraShakeDisabled(): boolean;
+
+		/**
+		 * Set whether to disable camera shaking effects at e.g. Barrows, ToA
+		 * @param disabled
+		 */
+		setCameraShakeDisabled(disabled: boolean): void;
+
+		/**
+		 * Gets the current draw2D mask. 
+		 * @return the current mask
+		 * @see Client#setDraw2DMask(int)
+		 */
+		getDraw2DMask(): number;
+
+		/**
+		 * Sets the current draw2D mask.
+		 * Use bit operations on the value returned by {@link Client#getDraw2DMask()} to modify specific features.
+		 * @param mask The new mask.
+		 */
+		setDraw2DMask(mask: number): void;
+
 		/**
 		 * Contains a 3D array of template chunks for instanced areas.
 		 * <p>
@@ -1799,9 +2079,11 @@ declare namespace net.runelite.api {
 		 * @return the array of instance template chunks
 		 * @see Constants#CHUNK_SIZE
 		 * @see InstanceTemplates
+		 * @see WorldView#getInstanceTemplateChunks()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getInstanceTemplateChunks(): number[][][];
+
 		/**
 		 * Returns a 2D array containing XTEA encryption keys used to decrypt
 		 * map region files.
@@ -1813,63 +2095,61 @@ declare namespace net.runelite.api {
 		 * spread across 4 integers.
 		 *
 		 * @return the XTEA encryption keys
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getXteaKeys(): number[][];
+
 		/**
 		 * Checks whether the scene is in an instanced region.
+		 * @see WorldView#isInstance()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		isInInstancedRegion(): boolean;
+
 		/**
 		 * Gets an array of map region IDs that are currently loaded.
 		 *
 		 * @return the map regions
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getMapRegions(): number[];
+
 		/**
 		 * Gets the current scene
+		 * @see WorldView#getScene()
+		 * @deprecated
 		 */
-		/** @deprecated */
-		getScene(): Scene;
+		getScene(): Scene | null;
+
 		/**
 		 * Gets a list of all valid players from the player cache.
 		 *
 		 * @return a list of all players
+		 * @see WorldView#players()
+		 * @deprecated
 		 */
-		/** @deprecated */
-		getPlayers(): Array<Player>;
+		getPlayers(): Player[];
+
 		/**
 		 * Gets a list of all valid NPCs from the NPC cache.
 		 *
 		 * @return a list of all NPCs
+		 * @see WorldView#npcs()
+		 * @deprecated
 		 */
-		/** @deprecated */
-		getNpcs(): Array<NPC>;
-		/**
-		 * Gets an array of all cached NPCs.
-		 *
-		 * @return cached NPCs
-		 */
-		/** @deprecated */
-		getCachedNPCs(): NPC[];
-		/**
-		 * Gets an array of all cached players.
-		 *
-		 * @return cached players
-		 */
-		/** @deprecated */
-		getCachedPlayers(): Player[];
+		getNpcs(): NPC[];
+
 		/**
 		 * Gets an array of tile collision data.
 		 * <p>
 		 * The index into the array is the plane/z-axis coordinate.
 		 *
 		 * @return the collision data
+		 * @see WorldView#getCollisionMaps()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getCollisionMaps(): CollisionData[] | null;
+
 		/**
 		 * Gets the current plane the player is on.
 		 * <p>
@@ -1881,25 +2161,31 @@ declare namespace net.runelite.api {
 		 * level use a tile offset and are still considered plane 0 by the game.
 		 *
 		 * @return the plane
+		 * @see WorldView#getPlane()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getPlane(): number;
+
 		/**
 		 * Gets a 3D array containing the heights of tiles in the
 		 * current scene.
 		 *
 		 * @return the tile heights
+		 * @see WorldView#getTileHeights()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getTileHeights(): number[][][];
+
 		/**
 		 * Gets a 3D array containing the settings of tiles in the
 		 * current scene.
 		 *
 		 * @return the tile settings
+		 * @see WorldView#getTileSettings()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getTileSettings(): number[][][];
+
 		/**
 		 * Returns the x-axis base coordinate.
 		 * <p>
@@ -1907,9 +2193,11 @@ declare namespace net.runelite.api {
 		 * the current scene (ie. the bottom-left most coordinates in the scene).
 		 *
 		 * @return the base x-axis coordinate
+		 * @see WorldView#getBaseX()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getBaseX(): number;
+
 		/**
 		 * Returns the y-axis base coordinate.
 		 * <p>
@@ -1917,9 +2205,11 @@ declare namespace net.runelite.api {
 		 * the current scene (ie. the bottom-left most coordinates in the scene).
 		 *
 		 * @return the base y-axis coordinate
+		 * @see WorldView#getBaseY()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getBaseY(): number;
+
 		/**
 		 * Create a projectile.
 		 * @param id projectile/spotanim id
@@ -1936,8 +2226,8 @@ declare namespace net.runelite.api {
 		 * @param targetX target x - if an actor target is supplied should be the target x
 		 * @param targetY target y - if an actor target is supplied should be the target y
 		 * @return the new projectile
+		 * @deprecated
 		 */
-		/** @deprecated */
 		createProjectile(
 			id: number,
 			plane: number,
@@ -1949,30 +2239,78 @@ declare namespace net.runelite.api {
 			slope: number,
 			startHeight: number,
 			endHeight: number,
-			target: Actor,
+			target: Actor | null,
 			targetX: number,
-			targetY: number,
+			targetY: number
 		): Projectile;
+
+		/**
+		 * Create a projectile.
+		 * @param spotanimId spotanim id
+		 * @param source source position
+		 * @param sourceHeightOffset source height offset
+		 * @param sourceActor source actor
+		 * @param target target position
+		 * @param targetHeightOffset target height offset
+		 * @param targetActor target actor
+		 * @param startCycle start time
+		 * @param endCycle end time
+		 * @param slope slope
+		 * @param startPos offset from the start where the projectile starts
+		 * @see net.runelite.api.gameval.SpotanimID
+		 * @return the new projectile
+		 */
+		createProjectile(
+			spotanimId: number,
+			source: net.runelite.api.coords.WorldPoint,
+			sourceHeightOffset: number,
+			sourceActor: Actor | null,
+			target: net.runelite.api.coords.WorldPoint,
+			targetHeightOffset: number,
+			targetActor: Actor | null,
+			startCycle: number,
+			endCycle: number,
+			slope: number,
+			startPos: number
+		): Projectile;
+
 		/**
 		 * Gets a list of all projectiles currently spawned.
 		 *
 		 * @return all projectiles
 		 */
-		/** @deprecated */
 		getProjectiles(): java.util.Deque<Projectile>;
+
 		/**
 		 * Gets a list of all graphics objects currently drawn.
 		 *
 		 * @return all graphics objects
+		 * @see WorldView#getGraphicsObjects()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getGraphicsObjects(): java.util.Deque<GraphicsObject>;
+
 		/**
 		 * Gets the currently selected tile. (ie. last right clicked tile)
 		 *
 		 * @return the selected tile
+		 * @see WorldView#getSelectedSceneTile()
+		 * @deprecated
 		 */
-		/** @deprecated */
 		getSelectedSceneTile(): Tile | null;
+
+		/**
+		 * Applies an animation to a Model. The returned model is shared and shouldn't be used
+		 * after any other call to applyTransformations, including calls made by the client internally.
+		 * Vertices are cloned from the source model. Face transparencies are copied if either animation
+		 * animates transparency, otherwise it will share a reference. All other fields share a reference.
+		 */
+		applyTransformations(
+			model: Model,
+			animA: Animation | null,
+			frameA: number,
+			animB: Animation | null,
+			frameB: number
+		): Model;
 	}
-}
+}