From c3fac33a6473c008667c12e7b4c36aaaaefb4c11 Mon Sep 17 00:00:00 2001 From: Jacob Date: Thu, 22 Aug 2024 12:53:41 +0800 Subject: [PATCH] remove jsdoc --- src/structures/APIIncident.ts | 4 +- src/structures/APIStatus.ts | 4 +- src/structures/Boosters/Booster.ts | 3 - src/structures/Game.ts | 3 - src/structures/GameCounts.ts | 3 - src/structures/Guild/GuildMember.ts | 6 +- src/structures/House.ts | 3 - src/structures/ItemBytes.ts | 3 - src/structures/Leaderboard.ts | 3 - src/structures/MiniGames/Arcade.ts | 69 ----------------- src/structures/MiniGames/ArenaBrawl.ts | 39 ---------- src/structures/MiniGames/BedWars.ts | 4 +- .../MiniGames/BlitzSurvivalGames.ts | 3 - src/structures/MiniGames/BuildBattle.ts | 3 - src/structures/MiniGames/CopsAndCrims.ts | 12 --- src/structures/MiniGames/Duels.ts | 3 - src/structures/MiniGames/MegaWalls.ts | 3 - src/structures/MiniGames/MurderMystery.ts | 6 -- src/structures/MiniGames/Paintball.ts | 5 +- src/structures/MiniGames/Pit.ts | 4 +- src/structures/MiniGames/PitInventoryItem.ts | 3 - src/structures/MiniGames/Quakecraft.ts | 3 - src/structures/MiniGames/SkyWars.ts | 12 --- src/structures/MiniGames/SmashHeroes.ts | 3 - src/structures/MiniGames/SpeedUHC.ts | 3 - src/structures/MiniGames/TNTGames.ts | 3 - src/structures/MiniGames/TurboKartRacers.ts | 3 - src/structures/MiniGames/UHC.ts | 75 ------------------- src/structures/MiniGames/VampireZ.ts | 3 - src/structures/MiniGames/Walls.ts | 4 +- src/structures/MiniGames/Warlords.ts | 3 - src/structures/MiniGames/WoolWars.ts | 67 ----------------- src/structures/PlayerCosmetics.ts | 3 - src/structures/SkyBlock/Auctions/Auction.ts | 3 - .../SkyBlock/Auctions/AuctionInfo.ts | 3 - .../SkyBlock/Auctions/BaseAuction.ts | 3 - src/structures/SkyBlock/Auctions/Bid.ts | 3 - src/structures/SkyBlock/Bazzar/Order.ts | 3 - src/structures/SkyBlock/Bazzar/Product.ts | 3 - src/structures/SkyBlock/News/SkyblockNews.ts | 3 - src/structures/SkyBlock/PlayerBingo.ts | 4 +- src/structures/SkyBlock/SkyblockGarden.ts | 3 - .../SkyBlock/SkyblockInventoryItem.ts | 4 +- src/structures/SkyBlock/SkyblockMember.ts | 3 - src/structures/SkyBlock/SkyblockMuseum.ts | 3 - src/structures/SkyBlock/SkyblockMuseumItem.ts | 3 - src/structures/SkyBlock/SkyblockPet.ts | 3 - src/structures/SkyBlock/SkyblockProfile.ts | 10 +-- src/structures/SkyBlock/Static/Bingo.ts | 14 +--- src/structures/SkyBlock/Static/BingoData.ts | 3 - src/structures/SkyBlock/Static/Candidate.ts | 3 - src/structures/SkyBlock/Static/FireSale.ts | 3 - src/structures/SkyBlock/Static/Government.ts | 3 - src/structures/SkyBlock/Static/Perk.ts | 3 - src/structures/Static/Achievement.ts | 3 - src/structures/Static/AchievementTier.ts | 3 - src/structures/Static/Achievements.ts | 3 - src/structures/Static/Challenges.ts | 3 - src/structures/Static/GameAchievements.ts | 3 - src/structures/Static/GameChallenges.ts | 4 +- src/structures/Static/GameQuests.ts | 3 - src/structures/Static/GuildAchievements.ts | 3 - src/structures/Static/Quest.ts | 3 - src/structures/Static/Quests.ts | 3 - src/structures/Watchdog/Stats.ts | 3 - 65 files changed, 17 insertions(+), 468 deletions(-) diff --git a/src/structures/APIIncident.ts b/src/structures/APIIncident.ts index fe7a8f77..a985b4b5 100644 --- a/src/structures/APIIncident.ts +++ b/src/structures/APIIncident.ts @@ -1,7 +1,5 @@ const regex = /https:\/\/status.hypixel.net\/incidents\/([a-z0-9]+)/; -/** - * API incident class - */ + class APIIncident { link: string | null; start: Date | null; diff --git a/src/structures/APIStatus.ts b/src/structures/APIStatus.ts index 780bca6a..8c04d5bd 100644 --- a/src/structures/APIStatus.ts +++ b/src/structures/APIStatus.ts @@ -1,7 +1,5 @@ import APIIncident from './APIIncident'; -/** - * API status class - */ + class APIStatus { sourceUrl: string | null; title: string | null; diff --git a/src/structures/Boosters/Booster.ts b/src/structures/Boosters/Booster.ts index 1daeb53c..89f72175 100644 --- a/src/structures/Boosters/Booster.ts +++ b/src/structures/Boosters/Booster.ts @@ -6,9 +6,6 @@ function parseType(data: Record): 'STACKED' | 'QUEUED' | 'ACTIVE' { return 'ACTIVE'; } -/** - * Booster class - */ class Booster { purchaser: string; amount: number; diff --git a/src/structures/Game.ts b/src/structures/Game.ts index 13234fad..9c5d541d 100644 --- a/src/structures/Game.ts +++ b/src/structures/Game.ts @@ -111,9 +111,6 @@ export type GameID = | -5 | -6; -/** - * Game class - */ class Game { game: GameID | GameCode; id: GameID | null; diff --git a/src/structures/GameCounts.ts b/src/structures/GameCounts.ts index 92b9ba77..0bd04868 100644 --- a/src/structures/GameCounts.ts +++ b/src/structures/GameCounts.ts @@ -1,9 +1,6 @@ import { recursive, removeSnakeCaseString } from '../utils/removeSnakeCase'; import Constants from '../utils/Constants'; -/** - * GameCounts class - */ class GameCounts { [x: string]: object | number; constructor(data: Record) { diff --git a/src/structures/Guild/GuildMember.ts b/src/structures/Guild/GuildMember.ts index a29c8009..9f60b35f 100644 --- a/src/structures/Guild/GuildMember.ts +++ b/src/structures/Guild/GuildMember.ts @@ -23,11 +23,7 @@ class GuildMember { this.expHistory = parseHistory(data.expHistory); this.weeklyExperience = xpCheck ? Object.values(data.expHistory).reduce((pV: any, cV: any) => pV + cV, 0) : null; } - /** - * UUID - * @return {string} - */ - toString() { + toString(): string { return this.uuid; } } diff --git a/src/structures/House.ts b/src/structures/House.ts index a48bfa10..bcc6071d 100644 --- a/src/structures/House.ts +++ b/src/structures/House.ts @@ -1,6 +1,3 @@ -/** - * House class - */ class House { name: string; uuid: string; diff --git a/src/structures/ItemBytes.ts b/src/structures/ItemBytes.ts index 997b4f47..3fc69700 100644 --- a/src/structures/ItemBytes.ts +++ b/src/structures/ItemBytes.ts @@ -1,8 +1,5 @@ import { decode } from '../utils/SkyblockUtils'; -/** - * Item Bytes class - */ class ItemBytes { bytesBuffer: Buffer; constructor(data: Record) { diff --git a/src/structures/Leaderboard.ts b/src/structures/Leaderboard.ts index e9744b7c..0b862520 100644 --- a/src/structures/Leaderboard.ts +++ b/src/structures/Leaderboard.ts @@ -1,6 +1,3 @@ -/** - * Leaderboard class - */ class Leaderboard { name: string | null; title: string; diff --git a/src/structures/MiniGames/Arcade.ts b/src/structures/MiniGames/Arcade.ts index 30a9774e..cfc8482a 100644 --- a/src/structures/MiniGames/Arcade.ts +++ b/src/structures/MiniGames/Arcade.ts @@ -11,9 +11,6 @@ function parseZombiesKills(data: Record): Record { // From entries might be broken return Object.fromEntries(matches.map((x: any) => [removeSnakeCaseString(x[1]), data[x[0]] || 0])); } -/** - * Zombies - Stats by Map + Difficulty - */ class ZombiesStats { bestRound: number; deaths: number; @@ -44,9 +41,6 @@ class ZombiesStats { } } -/** - * Zombies - Overall stats - */ class Zombies { overall: ZombiesStats; deadEnd: ZombiesStats; @@ -74,9 +68,6 @@ class Zombies { } } -/** - * Dropper stats by map - */ class DropperMap { bestTime: number; completions: number; @@ -86,9 +77,6 @@ class DropperMap { } } -/** - * Blocking Dead class - */ class BlockingDead { wins: number; kills: number; @@ -99,9 +87,6 @@ class BlockingDead { this.headshots = data.headshots_dayone || 0; } } -/** - * Bounty Hunters class - */ class BountyHunters { wins: number; kills: number; @@ -120,9 +105,6 @@ class BountyHunters { this.swordKills = data.sword_kills_oneinthequiver || 0; } } -/** - * Capture The Wool class - */ class CaptureTheWool { wins: number; losses: number; @@ -151,9 +133,6 @@ class CaptureTheWool { this.longestGame = data.woolhunt_longest_game || 0; } } -/** - * Dragon Wars class - */ class DragonWars { wins: number; kills: number; @@ -162,9 +141,6 @@ class DragonWars { this.kills = data.kills_dragonwars2 || 0; } } -/** - * Dropper class - */ class Dropper { wins: number; fails: number; @@ -188,9 +164,6 @@ class Dropper { }); } } -/** - * Ender Spleef class - */ class EnderSpleef { wins: number; kills: number; @@ -209,9 +182,6 @@ class EnderSpleef { this.totalPowerUpActivations = this.bigShotActivations + this.tripleShotActivations; } } -/** - * Farm Hunt class - */ class FarmHunt { wins: number; winsAsAnimal: number; @@ -240,9 +210,6 @@ class FarmHunt { this.poop = (data.poop_collected_farm_hunt || 0) + (data.poop_collected || 0); } } -/** - * Football class - */ class Football { wins: number; goals: number; @@ -255,9 +222,6 @@ class Football { this.powerKicks = data.powerkicks_soccer || 0; } } -/** - * Galxy Wars - */ class GalaxyWars { wins: number; kills: number; @@ -278,9 +242,6 @@ class GalaxyWars { this.defenderKills = data.sw_empire_kills || 0; } } -/** - * Party Popper Stats (Sub gamemode of Hide and Seek) - */ class PartyPopper { winsAsSeeker: number; winsAsHider: number; @@ -291,9 +252,6 @@ class PartyPopper { this.wins = this.winsAsSeeker + this.winsAsHider; } } -/** - * Prop Hunt Stats (Sub gamemode of Hide and Seek) - */ class PropHunt { winsAsSeeker: number; winsAsHider: number; @@ -304,9 +262,6 @@ class PropHunt { this.wins = this.winsAsSeeker + this.winsAsHider; } } -/** - * Hide And Seek Stats - */ class HideAndSeek { partyPopper: PartyPopper; propHunt: PropHunt; @@ -319,9 +274,6 @@ class HideAndSeek { this.winsAsHider = data.hider_wins_hide_and_seek || 0; } } -/** - * Hide And Seek Stats - */ class HoleInTheWall { wins: number; rounds: number; @@ -336,9 +288,6 @@ class HoleInTheWall { this.scoreRecordOverall = this.scoreRecordFinals + this.scoreRecordNormal; } } -/** - * Hypixel Says Stats - */ class HypixelSays { wins: number; rounds: number; @@ -351,9 +300,6 @@ class HypixelSays { this.topScore = data.top_score_simon_says || 0; } } -/** - * Mini Walls class - */ class MiniWalls { kit: string; wins: number; @@ -380,9 +326,6 @@ class MiniWalls { this.bowAccuracy = divide(this.arrowsHit, this.arrowsShot); } } -/** - * Party Games class - */ class PartyGames { wins: number; roundWins: number; @@ -393,9 +336,6 @@ class PartyGames { this.stars = data.total_stars_party || 0; } } -/** - * Pixel Party Game Mode - */ class PixelPartyGameMode { wins: number; gamesPlayed: number; @@ -412,9 +352,6 @@ class PixelPartyGameMode { this.powerUpsCollected = data?.[`power_ups_collected_${modeName}`] || 0; } } -/** - * Party Games class - */ class PixelParty { wins: number; gamesPlayed: number; @@ -441,9 +378,6 @@ class PixelParty { this.colorBlind = data.pixelparty || {}; } } -/** - * Throw Out class - */ class ThrowOut { wins: number; kills: number; @@ -456,9 +390,6 @@ class ThrowOut { this.KDRatio = divide(this.kills, this.deaths); } } -/** - * Arcade class - */ class Arcade { coins: number; weeklyCoins: number; diff --git a/src/structures/MiniGames/ArenaBrawl.ts b/src/structures/MiniGames/ArenaBrawl.ts index 6032be30..18fdf5a1 100644 --- a/src/structures/MiniGames/ArenaBrawl.ts +++ b/src/structures/MiniGames/ArenaBrawl.ts @@ -25,9 +25,6 @@ class ArenaBrawlMode { } } -/** - * ArenaBrawl class - */ class ArenaBrawl { coins: number; coinsSpent: number; @@ -39,50 +36,14 @@ class ArenaBrawl { '2v2': ArenaBrawlMode; '4v4': ArenaBrawlMode; constructor(data: Record) { - /** - * Coins - * @type {number} - */ this.coins = data.coins || 0; - /** - * Coins Spent - * @type {number} - */ this.coinsSpent = data.coins_spent || 0; - /** - * Wins - * @type {number} - */ this.wins = data.wins || 0; - /** - * Keys - * @type {number} - */ this.keys = data.keys || 0; - /** - * Chests - * @type {number} - */ this.chests = data.magical_chest || 0; - /** - * Rune - * @type {string} - */ this.rune = data.active_rune || ''; - /** - * ArenaBrawl mode stats - * @type {ArenaBrawlMode} - */ this['1v1'] = new ArenaBrawlMode(data, '1v1'); - /** - * ArenaBrawl mode stats - * @type {ArenaBrawlMode} - */ this['2v2'] = new ArenaBrawlMode(data, '2v2'); - /** - * ArenaBrawl mode stats - * @type {ArenaBrawlMode} - */ this['4v4'] = new ArenaBrawlMode(data, '4v4'); } } diff --git a/src/structures/MiniGames/BedWars.ts b/src/structures/MiniGames/BedWars.ts index 39b72142..c148c5ab 100644 --- a/src/structures/MiniGames/BedWars.ts +++ b/src/structures/MiniGames/BedWars.ts @@ -374,9 +374,7 @@ function generateStatsForPractice(data: Record): BedWarsPracticeSta } }; } -/** - * BedWars class - */ + class BedWars { tokens: number; level: number; diff --git a/src/structures/MiniGames/BlitzSurvivalGames.ts b/src/structures/MiniGames/BlitzSurvivalGames.ts index 96da098a..e4392f85 100644 --- a/src/structures/MiniGames/BlitzSurvivalGames.ts +++ b/src/structures/MiniGames/BlitzSurvivalGames.ts @@ -43,9 +43,6 @@ class BlitzSGKit { } } -/** - * Blitz SG class - */ class BlitzSurvivalGames { coins: number; kills: number; diff --git a/src/structures/MiniGames/BuildBattle.ts b/src/structures/MiniGames/BuildBattle.ts index 474193be..f24fc9ae 100644 --- a/src/structures/MiniGames/BuildBattle.ts +++ b/src/structures/MiniGames/BuildBattle.ts @@ -7,9 +7,6 @@ export interface BuildBattleWins { gtb: number; } -/** - * BuildBattle class - */ class BuildBattle { score: number; totalWins: number; diff --git a/src/structures/MiniGames/CopsAndCrims.ts b/src/structures/MiniGames/CopsAndCrims.ts index 106199e4..338f55a2 100644 --- a/src/structures/MiniGames/CopsAndCrims.ts +++ b/src/structures/MiniGames/CopsAndCrims.ts @@ -1,7 +1,4 @@ import divide from '../../utils/divide'; -/** - * Cops and crims Defusal class - */ class CopsAndCrimsDefusal { kills: number; headshotKills: number; @@ -36,9 +33,6 @@ class CopsAndCrimsDefusal { this.killsAsCop = data.cop_kills || 0; } } -/** - * Cops and crims Deathmatch class - */ class CopsAndCrimsDeathmatch { kills: number; assists: number; @@ -63,9 +57,6 @@ class CopsAndCrimsDeathmatch { this.killsAsCop = data.cop_kills_deathmatch || 0; } } -/** - * Cops and crims Gun Game class - */ class CopsAndCrimsGunGame { kills: number; assists: number; @@ -92,9 +83,6 @@ class CopsAndCrimsGunGame { this.fastestWin = data.fastest_win_gungame || 0; } } -/** - * Cops and crims class - */ class CopsAndCrims { defusal: CopsAndCrimsDefusal; deathmath: CopsAndCrimsDeathmatch; diff --git a/src/structures/MiniGames/Duels.ts b/src/structures/MiniGames/Duels.ts index 17f01a2f..a657a974 100644 --- a/src/structures/MiniGames/Duels.ts +++ b/src/structures/MiniGames/Duels.ts @@ -394,9 +394,6 @@ class DuelsBridge { } } -/** - * Duels class - */ class Duels { tokens: number; title: string | null; diff --git a/src/structures/MiniGames/MegaWalls.ts b/src/structures/MiniGames/MegaWalls.ts index ed2c13c9..e3990f9b 100644 --- a/src/structures/MiniGames/MegaWalls.ts +++ b/src/structures/MiniGames/MegaWalls.ts @@ -90,9 +90,6 @@ class MegaWallsKitStats { } } -/** - * MegaWalls class - */ class MegaWalls { selectedClass: string | null; coins: number; diff --git a/src/structures/MiniGames/MurderMystery.ts b/src/structures/MiniGames/MurderMystery.ts index 5de106ef..71be3a69 100644 --- a/src/structures/MiniGames/MurderMystery.ts +++ b/src/structures/MiniGames/MurderMystery.ts @@ -1,8 +1,5 @@ import divide from '../../utils/divide'; -/** - * MurderMystery stats by gamemode - */ class MurderMysteryModeStats { goldPickedUp: number; kills: number; @@ -36,9 +33,6 @@ class MurderMysteryModeStats { } } -/** - * MurderMystery class - */ class MurderMystery { tokens: number; goldPickedUp: number; diff --git a/src/structures/MiniGames/Paintball.ts b/src/structures/MiniGames/Paintball.ts index c174c198..2c958fcc 100644 --- a/src/structures/MiniGames/Paintball.ts +++ b/src/structures/MiniGames/Paintball.ts @@ -1,7 +1,5 @@ import divide from '../../utils/divide'; -/** - * Paintball class - */ + class Paintball { coins: number; kills: number; @@ -36,4 +34,5 @@ class Paintball { this.transfusion = data.transfusion || 0; } } + export default Paintball; diff --git a/src/structures/MiniGames/Pit.ts b/src/structures/MiniGames/Pit.ts index 97409027..f3cf0ca3 100644 --- a/src/structures/MiniGames/Pit.ts +++ b/src/structures/MiniGames/Pit.ts @@ -9,9 +9,7 @@ export interface PitArmor { leggings: PitInventoryItem | null; boots: PitInventoryItem | null; } -/** - * Pit Class - */ + class Pit { prestige: number; xp: number; diff --git a/src/structures/MiniGames/PitInventoryItem.ts b/src/structures/MiniGames/PitInventoryItem.ts index dba00b76..94875f9e 100644 --- a/src/structures/MiniGames/PitInventoryItem.ts +++ b/src/structures/MiniGames/PitInventoryItem.ts @@ -1,6 +1,3 @@ -/** - * PitItem class - */ class PitInventoryItem { itemId: number; count: number; diff --git a/src/structures/MiniGames/Quakecraft.ts b/src/structures/MiniGames/Quakecraft.ts index 4ec8ddf4..82b15dbf 100644 --- a/src/structures/MiniGames/Quakecraft.ts +++ b/src/structures/MiniGames/Quakecraft.ts @@ -22,9 +22,6 @@ class QuakecraftMode { } } -/** - * Quakecraft class - */ class Quakecraft { coins: number; solo: QuakecraftMode; diff --git a/src/structures/MiniGames/SkyWars.ts b/src/structures/MiniGames/SkyWars.ts index cee22060..81bf9e2b 100644 --- a/src/structures/MiniGames/SkyWars.ts +++ b/src/structures/MiniGames/SkyWars.ts @@ -137,9 +137,6 @@ class SkywarsModeStats { } } -/** - * Parses SkyWars Kit - */ class SkywarsKit { kitData: string[] | null; isKit: boolean; @@ -155,9 +152,6 @@ class SkywarsKit { } } -/** - * Parses SkyWars Kits - */ class SkywarsKits { kits: SkywarsKit[]; constructor(kits: Record) { @@ -168,9 +162,6 @@ class SkywarsKits { return this.kits.filter((kit) => kit.gameMode.startsWith(gameMode) && kit.kitType.startsWith(type)); } } -/** - * Skywars Packages - parses every package player has - */ class SkywarsPackages { rawPackages: Record; cages: any; @@ -194,9 +185,6 @@ class SkywarsPackages { .map((x: string[]) => x[1].replace(/-[a-z]/g, (x) => x[1].toUpperCase())); } } -/** - * SkyWars class - */ class SkyWars { coins: number; souls: number; diff --git a/src/structures/MiniGames/SmashHeroes.ts b/src/structures/MiniGames/SmashHeroes.ts index 3d0d9bba..7c7a6b72 100644 --- a/src/structures/MiniGames/SmashHeroes.ts +++ b/src/structures/MiniGames/SmashHeroes.ts @@ -44,9 +44,6 @@ class SmashHeoresHero { } } -/** - * SmashHeroes class - */ class SmashHeroes { coins: number; level: number; diff --git a/src/structures/MiniGames/SpeedUHC.ts b/src/structures/MiniGames/SpeedUHC.ts index fee40f2d..2e0f4d39 100644 --- a/src/structures/MiniGames/SpeedUHC.ts +++ b/src/structures/MiniGames/SpeedUHC.ts @@ -21,9 +21,6 @@ class SpeedUHCMode { } } -/** - * Speed UHC class - */ class SpeedUHC { coins: number; kills: number; diff --git a/src/structures/MiniGames/TNTGames.ts b/src/structures/MiniGames/TNTGames.ts index 226c94f6..14902dc3 100644 --- a/src/structures/MiniGames/TNTGames.ts +++ b/src/structures/MiniGames/TNTGames.ts @@ -99,9 +99,6 @@ class TNTWizards { } } -/** - * The TNT Games class - */ class TNTGames { coins: number; winstreak: number; diff --git a/src/structures/MiniGames/TurboKartRacers.ts b/src/structures/MiniGames/TurboKartRacers.ts index cc099e6d..268ca443 100644 --- a/src/structures/MiniGames/TurboKartRacers.ts +++ b/src/structures/MiniGames/TurboKartRacers.ts @@ -15,9 +15,6 @@ class TurboKartRacersMap { } } -/** - * TurboKartRacers class - */ class TurboKartRacers { coins: number; wins: number; diff --git a/src/structures/MiniGames/UHC.ts b/src/structures/MiniGames/UHC.ts index cf6e49ec..738ec147 100644 --- a/src/structures/MiniGames/UHC.ts +++ b/src/structures/MiniGames/UHC.ts @@ -17,36 +17,15 @@ class UHCGamemode { extraUltimatesCrafted: number; constructor(data: Record, mode?: string) { if (mode) mode = `_${mode}`; - /** - * @type {kills:number} - */ this.kills = data[`kills${mode}`] || 0; - /** - * @type {deaths:number} - */ this.deaths = data[`deaths${mode}`] || 0; - /** - * @type {wins:number} - */ this.wins = data[`wins${mode}`] || 0; - /** - * @type {headsEaten:number} - */ this.headsEaten = data[`heads_eaten${mode}`] || 0; - /** - * @type {ultimatesCrafted:number} - */ this.ultimatesCrafted = data[`ultimates_crafted${mode}`] || 0; - /** - * @type {extraUltimatesCrafted:number} - */ this.extraUltimatesCrafted = data[`extra_ultimates_crafted${mode}`] || 0; } } -/** - * UHC class - */ class UHC { coins: number; score: number; @@ -67,49 +46,16 @@ class UHC { extraUltimatesCrafted: number; starLevel: number; constructor(data: Record) { - /** - * @type {coins:number} - */ this.coins = data.coins || 0; - /** - * @type {score:number} - */ this.score = data.score || 0; - /** - * @type {kit:string} - */ this.kit = data.equippedKit || ''; - /** - * @type {solo:UHCGamemode} - */ this.solo = new UHCGamemode(data, 'solo'); - /** - * @type {team:UHCGamemode} - */ this.team = new UHCGamemode(data); - /** - * @type {redVsBlue:UHCGamemode} - */ this.redVsBlue = new UHCGamemode(data, 'red_vs_blue'); - /** - * @type {noDiamond:UHCGamemode} - */ this.noDiamond = new UHCGamemode(data, 'no_diamonds'); - /** - * @type {brawl:UHCGamemode} - */ this.brawl = new UHCGamemode(data, 'brawl'); - /** - * @type {soloBrawl:UHCGamemode} - */ this.soloBrawl = new UHCGamemode(data, 'solo_brawl'); - /** - * @type {duoBrawl:UHCGamemode} - */ this.duoBrawl = new UHCGamemode(data, 'duo_brawl'); - /** - * @type {wins:number} - */ this.wins = this.solo.wins + this.team.wins + @@ -118,9 +64,6 @@ class UHC { this.brawl.wins + this.soloBrawl.wins + this.duoBrawl.wins; - /** - * @type {kills:number} - */ this.kills = this.solo.kills + this.team.kills + @@ -129,9 +72,6 @@ class UHC { this.brawl.kills + this.soloBrawl.kills + this.duoBrawl.kills; - /** - * @type {deaths:number} - */ this.deaths = this.solo.deaths + this.team.deaths + @@ -140,13 +80,7 @@ class UHC { this.brawl.deaths + this.soloBrawl.deaths + this.duoBrawl.deaths; - /** - * @type {KDRatio:number} - */ this.KDRatio = divide(this.kills, this.deaths); - /** - * @type {headsEaten:number} - */ this.headsEaten = this.solo.headsEaten + this.team.headsEaten + @@ -155,9 +89,6 @@ class UHC { this.brawl.headsEaten + this.soloBrawl.headsEaten + this.duoBrawl.headsEaten; - /** - * @type {ultimatesCrafted:number} - */ this.ultimatesCrafted = this.solo.ultimatesCrafted + this.team.ultimatesCrafted + @@ -166,9 +97,6 @@ class UHC { this.brawl.ultimatesCrafted + this.soloBrawl.ultimatesCrafted + this.duoBrawl.ultimatesCrafted; - /** - * @type {extraUltimatesCrafted:number} - */ this.extraUltimatesCrafted = this.solo.extraUltimatesCrafted + this.team.extraUltimatesCrafted + @@ -177,9 +105,6 @@ class UHC { this.brawl.extraUltimatesCrafted + this.soloBrawl.extraUltimatesCrafted + this.duoBrawl.extraUltimatesCrafted; - /** - * @type {starLevel:number} - */ this.starLevel = getStarLevel(this.kills, this.wins); } } diff --git a/src/structures/MiniGames/VampireZ.ts b/src/structures/MiniGames/VampireZ.ts index afc6473e..946c289c 100644 --- a/src/structures/MiniGames/VampireZ.ts +++ b/src/structures/MiniGames/VampireZ.ts @@ -13,9 +13,6 @@ class VampireZRole { } } -/** - * VampireZ class - */ class VampireZ { coins: number; goldBought: number; diff --git a/src/structures/MiniGames/Walls.ts b/src/structures/MiniGames/Walls.ts index 99a6dbe4..8a523f0c 100644 --- a/src/structures/MiniGames/Walls.ts +++ b/src/structures/MiniGames/Walls.ts @@ -1,7 +1,5 @@ import divide from '../../utils/divide'; -/** - * Walls class - */ + class Walls { coins: number; kills: number; diff --git a/src/structures/MiniGames/Warlords.ts b/src/structures/MiniGames/Warlords.ts index 6366b9b6..9553ec38 100644 --- a/src/structures/MiniGames/Warlords.ts +++ b/src/structures/MiniGames/Warlords.ts @@ -19,9 +19,6 @@ class WarlordsClass { } } -/** - * Warlords class - */ class Warlords { coins: number; kills: number; diff --git a/src/structures/MiniGames/WoolWars.ts b/src/structures/MiniGames/WoolWars.ts index 6dd403b5..477a5484 100644 --- a/src/structures/MiniGames/WoolWars.ts +++ b/src/structures/MiniGames/WoolWars.ts @@ -49,9 +49,6 @@ function generateStatsFor(data: Record, className: string): WoolWar }; } -/** - * Wool Wars Class - */ class WoolWars { layers: number; xp: number; @@ -78,85 +75,21 @@ class WoolWars { ownedCosmetics: string[]; privateGamesConfig: WoolWarsPrivateGamesConfig; constructor(data: Record) { - /** - * Sheep layers, similar to prestige - * @type {layers:number} - */ this.layers = data.progression?.available_layers || 0; - /** - * Wool Wars XP - * @type {xp:number} - */ this.xp = data.progression?.experience || 0; - /** - * Wool Wars Decimal Level - * @type {exactLevel:number} - */ this.exactLevel = convertXPToLevel(this.xp); - /** - * Wool wars level (as shown in game) - * @type {level:number} - */ this.level = Math.floor(this.exactLevel); - /** - * Coins - * @type {coins:number} - */ this.coins = data.coins || 0; - /** - * Wins - * @type {wins:number} - */ this.wins = data.wins || 0; - /** - * gamesPlayed - * @type {gamesPlayed:number} - */ this.gamesPlayed = data.games_played || 0; - /** - * woolsPlaced - * @type {woolsPlaced:number} - */ this.woolsPlaced = data.wool_placed || 0; - /** - * blocksBroken - * @type {blocksBroken:number} - */ this.blocksBroken = data.blocks_broken || 0; - /** - * placeBreakRatio - * @type {placeBreakRatio:number} - */ this.placeBreakRatio = divide(this.woolsPlaced, this.blocksBroken); - /** - * kills - * @type {kills:number} - */ this.kills = data.kills || 0; - /** - * deaths - * @type {deaths:number} - */ this.deaths = data.deaths || 0; - /** - * KDRatio - * @type {KDRatio:number} - */ this.KDRatio = divide(this.kills, this.deaths); - /** - * assists - * @type {assists:number} - */ this.assists = data.assists || 0; - /** - * powerups - * @type {powerups:number} - */ this.powerups = data.powerups_gotten || 0; - /** - * Selected class, or NONE if field isn't present in API for some reason - * @type {selectedClass:'ASSAULT'|'TANK'|'GOLEM'|'SWORDSMAN'|'ENGINEER'|'ARCHER'|'NONE'} - */ this.selectedClass = data.wool_wars?.selected_class || 'NONE'; this.assault = generateStatsFor(data.wool_wars?.stats, 'assault'); this.tank = generateStatsFor(data.wool_wars?.stats, 'tank'); diff --git a/src/structures/PlayerCosmetics.ts b/src/structures/PlayerCosmetics.ts index 135bee99..2e4614e7 100644 --- a/src/structures/PlayerCosmetics.ts +++ b/src/structures/PlayerCosmetics.ts @@ -2,9 +2,6 @@ import { removeSnakeCaseString } from '../utils/removeSnakeCase'; import Pets from './Pets'; -/** - * Player Cosmetics class - */ class PlayerCosmetics { allCosmetics: string[]; petManager: Pets | null; diff --git a/src/structures/SkyBlock/Auctions/Auction.ts b/src/structures/SkyBlock/Auctions/Auction.ts index b6ed60b7..40cb85c5 100644 --- a/src/structures/SkyBlock/Auctions/Auction.ts +++ b/src/structures/SkyBlock/Auctions/Auction.ts @@ -2,9 +2,6 @@ import { SkyblockRarity } from '../../../utils/SkyblockUtils'; import BaseAuction from './BaseAuction'; import Bid from './Bid'; -/** - * Auction class - */ class Auction extends BaseAuction { coop: string[]; auctionStartTimestamp: number | null; diff --git a/src/structures/SkyBlock/Auctions/AuctionInfo.ts b/src/structures/SkyBlock/Auctions/AuctionInfo.ts index c6ae7135..77bcf650 100644 --- a/src/structures/SkyBlock/Auctions/AuctionInfo.ts +++ b/src/structures/SkyBlock/Auctions/AuctionInfo.ts @@ -1,6 +1,3 @@ -/** - * Auction info class - */ class AuctionInfo { page: number; totalPages: number; diff --git a/src/structures/SkyBlock/Auctions/BaseAuction.ts b/src/structures/SkyBlock/Auctions/BaseAuction.ts index 4940865b..061a2a08 100644 --- a/src/structures/SkyBlock/Auctions/BaseAuction.ts +++ b/src/structures/SkyBlock/Auctions/BaseAuction.ts @@ -1,8 +1,5 @@ import ItemBytes from '../../ItemBytes'; -/** - * Base auction class - */ class BaseAuction { auctionId: string | null; auctioneerUuid: string | null; diff --git a/src/structures/SkyBlock/Auctions/Bid.ts b/src/structures/SkyBlock/Auctions/Bid.ts index 9135a6f6..cda21205 100644 --- a/src/structures/SkyBlock/Auctions/Bid.ts +++ b/src/structures/SkyBlock/Auctions/Bid.ts @@ -1,6 +1,3 @@ -/** - * Bid class - */ class Bid { auctionId: string | null; profileId: string | null; diff --git a/src/structures/SkyBlock/Bazzar/Order.ts b/src/structures/SkyBlock/Bazzar/Order.ts index 0e204cea..00dcf54f 100644 --- a/src/structures/SkyBlock/Bazzar/Order.ts +++ b/src/structures/SkyBlock/Bazzar/Order.ts @@ -1,6 +1,3 @@ -/** - * Order class - */ class Order { amount: number; pricePerUnit: number; diff --git a/src/structures/SkyBlock/Bazzar/Product.ts b/src/structures/SkyBlock/Bazzar/Product.ts index 337be113..5b051254 100644 --- a/src/structures/SkyBlock/Bazzar/Product.ts +++ b/src/structures/SkyBlock/Bazzar/Product.ts @@ -11,9 +11,6 @@ export interface ProductStatus { buyOrders: number; } -/** - * Product class - */ class Product { productId: string; sellSummary: Order[]; diff --git a/src/structures/SkyBlock/News/SkyblockNews.ts b/src/structures/SkyBlock/News/SkyblockNews.ts index 320ba0f5..425cb231 100644 --- a/src/structures/SkyBlock/News/SkyblockNews.ts +++ b/src/structures/SkyBlock/News/SkyblockNews.ts @@ -12,9 +12,6 @@ function parseVer(stringVer: string): string | null { if (!matches?.length) return null; return matches[0]; } -/** - * SkyblockNews - */ class SkyblockNews { title: string; link: string; diff --git a/src/structures/SkyBlock/PlayerBingo.ts b/src/structures/SkyBlock/PlayerBingo.ts index 2661dec6..be7bd752 100644 --- a/src/structures/SkyBlock/PlayerBingo.ts +++ b/src/structures/SkyBlock/PlayerBingo.ts @@ -5,9 +5,7 @@ export interface PlayerBingoDataPerEvent { points: number; goalsCompleted: Bingo[] | string[]; } -/** - * Player Bingo Class - */ + class PlayerBingo { dataPerEvent: PlayerBingoDataPerEvent[]; constructor(data: Record) { diff --git a/src/structures/SkyBlock/SkyblockGarden.ts b/src/structures/SkyBlock/SkyblockGarden.ts index a96391f2..01140d85 100644 --- a/src/structures/SkyBlock/SkyblockGarden.ts +++ b/src/structures/SkyBlock/SkyblockGarden.ts @@ -53,9 +53,6 @@ export interface SkyblockGardenCropMilestones { netherWart: SkyblockSkillLevel; } -/** - * Skyblock Garden class - */ class SkyblockGarden { level: SkyblockSkillLevel; barnSkin: string; diff --git a/src/structures/SkyBlock/SkyblockInventoryItem.ts b/src/structures/SkyBlock/SkyblockInventoryItem.ts index 8a8ae4bd..073328ef 100644 --- a/src/structures/SkyBlock/SkyblockInventoryItem.ts +++ b/src/structures/SkyBlock/SkyblockInventoryItem.ts @@ -9,9 +9,7 @@ class SkyblockGemstone { this.quality = data.quality; } } -/** - * Item class - */ + class SkyblockInventoryItem { itemId: number; count: number; diff --git a/src/structures/SkyBlock/SkyblockMember.ts b/src/structures/SkyBlock/SkyblockMember.ts index 860d024d..18947954 100644 --- a/src/structures/SkyBlock/SkyblockMember.ts +++ b/src/structures/SkyBlock/SkyblockMember.ts @@ -40,9 +40,6 @@ export interface SkyblockMemberArmor { boots: SkyblockInventoryItem | null; } -/** - * Skyblock member class - */ class SkyblockMember { uuid: string; gameMode: string | null; diff --git a/src/structures/SkyBlock/SkyblockMuseum.ts b/src/structures/SkyBlock/SkyblockMuseum.ts index 94fa3cef..94f24f8a 100644 --- a/src/structures/SkyBlock/SkyblockMuseum.ts +++ b/src/structures/SkyBlock/SkyblockMuseum.ts @@ -1,9 +1,6 @@ import SkyblockMuseumItem from './SkyblockMuseumItem'; import { decode } from '../../utils/SkyblockUtils'; -/** - * Skyblock Museum class - */ class SkyblockMuseum { raw: Record; getItems: () => Promise; diff --git a/src/structures/SkyBlock/SkyblockMuseumItem.ts b/src/structures/SkyBlock/SkyblockMuseumItem.ts index 532fd53b..e97f43ae 100644 --- a/src/structures/SkyBlock/SkyblockMuseumItem.ts +++ b/src/structures/SkyBlock/SkyblockMuseumItem.ts @@ -1,8 +1,5 @@ import SkyblockInventoryItem from './SkyblockInventoryItem'; -/** - * Item class - */ class SkyblockMuseumItem { name: string | null; items: SkyblockInventoryItem[]; diff --git a/src/structures/SkyBlock/SkyblockPet.ts b/src/structures/SkyBlock/SkyblockPet.ts index 1dfeccf3..0206eba2 100644 --- a/src/structures/SkyBlock/SkyblockPet.ts +++ b/src/structures/SkyBlock/SkyblockPet.ts @@ -1,9 +1,6 @@ import { SkyblockRarity } from '../../utils/SkyblockUtils'; import Constants from '../../utils/Constants'; -/** - * Skyblock Pet class - */ class SkyblockPet { uuid: string; type: string; diff --git a/src/structures/SkyBlock/SkyblockProfile.ts b/src/structures/SkyBlock/SkyblockProfile.ts index 9826d86e..215566ff 100644 --- a/src/structures/SkyBlock/SkyblockProfile.ts +++ b/src/structures/SkyBlock/SkyblockProfile.ts @@ -1,8 +1,5 @@ import SkyblockMember from './SkyblockMember'; -/** - * Skyblock Profile class - */ class SkyblockProfile { profileId: string; profileName: string; @@ -34,11 +31,8 @@ class SkyblockProfile { ); this.me = this.members.find((x) => x.uuid === data.uuid); } - /** - * Profile Name - * @return {string} - */ - toString() { + + toString(): string { return this.profileName; } } diff --git a/src/structures/SkyBlock/Static/Bingo.ts b/src/structures/SkyBlock/Static/Bingo.ts index c9b93d6b..8a89c4ac 100644 --- a/src/structures/SkyBlock/Static/Bingo.ts +++ b/src/structures/SkyBlock/Static/Bingo.ts @@ -1,11 +1,9 @@ -function parsePosition(position: any): [number, number] { +function parsePosition(position: number): [number, number] { const x = (position % 5) + 1; const y = Math.floor(position / 5) + 1; return [x, y]; } -/** - * Bingo class - */ + class Bingo { name: string; id: string; @@ -34,12 +32,8 @@ class Bingo { toString(): string { return this.id; } - /** - * Gets tier step, if constant - * @private - * @returns {number|null} - */ - getTierStep() { + + private getTierStep(): number | null { if ('TIERED' !== this.type) return null; // No step possible if (2 > this.tiers.length) return null; diff --git a/src/structures/SkyBlock/Static/BingoData.ts b/src/structures/SkyBlock/Static/BingoData.ts index 9a59061e..38c44d7e 100644 --- a/src/structures/SkyBlock/Static/BingoData.ts +++ b/src/structures/SkyBlock/Static/BingoData.ts @@ -1,8 +1,5 @@ import Bingo from './Bingo'; -/** - * SB Bingo Class - */ class BingoData { lastUpdatedTimestamp: number; lastUpdatedAt: Date | null; diff --git a/src/structures/SkyBlock/Static/Candidate.ts b/src/structures/SkyBlock/Static/Candidate.ts index a35cb69f..05d8e488 100644 --- a/src/structures/SkyBlock/Static/Candidate.ts +++ b/src/structures/SkyBlock/Static/Candidate.ts @@ -1,8 +1,5 @@ import Perk from './Perk'; -/** - * Candidate class - */ class Candidate { name: string; keyBenefit: string; diff --git a/src/structures/SkyBlock/Static/FireSale.ts b/src/structures/SkyBlock/Static/FireSale.ts index 3f12e93f..8393b56d 100644 --- a/src/structures/SkyBlock/Static/FireSale.ts +++ b/src/structures/SkyBlock/Static/FireSale.ts @@ -1,6 +1,3 @@ -/** - * SB Fire Sale - */ class FireSale { itemId: string | null; startTimestamp: number; diff --git a/src/structures/SkyBlock/Static/Government.ts b/src/structures/SkyBlock/Static/Government.ts index 46245662..3a7b464b 100644 --- a/src/structures/SkyBlock/Static/Government.ts +++ b/src/structures/SkyBlock/Static/Government.ts @@ -1,8 +1,5 @@ import Candidate from './Candidate'; -/** - * SB Government Class - */ class GovernmentData { lastUpdatedTimestamp: number; lastUpdatedAt: Date | null; diff --git a/src/structures/SkyBlock/Static/Perk.ts b/src/structures/SkyBlock/Static/Perk.ts index 159a3e85..6024a5e3 100644 --- a/src/structures/SkyBlock/Static/Perk.ts +++ b/src/structures/SkyBlock/Static/Perk.ts @@ -1,6 +1,3 @@ -/** - * Candidate class - */ class Perk { name: string; description: string; diff --git a/src/structures/Static/Achievement.ts b/src/structures/Static/Achievement.ts index 793f36ec..8e0f9673 100644 --- a/src/structures/Static/Achievement.ts +++ b/src/structures/Static/Achievement.ts @@ -14,9 +14,6 @@ function collectAll(data: AchievementTier | null) { return { totalPoints, totalAmount }; } -/** - * Achievement Class - */ class Achievement { name: string; codeName: string; diff --git a/src/structures/Static/AchievementTier.ts b/src/structures/Static/AchievementTier.ts index e29d5d2f..103284bd 100644 --- a/src/structures/Static/AchievementTier.ts +++ b/src/structures/Static/AchievementTier.ts @@ -1,6 +1,3 @@ -/** - * AchievementTier class - */ class AchievementTier { maxTier: number; tierInfo: any; diff --git a/src/structures/Static/Achievements.ts b/src/structures/Static/Achievements.ts index a6684727..f473183b 100644 --- a/src/structures/Static/Achievements.ts +++ b/src/structures/Static/Achievements.ts @@ -1,9 +1,6 @@ import GameAchievements from './GameAchievements'; import { StaticGameNames } from '../../typings'; -/** - * Achievement class - */ class Achievements { lastUpdatedTimestamp: number; lastUpdatedAt: Date | null; diff --git a/src/structures/Static/Challenges.ts b/src/structures/Static/Challenges.ts index 34710588..3b23d848 100644 --- a/src/structures/Static/Challenges.ts +++ b/src/structures/Static/Challenges.ts @@ -1,9 +1,6 @@ import { StaticGameNames } from '../../typings'; import GameChallenges from './GameChallenges'; -/** - * Challenges class - */ class Challenges { lastUpdatedTimestamp: number; lastUpdatedAt: Date | null; diff --git a/src/structures/Static/GameAchievements.ts b/src/structures/Static/GameAchievements.ts index fc6ec95c..01602c81 100644 --- a/src/structures/Static/GameAchievements.ts +++ b/src/structures/Static/GameAchievements.ts @@ -1,9 +1,6 @@ import { StaticGameNames } from '../../typings'; import Achievement from './Achievement'; -/** - * Game achievements class - */ class GameAchievements { category: StaticGameNames; totalPoints: number; diff --git a/src/structures/Static/GameChallenges.ts b/src/structures/Static/GameChallenges.ts index ff894b9f..f4e03cd3 100644 --- a/src/structures/Static/GameChallenges.ts +++ b/src/structures/Static/GameChallenges.ts @@ -6,9 +6,7 @@ export interface ChallengeData { reward: number; rewardType: string; } -/** - * Game challenges class - */ + class GameChallenges { category: StaticGameNames; challenges: Map; diff --git a/src/structures/Static/GameQuests.ts b/src/structures/Static/GameQuests.ts index ad2a8613..66848d62 100644 --- a/src/structures/Static/GameQuests.ts +++ b/src/structures/Static/GameQuests.ts @@ -1,9 +1,6 @@ import { StaticGameNames } from '../../typings'; import Quest from './Quest'; -/** - * Game quests class - */ class GameQuests { game: StaticGameNames; quests: Quest[]; diff --git a/src/structures/Static/GuildAchievements.ts b/src/structures/Static/GuildAchievements.ts index c0a53018..272d7478 100644 --- a/src/structures/Static/GuildAchievements.ts +++ b/src/structures/Static/GuildAchievements.ts @@ -1,8 +1,5 @@ import Achievement from './Achievement'; -/** - * Achievement class - */ class GuildAchievements { lastUpdatedTimestamp: number; lastUpdatedAt: Date | null; diff --git a/src/structures/Static/Quest.ts b/src/structures/Static/Quest.ts index 7876dbf8..b4cb0299 100644 --- a/src/structures/Static/Quest.ts +++ b/src/structures/Static/Quest.ts @@ -9,9 +9,6 @@ export interface QuestReward { amount: number; } -/** - * Quest Class - */ class Quest { questName: string; questID: string; diff --git a/src/structures/Static/Quests.ts b/src/structures/Static/Quests.ts index a57cf33f..9ce1ecb3 100644 --- a/src/structures/Static/Quests.ts +++ b/src/structures/Static/Quests.ts @@ -1,9 +1,6 @@ import { StaticGameNames } from '../../typings'; import GameQuests from './GameQuests'; -/** - * Quest class - */ class Quests { lastUpdatedTimestamp: number; lastUpdatedAt: Date | null; diff --git a/src/structures/Watchdog/Stats.ts b/src/structures/Watchdog/Stats.ts index b52cc32e..474b6c94 100644 --- a/src/structures/Watchdog/Stats.ts +++ b/src/structures/Watchdog/Stats.ts @@ -1,6 +1,3 @@ -/** - * WatchdogStats class - */ class WatchdogStats { byWatchdogTotal: number; byWatchdogLastMinute: number;