osrs-tools 2.3.0 → 2.3.5

package/dist/runescape/model/Item/all/MythicalCape.js

@@ -0,0 +1,32 @@
+import { Item } from '../Item';
+const mythicalCapeData = {
+    attackCrush: 1,
+    attackMagic: 3,
+    attackRanged: 0,
+    attackSlash: 1,
+    attackStab: 1,
+    defenceCrush: 3,
+    defenceMagic: 3,
+    defenceRanged: 3,
+    defenceSlash: 3,
+    defenceStab: 3,
+    destroy: 'You can get another cape from Alec Kincade.',
+    equipable: true,
+    examine: 'A cape awarded for completing Dragon Slayer II.',
+    highAlch: 30000,
+    id: 21295,
+    lowAlch: 20000,
+    members: true,
+    meleeStrength: 1,
+    name: 'Mythical cape',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Mythical_cape',
+    prayer: 1,
+    questItem: false,
+    releaseDate: '4 January 2018',
+    stackable: false,
+    tradeable: false,
+    value: 50000,
+    weight: 0.453,
+};
+export const MythicalCape = Item.fromJson(mythicalCapeData);

package/dist/runescape/model/Item/all/Nosepeg.js

@@ -0,0 +1,3 @@
+import { Item } from '../Item';
+const NosePeg1 = new Item(4168, 'Nose peg', 'A peg to protect your nose.', 0, 0, 0, 0.01, true, false, false, '2005-06-07', 'Destroy', false, false, false, 'https://oldschool.runescape.wiki/w/Nose_peg', 'https://oldschool.runescape.wiki/images/6/6a/Nose_peg.png', 0, 0, 0, 0, 0, 0, 0, 0, 0);
+export const Nosepeg = NosePeg1;

package/dist/runescape/model/Item/all/PaladinCredentials.js

@@ -0,0 +1,22 @@
+import { Item } from '../Item';
+const paladinCredentialsData = {
+    destroy: "You'll need to speak to Sir Amik Varze to get another one.",
+    equipable: false,
+    examine: 'Proves my acceptance into the order of paladins.',
+    highAlch: 0,
+    id: 8780,
+    lowAlch: 0,
+    members: true,
+    meleeStrength: 0,
+    name: "Paladin's credentials",
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Paladin%27s_credentials',
+    prayer: 0,
+    questItem: true,
+    releaseDate: '9 August 2006',
+    stackable: false,
+    tradeable: false,
+    value: 0,
+    weight: 0.001,
+};
+export const PaladinCredentials = Item.fromJson(paladinCredentialsData);

package/dist/runescape/model/Item/all/RibcagePiece.js

@@ -0,0 +1,22 @@
+import { Item } from '../Item';
+const ribcagePieceData = {
+    destroy: 'Drop',
+    equipable: false,
+    examine: 'A slightly damaged ribcage.',
+    highAlch: 36,
+    id: 6146,
+    lowAlch: 24,
+    members: true,
+    meleeStrength: 0,
+    name: 'Ribcage piece',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Ribcage_piece',
+    prayer: 0,
+    questItem: false,
+    releaseDate: '1 August 2005',
+    stackable: false,
+    tradeable: true,
+    value: 60,
+    weight: 3.175,
+};
+export const RibcagePiece = Item.fromJson(ribcagePieceData);

package/dist/runescape/model/Item/all/RingOfDueling.js

@@ -0,0 +1,32 @@
+import { Item } from '../Item';
+const ringOfDuelingData = {
+    attackCrush: 0,
+    attackMagic: 0,
+    attackRanged: 0,
+    attackSlash: 0,
+    attackStab: 0,
+    defenceCrush: 0,
+    defenceMagic: 0,
+    defenceRanged: 0,
+    defenceSlash: 0,
+    defenceStab: 0,
+    destroy: 'Drop',
+    equipable: true,
+    examine: 'A ring for dueling with 8 charges.',
+    highAlch: 525,
+    id: 2552,
+    lowAlch: 350,
+    members: true,
+    meleeStrength: 0,
+    name: 'Ring of dueling(8)',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Ring_of_dueling',
+    prayer: 0,
+    questItem: false,
+    releaseDate: '24 September 2003',
+    stackable: false,
+    tradeable: true,
+    value: 875,
+    weight: 0.006,
+};
+export const RingOfDueling = Item.fromJson(ringOfDuelingData);

package/dist/runescape/model/Item/all/Rope.js

@@ -0,0 +1,21 @@
+import { Item } from '../Item';
+const ropeData = {
+    destroy: 'Drop',
+    equipable: false,
+    examine: 'A sturdy rope with many uses.',
+    highAlch: 0,
+    id: 954,
+    lowAlch: 0,
+    members: false,
+    meleeStrength: 0,
+    name: 'Rope',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Rope',
+    questItem: false,
+    releaseDate: '11 June 2001',
+    stackable: false,
+    tradeable: true,
+    value: 15,
+    weight: 0.3,
+};
+export const Rope = Item.fromJson(ropeData);

package/dist/runescape/model/Item/all/RoyalSeedPod.js

@@ -0,0 +1,21 @@
+import { Item } from '../Item';
+const royalSeedPodData = {
+    destroy: 'King Narnode will give you another one.',
+    equipable: false,
+    examine: 'Can be used to teleport to the Grand Tree.',
+    highAlch: 0,
+    id: 19564,
+    lowAlch: 0,
+    members: true,
+    meleeStrength: 0,
+    name: 'Royal seed pod',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Royal_seed_pod',
+    questItem: false,
+    releaseDate: '7 January 2016',
+    stackable: false,
+    tradeable: false,
+    value: 0,
+    weight: 0,
+};
+export const RoyalSeedPod = Item.fromJson(royalSeedPodData);

package/dist/runescape/model/Item/all/SalveAmulet.js

@@ -0,0 +1,32 @@
+import { Item } from '../Item';
+const salveAmuletData = {
+    attackCrush: 0,
+    attackMagic: 0,
+    attackRanged: 0,
+    attackSlash: 0,
+    attackStab: 0,
+    defenceCrush: 3,
+    defenceMagic: 3,
+    defenceRanged: 3,
+    defenceSlash: 3,
+    defenceStab: 3,
+    destroy: 'Drop',
+    equipable: true,
+    examine: 'Provides combat bonuses against undead monsters.',
+    highAlch: 0,
+    id: 4081,
+    lowAlch: 0,
+    members: true,
+    meleeStrength: 0,
+    name: 'Salve amulet',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Salve_amulet',
+    prayer: 0,
+    questItem: false,
+    releaseDate: '24 September 2003',
+    stackable: false,
+    tradeable: false,
+    value: 1,
+    weight: 0.01,
+};
+export const SalveAmulet = Item.fromJson(salveAmuletData);

package/dist/runescape/model/Item/all/SilverPot.js

@@ -0,0 +1,22 @@
+import { Item } from '../Item';
+const silverPotData = {
+    destroy: 'You can get another one from the Lumbridge Castle kitchen.',
+    equipable: false,
+    examine: 'A simple silver pot with no special properties.',
+    highAlch: 15,
+    id: 7728,
+    lowAlch: 10,
+    members: true,
+    meleeStrength: 0,
+    name: 'Silver pot',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Silver_pot',
+    prayer: 0,
+    questItem: true,
+    releaseDate: '31 May 2006',
+    stackable: false,
+    tradeable: false,
+    value: 25,
+    weight: 0.3,
+};
+export const SilverPot = Item.fromJson(silverPotData);

package/dist/runescape/model/Item/all/SilverSickleB.js

@@ -0,0 +1,32 @@
+import { Item } from '../Item';
+const silverSickleData = {
+    attackCrush: -2,
+    attackMagic: 0,
+    attackRanged: 0,
+    attackSlash: 6,
+    attackStab: 4,
+    defenceCrush: 0,
+    defenceMagic: 1,
+    defenceRanged: 0,
+    defenceSlash: 1,
+    defenceStab: 0,
+    destroy: 'Drop',
+    equipable: true,
+    examine: 'A blessed silver sickle.',
+    highAlch: 240,
+    id: 2961,
+    lowAlch: 160,
+    members: true,
+    meleeStrength: 5,
+    name: 'Silver sickle (b)',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Silver_sickle_(b)',
+    prayer: 2,
+    questItem: false,
+    releaseDate: '27 February 2002',
+    stackable: false,
+    tradeable: false,
+    value: 400,
+    weight: 0.453,
+};
+export const SilverSickleB = Item.fromJson(silverSickleData);

package/dist/runescape/model/Item/all/SkeletalBottoms.js

@@ -0,0 +1,32 @@
+import { Item } from '../Item';
+const skeletalBottomsData = {
+    attackCrush: 0,
+    attackMagic: 6,
+    attackRanged: -2,
+    attackSlash: 0,
+    attackStab: 0,
+    defenceCrush: 9,
+    defenceMagic: 6,
+    defenceRanged: 9,
+    defenceSlash: 9,
+    defenceStab: 9,
+    destroy: 'Drop',
+    equipable: true,
+    examine: 'Leg armour of ancient origin.',
+    highAlch: 2400,
+    id: 6143,
+    lowAlch: 1600,
+    members: true,
+    meleeStrength: 0,
+    name: 'Skeletal bottoms',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Skeletal_bottoms',
+    prayer: 0,
+    questItem: false,
+    releaseDate: '1 August 2005',
+    stackable: false,
+    tradeable: true,
+    value: 4000,
+    weight: 4.535,
+};
+export const SkeletalBottoms = Item.fromJson(skeletalBottomsData);

package/dist/runescape/model/Item/all/SkeletalHelm.js

@@ -0,0 +1,32 @@
+import { Item } from '../Item';
+const skeletalHelmData = {
+    attackCrush: 0,
+    attackMagic: 3,
+    attackRanged: -2,
+    attackSlash: 0,
+    attackStab: 0,
+    defenceCrush: 6,
+    defenceMagic: 3,
+    defenceRanged: 6,
+    defenceSlash: 6,
+    defenceStab: 6,
+    destroy: 'Drop',
+    equipable: true,
+    examine: 'A helmet of ancient origin.',
+    highAlch: 1500,
+    id: 6137,
+    lowAlch: 1000,
+    members: true,
+    meleeStrength: 0,
+    name: 'Skeletal helm',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Skeletal_helm',
+    prayer: 0,
+    questItem: false,
+    releaseDate: '1 August 2005',
+    stackable: false,
+    tradeable: true,
+    value: 2500,
+    weight: 2.267,
+};
+export const SkeletalHelm = Item.fromJson(skeletalHelmData);

package/dist/runescape/model/Item/all/SkeletalTop.js

@@ -0,0 +1,32 @@
+import { Item } from '../Item';
+const skeletalTopData = {
+    attackCrush: 0,
+    attackMagic: 8,
+    attackRanged: -2,
+    attackSlash: 0,
+    attackStab: 0,
+    defenceCrush: 12,
+    defenceMagic: 8,
+    defenceRanged: 12,
+    defenceSlash: 12,
+    defenceStab: 12,
+    destroy: 'Drop',
+    equipable: true,
+    examine: 'Body armour of ancient origin.',
+    highAlch: 3000,
+    id: 6141,
+    lowAlch: 2000,
+    members: true,
+    meleeStrength: 0,
+    name: 'Skeletal top',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Skeletal_top',
+    prayer: 0,
+    questItem: false,
+    releaseDate: '1 August 2005',
+    stackable: false,
+    tradeable: true,
+    value: 5000,
+    weight: 6.803,
+};
+export const SkeletalTop = Item.fromJson(skeletalTopData);

package/dist/runescape/model/Item/all/SkullPiece.js

@@ -0,0 +1,22 @@
+import { Item } from '../Item';
+const skullPieceData = {
+    destroy: 'Drop',
+    equipable: false,
+    examine: 'A fearsome looking skull.',
+    highAlch: 36,
+    id: 6144,
+    lowAlch: 24,
+    members: true,
+    meleeStrength: 0,
+    name: 'Skull piece',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Skull_piece',
+    prayer: 0,
+    questItem: false,
+    releaseDate: '1 August 2005',
+    stackable: false,
+    tradeable: true,
+    value: 60,
+    weight: 3.175,
+};
+export const SkullPiece = Item.fromJson(skullPieceData);

package/dist/runescape/model/Item/all/SmokeBarrage.js

@@ -0,0 +1,22 @@
+import { Item } from '../Item';
+const smokeBarrageData = {
+    destroy: 'Drop',
+    equipable: false,
+    examine: 'An Ancient Magicks spell.',
+    highAlch: 0,
+    id: 4000,
+    lowAlch: 0,
+    members: true,
+    meleeStrength: 0,
+    name: 'Smoke barrage',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Smoke_Barrage',
+    prayer: 0,
+    questItem: false,
+    releaseDate: '24 March 2003',
+    stackable: false,
+    tradeable: false,
+    value: 0,
+    weight: 0,
+};
+export const SmokeBarrage = Item.fromJson(smokeBarrageData);

package/dist/runescape/model/Item/all/Spade.js

@@ -0,0 +1,22 @@
+import { Item } from '../Item';
+const spadeData = {
+    destroy: 'Drop',
+    equipable: false,
+    examine: 'A spade for digging things up.',
+    highAlch: 2,
+    id: 952,
+    lowAlch: 1,
+    members: false,
+    meleeStrength: 0,
+    name: 'Spade',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Spade',
+    prayer: 0,
+    questItem: false,
+    releaseDate: '11 June 2001',
+    stackable: false,
+    tradeable: true,
+    value: 3,
+    weight: 2.267,
+};
+export const Spade = Item.fromJson(spadeData);

package/dist/runescape/model/Item/all/SuqahTeeth.js

@@ -0,0 +1,20 @@
+import { Item } from '../Item';
+const suqahTeethData = {
+    equipable: false,
+    examine: 'Sharp teeth from a Suqah.',
+    id: 9079,
+    members: true,
+    name: 'Suqah teeth',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Suqah_teeth',
+    questItem: false,
+    stackable: true,
+    tradeable: false,
+    value: 3,
+    weight: 0,
+    highAlch: 0,
+    lowAlch: 0,
+    releaseDate: '',
+    destroy: ''
+};
+export const SuqahTeeth = Item.fromJson(suqahTeethData);

package/dist/runescape/model/Item/all/Tinderbox.js

@@ -0,0 +1,20 @@
+import { Item } from '../Item';
+const tinderboxData = {
+    equipable: false,
+    examine: 'Useful for lighting fires.',
+    id: 590,
+    members: false,
+    name: 'Tinderbox',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Tinderbox',
+    questItem: false,
+    stackable: false,
+    tradeable: true,
+    value: 1,
+    weight: 0.1,
+    highAlch: 0,
+    lowAlch: 0,
+    releaseDate: '',
+    destroy: ''
+};
+export const Tinderbox = Item.fromJson(tinderboxData);

package/dist/runescape/model/Item/all/UnseenKey.js

@@ -0,0 +1,20 @@
+import { Item } from '../Item';
+const unseenKeyData = {
+    destroy: 'You can get another from a servant in the Sisterhood Sanctuary.',
+    equipable: false,
+    examine: 'A mysterious key that allows access to the unseen areas.',
+    id: 21089,
+    members: true,
+    name: 'Unseen key',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Unseen_key',
+    questItem: true,
+    stackable: false,
+    tradeable: false,
+    value: 0,
+    weight: 0.006,
+    highAlch: 0,
+    lowAlch: 0,
+    releaseDate: ''
+};
+export const UnseenKey = Item.fromJson(unseenKeyData);

package/dist/runescape/model/Item/all/WaterRune.js

@@ -0,0 +1,20 @@
+import { Item } from '../Item';
+const waterRuneData = {
+    equipable: false,
+    examine: 'One of the four basic elemental runes.',
+    id: 555,
+    members: false,
+    name: 'Water rune',
+    noted: false,
+    officialWikiUrl: 'https://oldschool.runescape.wiki/w/Water_rune',
+    questItem: false,
+    stackable: true,
+    tradeable: true,
+    value: 17,
+    weight: 0.002,
+    highAlch: 0,
+    lowAlch: 0,
+    releaseDate: '',
+    destroy: ''
+};
+export const WaterRune = Item.fromJson(waterRuneData);

package/dist/runescape/model/Requirement.js

@@ -0,0 +1,137 @@
+// TODO: Add a requirement type for all "levels" (combat, slayer, farming, crafting etc.)
+class LevelRequirement {
+    type = RequirementType.Level;
+    skillName;
+    level;
+    boostable = false; // Indicates if the level can be boosted
+    constructor(skillName, level, boostable = false) {
+        this.boostable = boostable;
+        this.skillName = skillName;
+        this.level = level;
+    }
+    get description() {
+        return `Level ${this.level}`;
+    }
+}
+// Enum for requirement types
+var RequirementType;
+(function (RequirementType) {
+    RequirementType["SlayerLevel"] = "SlayerLevel";
+    RequirementType["Level"] = "Level";
+    RequirementType["CombatLevel"] = "CombatLevel";
+    RequirementType["Quest"] = "Quest";
+    RequirementType["Item"] = "Item";
+    RequirementType["QuestPoint"] = "QuestPoint";
+    RequirementType["Location"] = "Location";
+    RequirementType["SlayerUnlock"] = "SlayerUnlock";
+})(RequirementType || (RequirementType = {}));
+// Slayer Unlock requirement
+class SlayerUnlockRequirement {
+    type = RequirementType.SlayerUnlock;
+    name;
+    constructor(name) {
+        this.name = name;
+    }
+    get description() {
+        return `Slayer unlock: ${this.name}`;
+    }
+}
+// Slayer level requirement
+class SlayerLevelRequirement {
+    type = RequirementType.SlayerLevel;
+    level;
+    constructor(level) {
+        this.level = level;
+    }
+    get description() {
+        return `Slayer level ${this.level}`;
+    }
+}
+// Combat level requirement
+class CombatLevelRequirement {
+    type = RequirementType.CombatLevel;
+    level;
+    constructor(level) {
+        this.level = level;
+    }
+    get description() {
+        return `Combat level ${this.level}`;
+    }
+}
+// Quest requirement
+class QuestRequirement {
+    static fromQuestName(arg0) {
+        throw new Error("Method not implemented.");
+    }
+    type = RequirementType.Quest;
+    questName;
+    constructor(questName) {
+        this.questName = questName;
+    }
+    get description() {
+        return `Completed quest: ${this.questName}`;
+    }
+    get completionDescription() {
+        return `Completion of ${this.questName}`;
+    }
+}
+class QuestPointRequirement {
+    type = RequirementType.QuestPoint;
+    amount;
+    constructor(amount) {
+        this.amount = amount;
+    }
+    get description() {
+        return `Quest Points Needed: ${this.amount}`;
+    }
+}
+// Item requirement
+class ItemRequirement {
+    type = RequirementType.Item;
+    itemName;
+    quantity;
+    /** Whether the item is consumed during the quest */
+    consumed;
+    /** Alternative items that can be used instead */
+    alternatives;
+    /** Whether the item must be noted */
+    noted;
+    /** Whether the item can be banked and withdrawn during the quest */
+    bankable;
+    /** Any additional notes about the item requirement */
+    notes;
+    constructor(itemName, quantity = 1, options = {}) {
+        this.itemName = itemName;
+        this.quantity = quantity;
+        this.consumed = options.consumed ?? true;
+        this.alternatives = options.alternatives;
+        this.noted = options.noted;
+        this.bankable = options.bankable;
+        this.notes = options.notes;
+    }
+    get description() {
+        let desc = `${this.quantity}x ${this.itemName}`;
+        if (this.noted)
+            desc += ' (noted)';
+        if (!this.consumed)
+            desc += ' (not consumed)';
+        if (this.alternatives?.length) {
+            desc += ` (or ${this.alternatives.join(' or ')})`;
+        }
+        if (this.notes)
+            desc += ` (${this.notes})`;
+        return desc;
+    }
+}
+// Location requirement
+class LocationRequirement {
+    type = RequirementType.Location;
+    locationName;
+    constructor(locationName) {
+        this.locationName = locationName;
+    }
+    get description() {
+        return `Access to location: ${this.locationName}`;
+    }
+}
+export { CombatLevelRequirement, ItemRequirement, LevelRequirement, LocationRequirement, QuestPointRequirement, QuestRequirement, RequirementType, SlayerLevelRequirement, SlayerUnlockRequirement, };