@deafwave/osrs-botmaker-types 0.2.13 → 0.3.0

package/dist/src/types/runelite/net/runelite/client/util/ColorUtil.d.ts

@@ -25,109 +25,108 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 declare namespace net.runelite.client.util {
-export class ColorUtil
-{
-	/**
-	 * Creates a color tag from the given color.
-	 *
-	 * @param color The Color to create a tag from.
-	 * @return      A string of the color tag for the given color.
-	 */
-	private static colorTag(color: Color): string;
-	/**
-	 * Prepends the given str with an opening color tag of the given color.
-	 *
-	 * @param str   The string to be colorized.
-	 * @param color The color to be used in the color tag.
-	 * @return      The passed str with a prepended color tag.
-	 */
-	static prependColorTag(str: string, color: Color): string;
-	/**
-	 * Wraps the given str with a color tag of the given color.
-	 *
-	 * @param str   The string to be colorized.
-	 * @param color The color to be used in the color tag.
-	 * @return      The passed str wrapped with opening and closing color tags.
-	 */
-	static wrapWithColorTag(str: string, color: Color): string;
-	/**
-	 * Converts a given color to it's hexadecimal equivalent.
-	 *
-	 * @param color Color to get hexadecimal string from.
-	 * @return      Hexadecimal string representing the given color, in the form "#abcdef".
-	 */
-	static toHexColor(color: Color): string;
-	/**
-	 * Linearly interpolates between colors a and b by t.
-	 *
-	 * @param a first color
-	 * @param b second color
-	 * @param t factor
-	 * @return  interpolated color
-	 */
-	static colorLerp(a: Color, b: Color, t: number): Color;
-	/**
-	 * Gets the RGB hex color code of the passed color.
-	 *
-	 * @param color The color to get a hex code from.
-	 * @return      A lower-cased string of the RGB hex code of color.
-	 */
-	static colorToHexCode(color: Color): string;
-	/**
-	 * Gets the ARGB hex color code of the passed color.
-	 *
-	 * @param color The color to get a hex code from.
-	 * @return      A lower-cased string of the ARGB hex code of color.
-	 */
-	static colorToAlphaHexCode(color: Color): string;
-	/**
-	 * Gets the same RGB color with the specified alpha value.
-	 *
-	 * @param color The RGB color to use.
-	 * @param alpha The alpha value to use (0-255).
-	 * @return      A Color with the given RGB and alpha.
-	 */
-	static colorWithAlpha(color: Color, alpha: number): Color;
-	/**
-	 * Determines if the passed hex string is an alpha hex color.
-	 *
-	 * @param hex The hex to test.
-	 * @return    boolean
-	 */
-	static isAlphaHex(hex: string): boolean;
-	/**
-	 * Determines if the passed hex string is a hex color.
-	 *
-	 * @param hex The hex to test.
-	 * @return    boolean
-	 */
-	static isHex(hex: string): boolean;
-	/**
-	 * Limits an int to the rgba value range (0-255)
-	 *
-	 * @param value The value for the r, g, b, or a.
-	 * @return      An int between 0 - 255.
-	 */
-	static constrainValue(value: number): number;
-	/**
-	 * Gets the Color from the passed int string.
-	 *
-	 * @param string The int to get a Color object from.
-	 * @return       A Color of the int of color.
-	 */
-	static fromString(string: string): Color;
-	/**
-	 * Gets the Color from the passed hex string.
-	 *
-	 * @param hex The hex to get a Color object from.
-	 * @return    A Color of the hex code of color.
-	 */
-	static fromHex(hex: string): Color;
-	/**
-	 * Creates color from passed object hash code
-	 * @param object object with hashCode
-	 * @return color
-	 */
-	static fromObject(object: Record<string, any>): Color;
+	export class ColorUtil {
+		/**
+		 * Creates a color tag from the given color.
+		 *
+		 * @param color The Color to create a tag from.
+		 * @return      A string of the color tag for the given color.
+		 */
+		private static colorTag(color: java.awt.Color): string;
+		/**
+		 * Prepends the given str with an opening color tag of the given color.
+		 *
+		 * @param str   The string to be colorized.
+		 * @param color The color to be used in the color tag.
+		 * @return      The passed str with a prepended color tag.
+		 */
+		static prependColorTag(str: string, color: java.awt.Color): string;
+		/**
+		 * Wraps the given str with a color tag of the given color.
+		 *
+		 * @param str   The string to be colorized.
+		 * @param color The color to be used in the color tag.
+		 * @return      The passed str wrapped with opening and closing color tags.
+		 */
+		static wrapWithColorTag(str: string, color: java.awt.Color): string;
+		/**
+		 * Converts a given color to it's hexadecimal equivalent.
+		 *
+		 * @param color Color to get hexadecimal string from.
+		 * @return      Hexadecimal string representing the given color, in the form "#abcdef".
+		 */
+		static toHexColor(color: java.awt.Color): string;
+		/**
+		 * Linearly interpolates between colors a and b by t.
+		 *
+		 * @param a first color
+		 * @param b second color
+		 * @param t factor
+		 * @return  interpolated color
+		 */
+		static colorLerp(a: java.awt.Color, b: java.awt.Color, t: number): java.awt.Color;
+		/**
+		 * Gets the RGB hex color code of the passed color.
+		 *
+		 * @param color The color to get a hex code from.
+		 * @return      A lower-cased string of the RGB hex code of color.
+		 */
+		static colorToHexCode(color: java.awt.Color): string;
+		/**
+		 * Gets the ARGB hex color code of the passed color.
+		 *
+		 * @param color The color to get a hex code from.
+		 * @return      A lower-cased string of the ARGB hex code of color.
+		 */
+		static colorToAlphaHexCode(color: java.awt.Color): string;
+		/**
+		 * Gets the same RGB color with the specified alpha value.
+		 *
+		 * @param color The RGB color to use.
+		 * @param alpha The alpha value to use (0-255).
+		 * @return      A Color with the given RGB and alpha.
+		 */
+		static colorWithAlpha(color: java.awt.Color, alpha: number): java.awt.Color;
+		/**
+		 * Determines if the passed hex string is an alpha hex color.
+		 *
+		 * @param hex The hex to test.
+		 * @return    boolean
+		 */
+		static isAlphaHex(hex: string): boolean;
+		/**
+		 * Determines if the passed hex string is a hex color.
+		 *
+		 * @param hex The hex to test.
+		 * @return    boolean
+		 */
+		static isHex(hex: string): boolean;
+		/**
+		 * Limits an int to the rgba value range (0-255)
+		 *
+		 * @param value The value for the r, g, b, or a.
+		 * @return      An int between 0 - 255.
+		 */
+		static constrainValue(value: number): number;
+		/**
+		 * Gets the Color from the passed int string.
+		 *
+		 * @param string The int to get a Color object from.
+		 * @return       A Color of the int of color.
+		 */
+		static fromString(string: string): java.awt.Color;
+		/**
+		 * Gets the Color from the passed hex string.
+		 *
+		 * @param hex The hex to get a Color object from.
+		 * @return    A Color of the hex code of color.
+		 */
+		static fromHex(hex: string): java.awt.Color;
+		/**
+		 * Creates color from passed object hash code
+		 * @param object object with hashCode
+		 * @return color
+		 */
+		static fromObject(object: Record<string, any>): java.awt.Color;
+	}
 }
-}

package/dist/src/types/runelite/net/runelite/client/util/ImageUtil.d.ts

@@ -25,195 +25,199 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 declare namespace net.runelite.client.util {
-/**
- * Various Image/BufferedImage utilities.
- */
-export class ImageUtil
-{
-	/**
-	 * Creates a {@link BufferedImage} from an {@link Image}.
-	 *
-	 * @param image An Image to be converted to a BufferedImage.
-	 * @return      A BufferedImage instance of the same given image.
-	 */
-	static bufferedImageFromImage(image: Image): BufferedImage;
-	/**
-	 * Creates an ARGB {@link BufferedImage} from an {@link Image}.
-	 */
-	static toARGB(image: Image): BufferedImage;
-	/**
-	 * Creates a new image with the same alpha channel, but a constant RGB channel
-	 */
-	static recolorImage(image: Image, rgb: Color): BufferedImage;
 	/**
-	 * Offsets an image's luminance by a given value.
-	 *
-	 * @param rawImg  The image to be darkened or brightened.
-	 * @param offset A signed 8-bit integer value to brighten or darken the image with.
-	 *               Values above 0 will brighten, and values below 0 will darken.
-	 * @return       The given image with its brightness adjusted by the given offset.
+	 * Various Image/BufferedImage utilities.
 	 */
-	static luminanceOffset(rawImg: Image, offset: number): BufferedImage;
+	export class ImageUtil {
+		/**
+		 * Creates a {@link BufferedImage} from an {@link Image}.
+		 *
+		 * @param image An Image to be converted to a BufferedImage.
+		 * @return      A BufferedImage instance of the same given image.
+		 */
+		static bufferedImageFromImage(image: Image): BufferedImage;
+		/**
+		 * Creates an ARGB {@link BufferedImage} from an {@link Image}.
+		 */
+		static toARGB(image: Image): BufferedImage;
+		/**
+		 * Creates a new image with the same alpha channel, but a constant RGB channel
+		 */
+		static recolorImage(image: Image, rgb: java.awt.Color): BufferedImage;
+		/**
+		 * Offsets an image's luminance by a given value.
+		 *
+		 * @param rawImg  The image to be darkened or brightened.
+		 * @param offset A signed 8-bit integer value to brighten or darken the image with.
+		 *               Values above 0 will brighten, and values below 0 will darken.
+		 * @return       The given image with its brightness adjusted by the given offset.
+		 */
+		static luminanceOffset(rawImg: Image, offset: number): BufferedImage;
 		// Set alpha to not offset
-	/**
-	 * Changes an images luminance by a scaling factor
-	 *
-	 * @param rawImg      The image to be darkened or brightened.
-	 * @param percentage The ratio to darken or brighten the given image.
-	 *                   Values above 1 will brighten, and values below 1 will darken.
-	 * @return           The given image with its brightness scaled by the given percentage.
-	 */
-	static luminanceScale(rawImg: Image, percentage: number): BufferedImage;
+		/**
+		 * Changes an images luminance by a scaling factor
+		 *
+		 * @param rawImg      The image to be darkened or brightened.
+		 * @param percentage The ratio to darken or brighten the given image.
+		 *                   Values above 1 will brighten, and values below 1 will darken.
+		 * @return           The given image with its brightness scaled by the given percentage.
+		 */
+		static luminanceScale(rawImg: Image, percentage: number): BufferedImage;
 		// Set alpha to not scale
-	/**
-	 * Offsets an image's alpha component by a given offset.
-	 *
-	 * @param rawImg  The image to be made more or less transparent.
-	 * @param offset A signed 8-bit integer value to modify the image's alpha component with.
-	 *               Values above 0 will increase transparency, and values below 0 will decrease
-	 *               transparency.
-	 * @return       The given image with its alpha component adjusted by the given offset.
-	 */
-	static alphaOffset(rawImg: Image, offset: number): BufferedImage;
-	/**
-	 * Offsets an image's alpha component by a given percentage.
-	 *
-	 * @param rawImg      The image to be made more or less transparent.
-	 * @param percentage The ratio to modify the image's alpha component with.
-	 *                   Values above 1 will increase transparency, and values below 1 will decrease
-	 *                   transparency.
-	 * @return           The given image with its alpha component scaled by the given percentage.
-	 */
-	static alphaOffset(rawImg: Image, percentage: number): BufferedImage;
-	/**
-	 * Creates a grayscale image from the given image.
-	 *
-	 * @param image The source image to be converted.
-	 * @return      A copy of the given imnage, with colors converted to grayscale.
-	 */
-	static grayscaleImage(image: BufferedImage): BufferedImage;
-	/**
-	 * Re-size a BufferedImage to the given dimensions.
-	 *
-	 * @param image the BufferedImage.
-	 * @param newWidth The width to set the BufferedImage to.
-	 * @param newHeight The height to set the BufferedImage to.
-	 * @return The BufferedImage with the specified dimensions
-	 */
-	static resizeImage(image: BufferedImage, newWidth: number, newHeight: number): BufferedImage;
-	/**
-	 * Re-size a BufferedImage to the given dimensions.
-	 *
-	 * @param image the BufferedImage.
-	 * @param newWidth The width to set the BufferedImage to.
-	 * @param newHeight The height to set the BufferedImage to.
-	 * @param preserveAspectRatio Whether to preserve the original image's aspect ratio. When {@code true}, the image
-	 *                               will be scaled to have a maximum of {@code newWidth} width and {@code newHeight}
-	 *                               height.
-	 * @return The BufferedImage with the specified dimensions
-	 */
-	static resizeImage(image: BufferedImage, newWidth: number, newHeight: number, preserveAspectRatio: boolean): BufferedImage;
-	/**
-	 * Re-size a BufferedImage's canvas to the given dimensions.
-	 *
-	 * @param image     The image whose canvas should be re-sized.
-	 * @param newWidth  The width to set the BufferedImage to.
-	 * @param newHeight The height to set the BufferedImage to.
-	 * @return          The BufferedImage centered within canvas of given dimensions.
-	 */
-	static resizeCanvas(image: BufferedImage, newWidth: number, newHeight: number): BufferedImage;
-	/**
-	 * Rotates an image around its center by a given number of radians.
-	 *
-	 * @param image The image to be rotated.
-	 * @param theta The number of radians to rotate the image.
-	 * @return      The given image, rotated by the given theta.
-	 */
-	static rotateImage(image: BufferedImage, theta: number): BufferedImage;
-	/**
-	 * Flips an image horizontally and/or vertically.
-	 *
-	 * @param image      The image to be flipped.
-	 * @param horizontal Whether the image should be flipped horizontally.
-	 * @param vertical   Whether the image should be flipped vertically.
-	 * @return           The given image, flipped horizontally and/or vertically.
-	 */
-	static flipImage(image: BufferedImage, horizontal: boolean, vertical: boolean): BufferedImage;
-	/**
-	 * Outlines non-transparent pixels of a BufferedImage with the given color.
-	 *
-	 * @param image The image to be outlined.
-	 * @param color The color to use for the outline.
-	 * @return      The BufferedImage with its edges outlined with the given color.
-	 */
-	static outlineImage(image: BufferedImage, color: Color): BufferedImage;
-	/**
-	 * Outlines non-transparent pixels of a BufferedImage with the given color. Optionally outlines
-	 * corners in addition to edges.
-	 *
-	 * @param image          The image to be outlined.
-	 * @param color          The color to use for the outline.
-	 * @param outlineCorners Whether to draw an outline around corners, or only around edges.
-	 * @return               The BufferedImage with its edges--and optionally, corners--outlined
-	 *                       with the given color.
-	 */
-	static outlineImage(image: BufferedImage, color: Color, outlineCorners: Boolean): BufferedImage;
-	/**
-	 * @see #loadImageResource(Class, String)
-	 */
-/** @deprecated */
-	static getResourceStreamFromClass(c: any, path: string): BufferedImage;
-	/**
-	 * Reads an image resource from a given path relative to a given class.
-	 * This method is primarily shorthand for the synchronization and error handling required for
-	 * loading image resources from the classpath.
-	 *
-	 * @param c    The class to be referenced for the package path.
-	 * @param path The path, relative to the given class.
-	 * @return     A {@link BufferedImage} of the loaded image resource from the given path.
-	 */
-	static loadImageResource(c: any, path: string): BufferedImage;
-	/**
-	 * Fills all non-transparent pixels of the given image with the given color.
-	 *
-	 * @param image The image which should have its non-transparent pixels filled.
-	 * @param color The color with which to fill pixels.
-	 * @return      The given image with all non-transparent pixels set to the given color.
-	 */
-	static fillImage(image: BufferedImage, color: Color): BufferedImage;
-	/**
-	 * Performs a rescale operation on the image's color components.
-	 *
-	 * @param image   The image to be adjusted.
-	 * @param scales  An array of scale operations to be performed on the image's color components.
-	 * @param offsets An array of offset operations to be performed on the image's color components.
-	 * @return        The modified image after applying the given adjustments.
-	 */
-	private static offset(image: BufferedImage, scales: number[], offsets: number[]): BufferedImage;
-	/**
-	 * Converts the buffered image into a sprite image and returns it
-	 * @param image  The image to be converted
-	 * @param client Current client instance
-	 * @return       The buffered image as a sprite image
-	 */
-	static getImageSpritePixels(image: BufferedImage, client: Client): SpritePixels;
-			// Make any fully transparent pixels fully black, because the sprite draw routines
-			// check for == 0, not actual transparency
-	/**
-	 * Converts an image into an {@code IndexedSprite} instance.
-	 *
-	 * The passed in image can only have at max 255 different colors.
-	 *
-	 * @param image  The image to be converted
-	 * @param client Current client instance
-	 * @return		 The image as an {@code IndexedSprite}
-	 */
-	static getImageIndexedSprite(image: BufferedImage, client: Client): IndexedSprite;
+		/**
+		 * Offsets an image's alpha component by a given offset.
+		 *
+		 * @param rawImg  The image to be made more or less transparent.
+		 * @param offset A signed 8-bit integer value to modify the image's alpha component with.
+		 *               Values above 0 will increase transparency, and values below 0 will decrease
+		 *               transparency.
+		 * @return       The given image with its alpha component adjusted by the given offset.
+		 */
+		static alphaOffset(rawImg: Image, offset: number): BufferedImage;
+		/**
+		 * Offsets an image's alpha component by a given percentage.
+		 *
+		 * @param rawImg      The image to be made more or less transparent.
+		 * @param percentage The ratio to modify the image's alpha component with.
+		 *                   Values above 1 will increase transparency, and values below 1 will decrease
+		 *                   transparency.
+		 * @return           The given image with its alpha component scaled by the given percentage.
+		 */
+		static alphaOffset(rawImg: Image, percentage: number): BufferedImage;
+		/**
+		 * Creates a grayscale image from the given image.
+		 *
+		 * @param image The source image to be converted.
+		 * @return      A copy of the given imnage, with colors converted to grayscale.
+		 */
+		static grayscaleImage(image: BufferedImage): BufferedImage;
+		/**
+		 * Re-size a BufferedImage to the given dimensions.
+		 *
+		 * @param image the BufferedImage.
+		 * @param newWidth The width to set the BufferedImage to.
+		 * @param newHeight The height to set the BufferedImage to.
+		 * @return The BufferedImage with the specified dimensions
+		 */
+		static resizeImage(image: BufferedImage, newWidth: number, newHeight: number): BufferedImage;
+		/**
+		 * Re-size a BufferedImage to the given dimensions.
+		 *
+		 * @param image the BufferedImage.
+		 * @param newWidth The width to set the BufferedImage to.
+		 * @param newHeight The height to set the BufferedImage to.
+		 * @param preserveAspectRatio Whether to preserve the original image's aspect ratio. When {@code true}, the image
+		 *                               will be scaled to have a maximum of {@code newWidth} width and {@code newHeight}
+		 *                               height.
+		 * @return The BufferedImage with the specified dimensions
+		 */
+		static resizeImage(
+			image: BufferedImage,
+			newWidth: number,
+			newHeight: number,
+			preserveAspectRatio: boolean,
+		): BufferedImage;
+		/**
+		 * Re-size a BufferedImage's canvas to the given dimensions.
+		 *
+		 * @param image     The image whose canvas should be re-sized.
+		 * @param newWidth  The width to set the BufferedImage to.
+		 * @param newHeight The height to set the BufferedImage to.
+		 * @return          The BufferedImage centered within canvas of given dimensions.
+		 */
+		static resizeCanvas(image: BufferedImage, newWidth: number, newHeight: number): BufferedImage;
+		/**
+		 * Rotates an image around its center by a given number of radians.
+		 *
+		 * @param image The image to be rotated.
+		 * @param theta The number of radians to rotate the image.
+		 * @return      The given image, rotated by the given theta.
+		 */
+		static rotateImage(image: BufferedImage, theta: number): BufferedImage;
+		/**
+		 * Flips an image horizontally and/or vertically.
+		 *
+		 * @param image      The image to be flipped.
+		 * @param horizontal Whether the image should be flipped horizontally.
+		 * @param vertical   Whether the image should be flipped vertically.
+		 * @return           The given image, flipped horizontally and/or vertically.
+		 */
+		static flipImage(image: BufferedImage, horizontal: boolean, vertical: boolean): BufferedImage;
+		/**
+		 * Outlines non-transparent pixels of a BufferedImage with the given color.
+		 *
+		 * @param image The image to be outlined.
+		 * @param color The color to use for the outline.
+		 * @return      The BufferedImage with its edges outlined with the given color.
+		 */
+		static outlineImage(image: BufferedImage, color: java.awt.Color): BufferedImage;
+		/**
+		 * Outlines non-transparent pixels of a BufferedImage with the given color. Optionally outlines
+		 * corners in addition to edges.
+		 *
+		 * @param image          The image to be outlined.
+		 * @param color          The color to use for the outline.
+		 * @param outlineCorners Whether to draw an outline around corners, or only around edges.
+		 * @return               The BufferedImage with its edges--and optionally, corners--outlined
+		 *                       with the given color.
+		 */
+		static outlineImage(image: BufferedImage, color: java.awt.Color, outlineCorners: Boolean): BufferedImage;
+		/**
+		 * @see #loadImageResource(Class, String)
+		 */
+		/** @deprecated */
+		static getResourceStreamFromClass(c: any, path: string): BufferedImage;
+		/**
+		 * Reads an image resource from a given path relative to a given class.
+		 * This method is primarily shorthand for the synchronization and error handling required for
+		 * loading image resources from the classpath.
+		 *
+		 * @param c    The class to be referenced for the package path.
+		 * @param path The path, relative to the given class.
+		 * @return     A {@link BufferedImage} of the loaded image resource from the given path.
+		 */
+		static loadImageResource(c: any, path: string): BufferedImage;
+		/**
+		 * Fills all non-transparent pixels of the given image with the given color.
+		 *
+		 * @param image The image which should have its non-transparent pixels filled.
+		 * @param color The color with which to fill pixels.
+		 * @return      The given image with all non-transparent pixels set to the given color.
+		 */
+		static fillImage(image: BufferedImage, color: java.awt.Color): BufferedImage;
+		/**
+		 * Performs a rescale operation on the image's color components.
+		 *
+		 * @param image   The image to be adjusted.
+		 * @param scales  An array of scale operations to be performed on the image's color components.
+		 * @param offsets An array of offset operations to be performed on the image's color components.
+		 * @return        The modified image after applying the given adjustments.
+		 */
+		private static offset(image: BufferedImage, scales: number[], offsets: number[]): BufferedImage;
+		/**
+		 * Converts the buffered image into a sprite image and returns it
+		 * @param image  The image to be converted
+		 * @param client Current client instance
+		 * @return       The buffered image as a sprite image
+		 */
+		static getImageSpritePixels(image: BufferedImage, client: Client): SpritePixels;
+		// Make any fully transparent pixels fully black, because the sprite draw routines
+		// check for == 0, not actual transparency
+		/**
+		 * Converts an image into an {@code IndexedSprite} instance.
+		 *
+		 * The passed in image can only have at max 255 different colors.
+		 *
+		 * @param image  The image to be converted
+		 * @param client Current client instance
+		 * @return		 The image as an {@code IndexedSprite}
+		 */
+		static getImageIndexedSprite(image: BufferedImage, client: Client): IndexedSprite;
 		/*
 		 */
 		/*
 		 */
-			// Default to not drawing the pixel.
-			// If the pixel is fully opaque, draw it.
+		// Default to not drawing the pixel.
+		// If the pixel is fully opaque, draw it.
+	}
 }
-}