@zikeji/hypixel
Version:
With IntelliSense support & test coverage, this is an unopinionated async/await API wrapper for Hypixel's Public API. It is developed in TypeScript complete with documentation, typed interfaces for all API responses, built-in rate-limit handling, flexible
37 lines (36 loc) • 1.21 kB
TypeScript
/**
* This portion of code was ported from the [hypixel-php](https://github.com/Plancke/hypixel-php) library.
*
* Copyright (c) 2021 Zikeji
* Copyright (c) 2017 Aäron Plancke
*
* For the original full copyright and license information, please view the LICENSE-HYPIXEL-PHP.md that was distributed with this source code.
*/
import { MinecraftColorAsHex, MinecraftFormatting } from "./MinecraftFormatting";
/**
* Describes the properties of a Prestige object returned by {@link getSkyWarsPrestigeForLevel}.
*/
export interface SkyWarsPrestige {
id: string;
name: string;
color: MinecraftFormatting;
colorHex: MinecraftColorAsHex;
minimumLevel: number;
icon: {
version: number;
material: string;
typeId: number;
data: number;
};
textIcon: string | null;
}
/**
* An array of the prestiges in SkyWars, listed in order of lowest to highest.
*/
export declare const SkyWarsPrestiges: SkyWarsPrestige[];
/**
* Returns a {@link SkyWarsPrestige} object for the level you supplied.
* @param level The level of the player you are checking.
* @category Helper
*/
export declare function getSkyWarsPrestigeForLevel(level: number): SkyWarsPrestige;