@deafwave/osrs-botmaker-types 0.2.12 → 0.3.0

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

@@ -25,300 +25,179 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 declare namespace net.runelite.api {
-/**
- * Enumeration of message types that can be received in the chat.
- */
-export class ChatMessageType
-{
-	/**
-	 * A normal game message.
-	 */
-static GAMEMESSAGE = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
- 	* A message in the public chat from a moderator
- 	*/
-static MODCHAT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A message in the public chat.
-	 */
-static PUBLICCHAT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A private message from another player.
-	 */
-static PRIVATECHAT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A message that the game engine sends.
-	 */
-static ENGINE = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A message received when a friend logs in or out.
-	 */
-static LOGINLOGOUTNOTIFICATION = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A private message sent to another player.
-	 */
-static PRIVATECHATOUT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A private message received from a moderator.
-	 */
-static MODPRIVATECHAT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A message received in friends chat.
-	 */
-static FRIENDSCHAT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A message received with information about the current friends chat.
-	 */
-static FRIENDSCHATNOTIFICATION = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
 	/**
-	 * A trade request being sent.
-	 */
-static TRADE_SENT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A game broadcast.
-	 */
-static BROADCAST = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * An abuse report submitted.
-	 */
-static SNAPSHOTFEEDBACK = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * Examine item description.
-	 */
-static ITEM_EXAMINE = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * Examine NPC description.
-	 */
-static NPC_EXAMINE = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * Examine object description.
-	 */
-static OBJECT_EXAMINE = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * Adding player to friend list.
-	 */
-static FRIENDNOTIFICATION = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * Adding player to ignore list.
-	 */
-static IGNORENOTIFICATION = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A chat message in a clan chat.
-	 */
-static CLAN_CHAT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A system message in a clan chat.
-	 */
-static CLAN_MESSAGE = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A chat message in the guest clan chat.
-	 */
-static CLAN_GUEST_CHAT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A system message in the guest clan chat.
-	 */
-static CLAN_GUEST_MESSAGE = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * An autotyper message from a player.
-	 */
-static AUTOTYPER = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * An autotyper message from a mod.
-	 */
-static MODAUTOTYPER = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A game message. (ie. when a setting is changed)
-	 */
-static CONSOLE = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A message received when somebody sends a trade offer.
-	 */
-static TRADEREQ = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A message received when completing a trade or a duel
-	 */
-static TRADE = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A message received when somebody sends a duel offer.
-	 */
-static CHALREQ_TRADE = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A message received when someone sends a friends chat challenge offer.
-	 */
-static CHALREQ_FRIENDSCHAT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A message that was filtered.
-	 */
-static SPAM = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A message that is relating to the player.
-	 */
-static PLAYERRELATED = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * A message that times out after 10 seconds.
-	 */
-static TENSECTIMEOUT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * The "Welcome to RuneScape" message
-	 */
-static WELCOME = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * Clan creation invitation.
-	 */
-static CLAN_CREATION_INVITATION = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * Challenge offer for the clan tab
-	 */
-static CHALREQ_CLANCHAT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static CLAN_GIM_FORM_GROUP = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static CLAN_GIM_GROUP_WITH = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static CLAN_GIM_CHAT = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static CLAN_GIM_MESSAGE = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * Chat type for npc and player dialog
-	 */
-static DIALOG = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * Chat type for dialog with a graphic/object
-	 */
-static MESBOX = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * An unknown message type.
-	 */
-static UNKNOWN = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-	/**
-	 * Utility method that maps the type value to its respective
-	 * {@link ChatMessageType} value.
-	 *
-	 * @param type the raw type
-	 * @return appropriate message type, or {@link #UNKNOWN}
-	 */
-	static of(type: number): ChatMessageType;
+	 * Enumeration of message types that can be received in the chat.
+	 */
+	export class ChatMessageType {
+		/**
+		 * A normal game message.
+		 */
+		static GAMEMESSAGE: ChatMessageType;
+		/**
+		 * A message in the public chat from a moderator
+		 */
+		static MODCHAT: ChatMessageType;
+		/**
+		 * A message in the public chat.
+		 */
+		static PUBLICCHAT: ChatMessageType;
+		/**
+		 * A private message from another player.
+		 */
+		static PRIVATECHAT: ChatMessageType;
+		/**
+		 * A message that the game engine sends.
+		 */
+		static ENGINE: ChatMessageType;
+		/**
+		 * A message received when a friend logs in or out.
+		 */
+		static LOGINLOGOUTNOTIFICATION: ChatMessageType;
+		/**
+		 * A private message sent to another player.
+		 */
+		static PRIVATECHATOUT: ChatMessageType;
+		/**
+		 * A private message received from a moderator.
+		 */
+		static MODPRIVATECHAT: ChatMessageType;
+		/**
+		 * A message received in friends chat.
+		 */
+		static FRIENDSCHAT: ChatMessageType;
+		/**
+		 * A message received with information about the current friends chat.
+		 */
+		static FRIENDSCHATNOTIFICATION: ChatMessageType;
+		/**
+		 * A trade request being sent.
+		 */
+		static TRADE_SENT: ChatMessageType;
+		/**
+		 * A game broadcast.
+		 */
+		static BROADCAST: ChatMessageType;
+		/**
+		 * An abuse report submitted.
+		 */
+		static SNAPSHOTFEEDBACK: ChatMessageType;
+		/**
+		 * Examine item description.
+		 */
+		static ITEM_EXAMINE: ChatMessageType;
+		/**
+		 * Examine NPC description.
+		 */
+		static NPC_EXAMINE: ChatMessageType;
+		/**
+		 * Examine object description.
+		 */
+		static OBJECT_EXAMINE: ChatMessageType;
+		/**
+		 * Adding player to friend list.
+		 */
+		static FRIENDNOTIFICATION: ChatMessageType;
+		/**
+		 * Adding player to ignore list.
+		 */
+		static IGNORENOTIFICATION: ChatMessageType;
+		/**
+		 * A chat message in a clan chat.
+		 */
+		static CLAN_CHAT: ChatMessageType;
+		/**
+		 * A system message in a clan chat.
+		 */
+		static CLAN_MESSAGE: ChatMessageType;
+		/**
+		 * A chat message in the guest clan chat.
+		 */
+		static CLAN_GUEST_CHAT: ChatMessageType;
+		/**
+		 * A system message in the guest clan chat.
+		 */
+		static CLAN_GUEST_MESSAGE: ChatMessageType;
+		/**
+		 * An autotyper message from a player.
+		 */
+		static AUTOTYPER: ChatMessageType;
+		/**
+		 * An autotyper message from a mod.
+		 */
+		static MODAUTOTYPER: ChatMessageType;
+		/**
+		 * A game message. (ie. when a setting is changed)
+		 */
+		static CONSOLE: ChatMessageType;
+		/**
+		 * A message received when somebody sends a trade offer.
+		 */
+		static TRADEREQ: ChatMessageType;
+		/**
+		 * A message received when completing a trade or a duel
+		 */
+		static TRADE: ChatMessageType;
+		/**
+		 * A message received when somebody sends a duel offer.
+		 */
+		static CHALREQ_TRADE: ChatMessageType;
+		/**
+		 * A message received when someone sends a friends chat challenge offer.
+		 */
+		static CHALREQ_FRIENDSCHAT: ChatMessageType;
+		/**
+		 * A message that was filtered.
+		 */
+		static SPAM: ChatMessageType;
+		/**
+		 * A message that is relating to the player.
+		 */
+		static PLAYERRELATED: ChatMessageType;
+		/**
+		 * A message that times out after 10 seconds.
+		 */
+		static TENSECTIMEOUT: ChatMessageType;
+		/**
+		 * The "Welcome to RuneScape" message
+		 */
+		static WELCOME: ChatMessageType;
+		/**
+		 * Clan creation invitation.
+		 */
+		static CLAN_CREATION_INVITATION: ChatMessageType;
+		/**
+		 * Challenge offer for the clan tab
+		 */
+		static CHALREQ_CLANCHAT: ChatMessageType;
+
+		static CLAN_GIM_FORM_GROUP: ChatMessageType;
+		static CLAN_GIM_GROUP_WITH: ChatMessageType;
+		static CLAN_GIM_CHAT: ChatMessageType;
+		static CLAN_GIM_MESSAGE: ChatMessageType;
+		/**
+		 * Chat type for npc and player dialog
+		 */
+		static DIALOG: ChatMessageType;
+		/**
+		 * Chat type for dialog with a graphic/object
+		 */
+		static MESBOX: ChatMessageType;
+		/**
+		 * An unknown message type.
+		 */
+		static UNKNOWN: ChatMessageType;
+
+		getType(): number;
+
+		/**
+		 * Utility method that maps the type value to its respective
+		 * {@link ChatMessageType} value.
+		 *
+		 * @param type the raw type
+		 * @return appropriate message type, or {@link #UNKNOWN}
+		 */
+		static of(type: number): ChatMessageType;
+
+		toString(): string;
+	}
 }
-}

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

@@ -473,7 +473,7 @@ declare namespace net.runelite.api {
 		/**
 		 * Gets the current run energy of the logged in player.
 		 *
-		 * @return the run energy in units of 1/100th of an percentage
+		 * @return the run energy in units of 1/100th of an percentage (max 10000)
 		 */
 		getEnergy(): number;
 		/**
@@ -1279,13 +1279,13 @@ declare namespace net.runelite.api {
 		 *
 		 * @return the stretched dimensions
 		 */
-		getStretchedDimensions(): Dimension;
+		getStretchedDimensions(): java.awt.Dimension;
 		/**
 		 * Gets the real dimensions of the client before being stretched.
 		 *
 		 * @return the real dimensions
 		 */
-		getRealDimensions(): Dimension;
+		getRealDimensions(): java.awt.Dimension;
 		/**
 		 * Changes the selected world to log in to.
 		 * <p>
@@ -1723,7 +1723,7 @@ declare namespace net.runelite.api {
 		 * Gets the ambient sound effects
 		 * @return
 		 */
-		getAmbientSoundEffects(): Deque<AmbientSoundEffect>;
+		getAmbientSoundEffects(): java.util.Deque<AmbientSoundEffect>;
 		/**
 		 * Set the amount of time until the client automatically logs out due to idle input.
 		 * @param ticks client ticks
@@ -1959,14 +1959,14 @@ declare namespace net.runelite.api {
 		 * @return all projectiles
 		 */
 		/** @deprecated */
-		getProjectiles(): Deque<Projectile>;
+		getProjectiles(): java.util.Deque<Projectile>;
 		/**
 		 * Gets a list of all graphics objects currently drawn.
 		 *
 		 * @return all graphics objects
 		 */
 		/** @deprecated */
-		getGraphicsObjects(): Deque<GraphicsObject>;
+		getGraphicsObjects(): java.util.Deque<GraphicsObject>;
 		/**
 		 * Gets the currently selected tile. (ie. last right clicked tile)
 		 *

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

@@ -28,7 +28,7 @@ declare namespace net.runelite.api {
 	/**
 	 * A doubly linked list
 	 */
-	export class Deque<T> extends Iterable<T> {
+	export class Deque<T> extends java.lang.Iterable<T> {
 		/**
 		 * Add a new element to the end of the deque
 		 * @param t the element

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

@@ -25,68 +25,37 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 declare namespace net.runelite.api {
-/**
- * An enumeration of equipment slots in the inventory {@link ItemContainer}.
- * <p>
- * These values are intended for use with the local players equipment
- * {@link ItemContainer} corresponding. For obtaining information about equipment
- * in the {@link PlayerComposition}, use {@link net.runelite.api.kit.KitType}.
- *
- * @see Client#getItemContainer(InventoryID)
- * @see InventoryID#EQUIPMENT
- */
-export class EquipmentInventorySlot
-{
-static HEAD = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static CAPE = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static AMULET = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static WEAPON = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static BODY = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static SHIELD = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static LEGS = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static GLOVES = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static BOOTS = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static RING = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
-static AMMO = {
-/** CAUTION - NOT PERFECTLY TYPED YET */
-getId(): number { return 0; },
-toString(): string { return ""; } };
 	/**
-	 * Gets the index into the item array obtained from
-	 * {@link ItemContainer#getItems()}.
+	 * An enumeration of equipment slots in the inventory {@link ItemContainer}.
+	 * <p>
+	 * These values are intended for use with the local players equipment
+	 * {@link ItemContainer} corresponding. For obtaining information about equipment
+	 * in the {@link PlayerComposition}, use {@link net.runelite.api.kit.KitType}.
 	 *
-	 * @return the raw index
+	 * @see Client#getItemContainer(InventoryID)
+	 * @see InventoryID#EQUIPMENT
 	 */
-	getSlotIdx(): number;
+	export class EquipmentInventorySlot {
+		static HEAD: EquipmentInventorySlot;
+		static CAPE: EquipmentInventorySlot;
+		static AMULET: EquipmentInventorySlot;
+		static WEAPON: EquipmentInventorySlot;
+		static BODY: EquipmentInventorySlot;
+		static SHIELD: EquipmentInventorySlot;
+		static LEGS: EquipmentInventorySlot;
+		static GLOVES: EquipmentInventorySlot;
+		static BOOTS: EquipmentInventorySlot;
+		static RING: EquipmentInventorySlot;
+		static AMMO: EquipmentInventorySlot;
+
+		/**
+		 * Gets the index into the item array obtained from
+		 * {@link ItemContainer#getItems()}.
+		 *
+		 * @return the raw index
+		 */
+		getSlotIdx(): number;
+
+		toString(): string;
+	}
 }
-}

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

@@ -33,6 +33,6 @@ declare namespace net.runelite.api {
 		 * Get the recent logins/logouts of friends from the last few seconds
 		 * @return
 		 */
-		getPendingLogins(): Deque<PendingLogin>;
+		getPendingLogins(): java.util.Deque<PendingLogin>;
 	}
 }