Options
All
  • Public
  • Public/Protected
  • All
Menu

gavel-gateway-js - v2.8.1

Index

Classes

Interfaces

Type aliases

Variables

Functions Endpoint

Functions Util

Type aliases

AttackSpeed

AttackSpeed: "SUPER_FAST" | "VERY_FAST" | "FAST" | "NORMAL" | "SLOW" | "VERY_SLOW" | "SUPER_SLOW"

A weapon attack speed

BannerPattern

BannerPattern: "bs" | "ts" | "ls" | "rs" | "ms" | "cs" | "drs" | "dls" | "ss" | "cr" | "sc" | "ld" | "rud" | "lud" | "rd" | "vh" | "vhr" | "hh" | "hhb" | "bl" | "br" | "tl" | "tr" | "bt" | "tt" | "bts" | "tts" | "mc" | "mr" | "bo" | "cbo" | "bri" | "gra" | "gru" | "cre" | "sku" | "flo" | "moj" | "glb" | "pig"

A banner pattern as defined by Minecraft

ClassBaseType

ClassBaseType: "ARCHER" | "ASSASSIN" | "MAGE" | "SHAMAN" | "WARRIOR"

A type of player class excluding the reskins

ClassType

ClassType: ClassBaseType | "DARK_WIZARD" | "HUNTER" | "KNIGHT" | "NINJA" | "SKYSEER"

A type of player class

CraftableItemType

CraftableItemType: "BOOTS" | "BOW" | "BRACELET" | "CHESTPLATE" | "DAGGER" | "FOOD" | "HELMET" | "NECKLACE" | "LEGGINGS" | "POTION" | "RELIK" | "RING" | "SCROLL" | "SPEAR" | "WAND"

A specific type of item craftable using professions

CraftingSkill

CraftingSkill: "ARMORING" | "ALCHEMISM" | "COOKING" | "JEWELING" | "SCRIBING" | "TAILORING" | "WEAPONSMITHING" | "WOODWORKING"

A crafting profession skill

DonatorRank

DonatorRank: "CHAMPION" | "HERO" | "VIP+" | "VIP"

A donator rank on Wynncraft

GuildLevelRewardType

GuildLevelRewardType: "MEMBER_SLOTS" | "BADGE_SLOTS" | "LOADOUT_SLOTS" | "BANK_SLOTS_PUBLIC" | "BANK_SLOTS_PRIVATE" | "ALLY_SLOTS" | "WEEKLY_OBJECTIVES_UNLOCKED" | "BADGES" | "GUILD_STARS" | "TAX"

A type of reward earned by a guild levelling up

GuildRank

GuildRank: "OWNER" | "CHIEF" | "STRATEGIST" | "CAPTAIN" | "RECRUITER" | "RECRUIT"

A rank in a guild

IdentificationName

IdentificationName: "STRENGTH" | "DEXTERITY" | "INTELLIGENCE" | "DEFENCE" | "AGILITY" | "SPELL_DAMAGE_PERCENT" | "SPELL_EARTH_DAMAGE_PERCENT" | "SPELL_THUNDER_DAMAGE_PERCENT" | "SPELL_WATER_DAMAGE_PERCENT" | "SPELL_FIRE_DAMAGE_PERCENT" | "SPELL_AIR_DAMAGE_PERCENT" | "SPELL_ELEMENTAL_DAMAGE_PERCENT" | "SPELL_NEUTRAL_DAMAGE_PERCENT" | "SPELL_DAMAGE_RAW" | "SPELL_EARTH_DAMAGE_RAW" | "SPELL_THUNDER_DAMAGE_RAW" | "SPELL_WATER_DAMAGE_RAW" | "SPELL_FIRE_DAMAGE_RAW" | "SPELL_AIR_DAMAGE_RAW" | "SPELL_ELEMENTAL_DAMAGE_RAW" | "SPELL_NEUTRAL_DAMAGE_RAW" | "MAIN_ATTACK_DAMAGE_PERCENT" | "MAIN_ATTACK_EARTH_DAMAGE_PERCENT" | "MAIN_ATTACK_THUNDER_DAMAGE_PERCENT" | "MAIN_ATTACK_WATER_DAMAGE_PERCENT" | "MAIN_ATTACK_FIRE_DAMAGE_PERCENT" | "MAIN_ATTACK_AIR_DAMAGE_PERCENT" | "MAIN_ATTACK_ELEMENTAL_DAMAGE_PERCENT" | "MAIN_ATTACK_NEUTRAL_DAMAGE_PERCENT" | "MAIN_ATTACK_DAMAGE_RAW" | "MAIN_ATTACK_EARTH_DAMAGE_RAW" | "MAIN_ATTACK_THUNDER_DAMAGE_RAW" | "MAIN_ATTACK_WATER_DAMAGE_RAW" | "MAIN_ATTACK_FIRE_DAMAGE_RAW" | "MAIN_ATTACK_AIR_DAMAGE_RAW" | "MAIN_ATTACK_ELEMENTAL_DAMAGE_RAW" | "MAIN_ATTACK_NEUTRAL_DAMAGE_RAW" | "DAMAGE_PERCENT" | "EARTH_DAMAGE_PERCENT" | "THUNDER_DAMAGE_PERCENT" | "WATER_DAMAGE_PERCENT" | "FIRE_DAMAGE_PERCENT" | "AIR_DAMAGE_PERCENT" | "ELEMENTAL_DAMAGE_PERCENT" | "NEUTRAL_DAMAGE_PERCENT" | "DAMAGE_RAW" | "EARTH_DAMAGE_RAW" | "THUNDER_DAMAGE_RAW" | "WATER_DAMAGE_RAW" | "FIRE_DAMAGE_RAW" | "AIR_DAMAGE_RAW" | "ELEMENTAL_DAMAGE_RAW" | "NEUTRAL_DAMAGE_RAW" | "CRITICAL_DAMAGE_RAW" | "EARTH_DEFENCE" | "THUNDER_DEFENCE" | "WATER_DEFENCE" | "FIRE_DEFENCE" | "AIR_DEFENCE" | "HEALTH_REGEN_PERCENT" | "HEALTH_REGEN_RAW" | "HEALTH" | "LIFE_STEAL" | "MANA_REGEN" | "MANA_STEAL" | "SPELL_COST_PCT_1" | "SPELL_COST_RAW_1" | "SPELL_COST_PCT_2" | "SPELL_COST_RAW_2" | "SPELL_COST_PCT_3" | "SPELL_COST_RAW_3" | "SPELL_COST_PCT_4" | "SPELL_COST_RAW_4" | "ATTACK_SPEED" | "POISON" | "THORNS" | "REFLECTION" | "EXPLODING" | "JUMP_HEIGHT" | "WALK_SPEED" | "SPRINT_DURATION" | "SPRINT_REGEN" | "SOUL_POINT_REGEN" | "GATHERING_SPEED" | "GATHERING_XP_BONUS" | "XP_BONUS" | "LOOT_BONUS" | "LOOT_QUALITY" | "STEALING" | "KNOCKBACK"

A name for an item identification

ItemCategory

ItemCategory: "ARMOR" | "WEAPON" | "ACCESSORY"

A category to search items or recipes by

ItemDropType

ItemDropType: "NEVER" | "NORMAL" | "DUNGEON" | "LOOTCHEST"

A source an item can be obtained from

ItemRarity

ItemRarity: "MYTHIC" | "FABLED" | "LEGENDARY" | "RARE" | "SET" | "UNIQUE" | "NORMAL"

An item rarity tier

ItemRestriction

ItemRestriction: "UNTRADABLE" | "QUEST"

A restriction put on an item

ItemSpriteName

ItemSpriteName: "PLAYER_HEAD" | "LEATHER_HELMET" | "LEATHER_CHESTPLATE" | "LEATHER_LEGGINGS" | "LEATHER_BOOTS" | "GOLDEN_HELMET" | "GOLDEN_CHESTPLATE" | "GOLDEN_LEGGINGS" | "GOLDEN_BOOTS" | "CHAIN_HELMET" | "CHAIN_CHESTPLATE" | "CHAIN_LEGGINGS" | "CHAIN_BOOTS" | "IRON_HELMET" | "IRON_CHESTPLATE" | "IRON_LEGGINGS" | "IRON_BOOTS" | "DIAMOND_HELMET" | "DIAMOND_CHESTPLATE" | "DIAMOND_LEGGINGS" | "DIAMOND_BOOTS" | "WAND_DEFAULT_0" | "WAND_DEFAULT_1" | "WAND_DEFAULT_2" | "WAND_EARTH_0" | "WAND_EARTH_1" | "WAND_EARTH_2" | "WAND_THUNDER_0" | "WAND_THUNDER_1" | "WAND_THUNDER_2" | "WAND_WATER_0" | "WAND_WATER_1" | "WAND_WATER_2" | "WAND_FIRE_0" | "WAND_FIRE_1" | "WAND_FIRE_2" | "WAND_AIR_0" | "WAND_AIR_1" | "WAND_AIR_2" | "WAND_MULTI_0" | "WAND_MULTI_1" | "WAND_MULTI_2" | "SPEAR_DEFAULT_0" | "SPEAR_DEFAULT_1" | "SPEAR_EARTH_0" | "SPEAR_EARTH_1" | "SPEAR_EARTH_2" | "SPEAR_THUNDER_0" | "SPEAR_THUNDER_1" | "SPEAR_THUNDER_2" | "SPEAR_WATER_0" | "SPEAR_WATER_1" | "SPEAR_WATER_2" | "SPEAR_FIRE_0" | "SPEAR_FIRE_1" | "SPEAR_FIRE_2" | "SPEAR_AIR_0" | "SPEAR_AIR_1" | "SPEAR_AIR_2" | "SPEAR_MULTI_0" | "SPEAR_MULTI_1" | "SPEAR_MULTI_2" | "DAGGER_DEFAULT_0" | "DAGGER_DEFAULT_1" | "DAGGER_EARTH_0" | "DAGGER_EARTH_1" | "DAGGER_EARTH_2" | "DAGGER_THUNDER_0" | "DAGGER_THUNDER_1" | "DAGGER_THUNDER_2" | "DAGGER_WATER_0" | "DAGGER_WATER_1" | "DAGGER_WATER_2" | "DAGGER_FIRE_0" | "DAGGER_FIRE_1" | "DAGGER_FIRE_2" | "DAGGER_AIR_0" | "DAGGER_AIR_1" | "DAGGER_AIR_2" | "DAGGER_MULTI_0" | "DAGGER_MULTI_1" | "DAGGER_MULTI_2" | "BOW_DEFAULT_0" | "BOW_DEFAULT_1" | "BOW_EARTH_0" | "BOW_EARTH_1" | "BOW_EARTH_2" | "BOW_THUNDER_0" | "BOW_THUNDER_1" | "BOW_THUNDER_2" | "BOW_WATER_0" | "BOW_WATER_1" | "BOW_WATER_2" | "BOW_FIRE_0" | "BOW_FIRE_1" | "BOW_FIRE_2" | "BOW_AIR_0" | "BOW_AIR_1" | "BOW_AIR_2" | "BOW_MULTI_0" | "BOW_MULTI_1" | "BOW_MULTI_2" | "RELIK_DEFAULT_0" | "RELIK_DEFAULT_1" | "RELIK_EARTH_0" | "RELIK_EARTH_1" | "RELIK_EARTH_2" | "RELIK_THUNDER_0" | "RELIK_THUNDER_1" | "RELIK_THUNDER_2" | "RELIK_WATER_0" | "RELIK_WATER_1" | "RELIK_WATER_2" | "RELIK_FIRE_0" | "RELIK_FIRE_1" | "RELIK_FIRE_2" | "RELIK_AIR_0" | "RELIK_AIR_1" | "RELIK_AIR_2" | "RELIK_MULTI_0" | "RELIK_MULTI_1" | "RELIK_MULTI_2" | "RING_DEFAULT_0" | "RING_DEFAULT_1" | "RING_EARTH_0" | "RING_EARTH_1" | "RING_THUNDER_0" | "RING_THUNDER_1" | "RING_WATER_0" | "RING_WATER_1" | "RING_FIRE_0" | "RING_FIRE_1" | "RING_AIR_0" | "RING_AIR_1" | "RING_MULTI_0" | "RING_MULTI_1" | "RING_SPECIAL_0" | "RING_SPECIAL_1" | "RING_SPECIAL_2" | "BRACELET_DEFAULT_0" | "BRACELET_DEFAULT_1" | "BRACELET_EARTH_0" | "BRACELET_EARTH_1" | "BRACELET_THUNDER_0" | "BRACELET_THUNDER_1" | "BRACELET_WATER_0" | "BRACELET_WATER_1" | "BRACELET_FIRE_0" | "BRACELET_FIRE_1" | "BRACELET_AIR_0" | "BRACELET_AIR_1" | "BRACELET_MULTI_0" | "BRACELET_MULTI_1" | "NECKLACE_DEFAULT_0" | "NECKLACE_DEFAULT_1" | "NECKLACE_EARTH_0" | "NECKLACE_EARTH_1" | "NECKLACE_THUNDER_0" | "NECKLACE_THUNDER_1" | "NECKLACE_WATER_0" | "NECKLACE_WATER_1" | "NECKLACE_FIRE_0" | "NECKLACE_FIRE_1" | "NECKLACE_AIR_0" | "NECKLACE_AIR_1" | "NECKLACE_MULTI_0" | "NECKLACE_MULTI_1" | "NECKLACE_SPECIAL_0" | "NECKLACE_SPECIAL_1" | "NECKLACE_SPECIAL_2"

A sprite name commonly used by Wynncraft items

ItemType

ItemType: "BOOTS" | "LEGGINGS" | "CHESTPLATE" | "HELMET" | "SPEAR" | "WAND" | "BOW" | "DAGGER" | "RELIK" | "RING" | "BRACELET" | "NECKLACE"

All weapon, armor, and accessory types

MajorId

MajorId: "SAVIOURS_SACRIFICE" | "PEACEFUL_EFFIGY" | "FURIOUS_EFFIGY" | "PLAGUE" | "HAWKEYE" | "CHERRY_BOMBS" | "FLASHFREEZE" | "GREED" | "LIGHTWEIGHT" | "CAVALRYMAN" | "MAGNET" | "FISSION" | "RALLY" | "GUARDIAN" | "HEART_OF_THE_PACK" | "TRANSCENDENCE" | "GRAVITY_WELL" | "ROVING_ASSASSIN" | "GEOCENTRISM" | "FREERUNNER" | "MADNESS" | "SORCERY" | "EXPLOSIVE_IMPACT" | "TAUNT"

A name for an item major ID

MapLocationIcon

MapLocationIcon: "Content_BossAltar.png" | "Content_Cave.png" | "Content_CorruptedDungeon.png" | "Content_Dungeon.png" | "Content_GrindSpot.png" | "Content_Miniquest.png" | "Content_Quest.png" | "Content_Raid.png" | "Content_UltimateDiscovery.png" | "Merchant_Accessory.png" | "Merchant_Armour.png" | "Merchant_Dungeon.png" | "Merchant_Emerald.png" | "Merchant_Horse.png" | "Merchant_KeyForge.png" | "Merchant_Liquid.png" | "Merchant_Other.png" | "Merchant_Potion.png" | "Merchant_Scroll.png" | "Merchant_Seasail.png" | "Merchant_Tool.png" | "Merchant_Weapon.png" | "painting.png" | "tnt.png" | "NPC_Blacksmith.png" | "NPC_GuildMaster.png" | "NPC_ItemIdentifier.png" | "NPC_PowderMaster.png" | "NPC_TradeMarket.png" | "Profession_Alchemism.png" | "Profession_Armouring.png" | "Profession_Cooking.png" | "Profession_Jeweling.png" | "Profession_Scribing.png" | "Profession_Tailoring.png" | "Profession_Weaponsmithing.png" | "Profession_Woodworking.png" | "Special_FastTravel.png" | "Special_LightRealm.png" | "Special_RootsOfCorruption.png" | "Special_Rune.png"

An icon for a map location

MapLocationName

MapLocationName: "Corrupted Decrepit Sewers Dungeon" | "Corrupted Ice Barrows Dungeon" | "Corrupted Infested Pit Dungeon" | "Corrupted Lost Sanctuary Dungeon" | "Corrupted Sand-Swept Tomb Dungeon" | "Corrupted Undergrowth Ruins Dungeon" | "Corrupted Underworld Crypt Dungeon" | "Decrepit Sewers Dungeon" | "Eldritch Outlook Dungeon" | "Fallen Factory Dungeon" | "Galleon's Graveyard Dungeon" | "Ice Barrows Dungeon" | "Infested Pit Dungeon" | "Lost Sanctuary Dungeon" | "Sand-Swept Tomb Dungeon" | "Undergrowth Ruins Dungeon" | "Underworld Crypt Dungeon" | "???" | "A Grave Mistake" | "A Hunter's Calling" | "A Journey Beyond" | "A Journey Further" | "A Marauder's Dues" | "A Sandy Scandal" | "Acquiring Credentials" | "Aldorei's Secret Part I" | "Aldorei's Secret Part II" | "An Iron Heart Part I" | "An Iron Heart Part II" | "Arachnids' Ascent" | "Beyond the Grave" | "Blazing Retribution" | "Canyon Condor" | "Clearing the Camps" | "Corrupted Betrayal" | "Cowfusion" | "Craftmas Chaos" | "Creeper Infiltration" | "Crop Failure" | "Death Whistle" | "Deja Vu" | "Desperate Metal" | "Dwarves and Doguns Part I" | "Dwarves and Doguns Part II" | "Dwarves and Doguns Part III" | "Dwarves and Doguns Part IV" | "Dwelling Walls" | "Elemental Exercise" | "Enter the Dojo" | "Fallen Delivery" | "Fantastic Voyage" | "Fate of the Fallen" | "Flight in Distress" | "Forbidden Prison" | "From the Bottom" | "From the Mountains" | "Frost Bite" | "General's Orders" | "Grand Youth" | "Green Gloop" | "Haven Antiquity" | "Heart of Llevigar" | "Infested Plants" | "King's Recruit" | "Kingdom of Sand" | "Lava Springs" | "Lazarus Pit" | "Lexdale Witch Trials" | "Lost Royalty" | "Lost Soles" | "Lost in the Jungle" | "Macabre Masquerade ''Hallowynn 2014''" | "Master Piece" | "Meaningful Holiday" | "Memory Paranoia" | "Misadventure on the Sea" | "Mixed Feelings" | "Murder Mystery" | "Mushroom Man" | "One Thousand Meters Under" | "Out of my Mind" | "Pirate's Trove" | "Pit of the Dead" | "Point of No Return" | "Poisoning the Pest" | "Potion Making" | "Purple and Blue" | "Realm of Light I - The Worm Holes" | "Realm of Light II - Taproot" | "Realm of Light III - A Headless History" | "Realm of Light IV - Finding the Light" | "Realm of Light V - The Realm of Light" | "Recipe For Disaster" | "Reclaiming the House" | "Recover the Past" | "Redbeard's Booty" | "Rise of the Quartron" | "Royal Trials" | "Shattered Minds" | "Star Thief" | "Studying the Corrupt" | "Tempo Town Trouble" | "The Belly of the Beast" | "The Bigger Picture" | "The Canary Calls" | "The Canyon Guides" | "The Corrupted Village" | "The Dark Descent" | "The Envoy Part I" | "The Envoy Part II" | "The Feathers Fly Part I" | "The Feathers Fly Part II" | "The Fortuneteller" | "The Hero of Gavel" | "The Hidden City" | "The Hunger of Gerts Part 1" | "The Hunger of Gerts Part 2" | "The Lost" | "The Maiden Tower" | "The Mercenary" | "The Olmic Rune" | "The Order of the Grook" | "The Qira Hive" | "The Sewers of Ragni" | "The Shadow of the Beast" | "The Thanos Vaults" | "The Ultimate Weapon" | "Tower of Ascension" | "Tribal Aggression" | "Troubled Tribesmen" | "Tunnel Trouble" | "UndericeÀ" | "WynnExcavation Site A" | "WynnExcavation Site B" | "WynnExcavation Site C" | "WynnExcavation Site D" | "Zhight Island" | "Mini-Quest - Gather Acacia Logs" | "Mini-Quest - Gather Acacia Logs II" | "Mini-Quest - Gather Avo Logs" | "Mini-Quest - Gather Avo Logs II" | "Mini-Quest - Gather Avo Logs III" | "Mini-Quest - Gather Avo Logs IV" | "Mini-Quest - Gather Bamboo" | "Mini-Quest - Gather Barley" | "Mini-Quest - Gather Bass" | "Mini-Quest - Gather Bass II" | "Mini-Quest - Gather Bass III" | "Mini-Quest - Gather Bass IV" | "Mini-Quest - Gather Birch Logs" | "Mini-Quest - Gather Carp" | "Mini-Quest - Gather Carp II" | "Mini-Quest - Gather Cobalt" | "Mini-Quest - Gather Cobalt II" | "Mini-Quest - Gather Cobalt III" | "Mini-Quest - Gather Copper" | "Mini-Quest - Gather Dark Logs" | "Mini-Quest - Gather Dark Logs II" | "Mini-Quest - Gather Dark Logs III" | "Mini-Quest - Gather Decay Roots" | "Mini-Quest - Gather Decay Roots II" | "Mini-Quest - Gather Decay Roots III" | "Mini-Quest - Gather Diamonds" | "Mini-Quest - Gather Diamonds II" | "Mini-Quest - Gather Diamonds III" | "Mini-Quest - Gather Diamonds IV" | "Mini-Quest - Gather Gold" | "Mini-Quest - Gather Gold II" | "Mini-Quest - Gather Granite" | "Mini-Quest - Gather Gudgeon" | "Mini-Quest - Gather Gylia Fish" | "Mini-Quest - Gather Gylia Fish II" | "Mini-Quest - Gather Gylia Fish III" | "Mini-Quest - Gather Hops" | "Mini-Quest - Gather Hops II" | "Mini-Quest - Gather Icefish" | "Mini-Quest - Gather Icefish II" | "Mini-Quest - Gather Iron" | "Mini-Quest - Gather Iron II" | "Mini-Quest - Gather Jungle Logs" | "Mini-Quest - Gather Jungle Logs II" | "Mini-Quest - Gather Kanderstone" | "Mini-Quest - Gather Kanderstone II" | "Mini-Quest - Gather Kanderstone III" | "Mini-Quest - Gather Koi" | "Mini-Quest - Gather Koi II" | "Mini-Quest - Gather Koi III" | "Mini-Quest - Gather Light Logs" | "Mini-Quest - Gather Light Logs II" | "Mini-Quest - Gather Light Logs III" | "Mini-Quest - Gather Malt" | "Mini-Quest - Gather Malt II" | "Mini-Quest - Gather Millet" | "Mini-Quest - Gather Millet II" | "Mini-Quest - Gather Millet III" | "Mini-Quest - Gather Molten Eel" | "Mini-Quest - Gather Molten Eel II" | "Mini-Quest - Gather Molten Eel III" | "Mini-Quest - Gather Molten Eel IV" | "Mini-Quest - Gather Molten Ore" | "Mini-Quest - Gather Molten Ore II" | "Mini-Quest - Gather Molten Ore III" | "Mini-Quest - Gather Molten Ore IV" | "Mini-Quest - Gather Oak Logs" | "Mini-Quest - Gather Oats" | "Mini-Quest - Gather Oats II" | "Mini-Quest - Gather Pine Logs" | "Mini-Quest - Gather Pine Logs II" | "Mini-Quest - Gather Pine Logs III" | "Mini-Quest - Gather Piranhas" | "Mini-Quest - Gather Piranhas II" | "Mini-Quest - Gather Rice" | "Mini-Quest - Gather Rice II" | "Mini-Quest - Gather Rice III" | "Mini-Quest - Gather Rice IV" | "Mini-Quest - Gather Rye" | "Mini-Quest - Gather Rye II" | "Mini-Quest - Gather Salmon" | "Mini-Quest - Gather Salmon II" | "Mini-Quest - Gather Sandstone" | "Mini-Quest - Gather Sandstone II" | "Mini-Quest - Gather Silver" | "Mini-Quest - Gather Silver II" | "Mini-Quest - Gather Sorghum" | "Mini-Quest - Gather Sorghum II" | "Mini-Quest - Gather Sorghum III" | "Mini-Quest - Gather Sorghum IV" | "Mini-Quest - Gather Spruce Logs" | "Mini-Quest - Gather Spruce Logs II" | "Mini-Quest - Gather Trout" | "Mini-Quest - Gather Wheat" | "Mini-Quest - Gather Willow Logs" | "Mini-Quest - Gather Willow Logs II" | "Mini-Quest - Slay Ailuropodas" | "Mini-Quest - Slay Angels" | "Mini-Quest - Slay Astrochelys Manis" | "Mini-Quest - Slay Conures" | "Mini-Quest - Slay Coyotes" | "Mini-Quest - Slay Creatures of Nesaak Forest" | "Mini-Quest - Slay Creatures of the Void" | "Mini-Quest - Slay Dead Villagers" | "Mini-Quest - Slay Dragonlings" | "Mini-Quest - Slay Felrocs" | "Mini-Quest - Slay Frosted Guards & Cryostone Golems" | "Mini-Quest - Slay Hobgoblins" | "Mini-Quest - Slay Idols" | "Mini-Quest - Slay Ifrits" | "Mini-Quest - Slay Jinkos" | "Mini-Quest - Slay Lizardmen" | "Mini-Quest - Slay Magma Entities" | "Mini-Quest - Slay Mooshrooms" | "Mini-Quest - Slay Myconids" | "Mini-Quest - Slay Orcs" | "Mini-Quest - Slay Pernix Monkeys" | "Mini-Quest - Slay Robots" | "Mini-Quest - Slay Scarabs" | "Mini-Quest - Slay Skeletons" | "Mini-Quest - Slay Slimes" | "Mini-Quest - Slay Spiders" | "Mini-Quest - Slay Weirds" | "Mini-Quest - Slay Wraiths & Phantasms" | "Boss Altar" | "Cave" | "Corrupted Dungeons" | "Fast Travel" | "Grind Spot" | "Light's Secret" | "Nest of the Grootslangs" | "Nether Portal" | "Orphion's Nexus of Light" | "The Canyon Colossus" | "Tol Altar" | "Ultimate Discovery" | "Uth Shrine" | "Blacksmith" | "Guild Master" | "Identifier" | "Powder Master" | "Trade Market" | "Accessory Merchant" | "Apple Merchant" | "Armour Merchant" | "Art Merchant" | "Artefact Merchant" | "Black Market Merchant" | "Boat Merchant" | "Book Merchant" | "Bowl Merchant" | "Brew-it-Yourself Merchant" | "Bronze Rewards Merchant" | "Bucket Merchant" | "Charmcrafter Merchant" | "Clock Merchant" | "Cobblestone Merchant" | "Collector Merchant" | "Craftmas Merchant" | "Diamond Rewards Merchant" | "Dungeon Merchant" | "Dungeon Scroll Merchant" | "Egg Merchant" | "Emerald Merchant" | "Emeralds Merchant" | "Exchange Merchant" | "Explosives Merchant" | "Fabrics Merchant" | "Feather Merchant" | "Fish Merchant" | "Gert Merchant" | "Gift Merchant" | "Glassblowing Merchant" | "Gold Dealer Merchant" | "Gold Rewards Merchant" | "Golden Fish Merchant" | "Hive Air Merchant" | "Hive Earth Merchant" | "Hive Fire Merchant" | "Hive Thunder Merchant" | "Hive Water Merchant" | "Hook Merchant" | "Horse Merchant" | "Ingredient Merchant" | "Junk Merchant" | "Key Forge Merchant" | "King's Merchant" | "Liquid Merchant" | "Literature Merchant" | "Mask Merchant" | "Master Armour Merchant" | "Master Trinket Merchant" | "Master Weapon Merchant" | "Melon Merchant" | "Miner Pass Merchant" | "Mushroom Merchant" | "Mysterious Merchant" | "Necromancy Merchant" | "Pink Wool Merchant" | "Potato Merchant" | "Potion Merchant" | "Powder Merchant" | "Quartz Merchant" | "Recipe Merchant" | "Reset Scroll Merchant" | "Rymek Dealer Merchant" | "Scroll Merchant" | "Seasail Merchant" | "Seaskipper Merchant" | "Shifty Merchant" | "Siegfried Fan Item Merchant" | "Silver Rewards Merchant" | "Souvenir Merchant" | "Squid Merchant" | "Stiba Merchant" | "Suri Merchant" | "Ticket Merchant" | "Tool Merchant" | "Tour Pass Merchant" | "Transmutation Merchant" | "Treasure Merchant" | "Treasure Prize Merchant" | "Tribal Armour Merchant" | "Tribal Merchant" | "Tribal Weapon Merchant" | "Water Merchant" | "Weapon Merchant" | "Wig Merchant" | "Wynnter 2016 Merchant" | "Wynnter 2017 Merchant" | "Zhight Brew Merchant" | "Zhight Exchange Merchant" | "Alchemism Station" | "Armouring Station" | "Cooking Station" | "Jeweling Station" | "Scribing Station" | "Tailor Station" | "Tailoring Station" | "Weaponsmithing Station" | "Woodworking Station"

A name for a map location

MinecraftColor

MinecraftColor: "WHITE" | "LIGHT_GRAY" | "GRAY" | "BLACK" | "LIME" | "GREEN" | "CYAN" | "LIGHT_BLUE" | "BLUE" | "YELLOW" | "ORANGE" | "PINK" | "RED" | "MAGENTA" | "PURPLE" | "BROWN"

A color as used by Minecraft

MinecraftId

MinecraftId: MinecraftStringId | number

A value resolvable to a minecraft item id

MinecraftStringId

MinecraftStringId: `minecraft:${string}`

A value resolvable to a minecraft item id in string form

PlayerLeaderboardScope

PlayerLeaderboardScope: "TOTAL" | "SOLO"

A scope of leaderboard ranking

PlayerSoloLeaderboardType

PlayerSoloLeaderboardType: "COMBAT" | "PROFESSION" | "COMBINED" | "MINING" | "WOODCUTTING" | "FARMING" | "FISHING" | "SCRIBING" | "COOKING" | "ALCHEMISM" | "WOODWORKING" | "WEAPONSMITHING" | "TAILORING" | "ARMORING" | "JEWELING"

Player leaderboards available for solo

PlayerTotalLeaderboardType

PlayerTotalLeaderboardType: "PVP" | "COMBAT" | "PROFESSION" | "COMBINED"

Player leaderboards available for total

SemanticVersion

SemanticVersion: `${number}.${number}.${number}`

A semantic version identifier

ServerRank

ServerRank: "ADMINISTRATOR" | "WEBDEV" | "MODERATOR" | "MEDIA" | "BUILDER" | "ITEM" | "GAME_MASTER" | "CMD" | "MUSIC" | "HYBRID" | "MEDIA" | "PLAYER"

A staff rank on Wynncraft

WorldType

WorldType: "WYNNCRAFT" | "MEDIA" | "OTHER"

A server type found on Wynncraft

WynncraftAPIRoute

WynncraftAPIRoute: `https://api.wynncraft.com/${string}` | `https://web-api.wynncraft.com/${string}` | `https://athena.wynntils.com/${string}`

A URL to a Wynncraft API resource

Variables

data

data: LocalData

A collection of static data that is used within the library, but can also be used externally

Endpoint Functions

fetchGuild

  • Fetches a guild from the API

    This function causes API requests.
    This function returns null if the guild doesn't exist.

    Parameters

    Returns Promise<Guild | null>

fetchGuildLeaderboard

  • Fetches the guild leaderboard from the API

    This function causes API requests.
    The list is ordered in ascending order of position. (first place at start)

    Parameters

    Returns Promise<List<LeaderboardGuild>>

fetchGuildList

  • Fetches all guild names from the API

    This function causes API requests.
    The list is ordered in ascending order of creation.

    Parameters

    Returns Promise<List<string>>

fetchIngredientList

  • Fetches all ingredient names from the API

    This function causes API requests.

    Parameters

    Returns Promise<List<string>>

fetchIngredients

  • Fetches all ingredients matching the options from the API

    This function causes API requests.
    You should never disable caching for this function. Disabling caching or setting low cache times will result in multiple MB of network traffic on every call.

    Parameters

    Returns Promise<List<Ingredient>>

fetchItems

  • Fetches all items matching the options from the API

    This function causes API requests.
    You should never disable caching for this function. Disabling caching or setting low cache times will result in multiple MB of network traffic on every call.

    Parameters

    • Optional options: string | ItemSearchRequestOptions

      The options for the request, or a partial display name to search for

    Returns Promise<List<Item>>

fetchMapLocations

  • Fetches the coordinates of important locations from the API

    This function causes API requests.

    Parameters

    Returns Promise<List<MapLocation>>

fetchMyLocation

  • Fetches the coordinates and health info for the locally logged in player from the API

    This function causes API requests.
    Which player to return info for is based on the IP used to cast this request and the IP logged into the Minecraft server.

    Parameters

    Returns Promise<PlayerParty>

fetchNames

  • Fetches the guild and player names matching this query from the API

    This function causes API requests.

    Parameters

    Returns Promise<NameSearch>

fetchOnlinePlayers

  • Fetches the online players from the API

    This function causes API requests.

    Parameters

    Returns Promise<List<World>>

fetchOnlinePlayersSum

  • Fetches the number of online players from the API

    This function causes API requests.

    Parameters

    Returns Promise<OnlinePlayersSum>

fetchPlayer

  • Fetches a player from the API

    This function causes API requests.
    This function returns null if the player has never logged into Wynncraft.

    Parameters

    Returns Promise<Player | null>

fetchPlayerLeaderboard

fetchPlayerUUID

  • Fetches a players UUID from the API

    This function causes API requests.
    This function returns null if the player has never logged into Wynncraft.

    Parameters

    Returns Promise<UUID | null>

fetchRaw

  • Returns a raw API response of the requested route. This inserts a field currentTimestamp in ROOT for v2 requests and in request for legacy requests, it contains the timestamp of the date in the Date header

    This function causes API requests.

    Parameters

    Returns Promise<any>

fetchRecipeList

  • Fetches all recipe names from the API

    This function causes API requests.

    Parameters

    Returns Promise<List<string>>

fetchRecipes

  • Fetches all recipes matching the options from the API

    This function causes API requests.
    You should never disable caching for this function. Disabling caching or setting low cache times will result in multiple MB of network traffic on every call.

    Parameters

    Returns Promise<List<Recipe>>

fetchTerritoryList

  • Fetches the territory list from the API

    This function causes API requests.

    Parameters

    Returns Promise<List<Territory>>

Util Functions

flushCache

  • flushCache(): number

  • Removes all stored entries from cache and returns the amount of entries cleared

    Returns number

ratelimit

  • Returns information on the ratelimit channels

    Returns Ratelimit

setConfig

  • Merges the given options into the config and returns a copy of the full config

    Parameters

    • Optional config: ConfigOptions

      A ConfigOptions object containing all settings to be set

    Returns Config

Generated using TypeDoc