earthmc/dist/api/dynmap/Towns.d.ts

An unofficial EarthMC library providing handy methods and extensive info.

import type Dynmap from "./Dynmap.js";
import { NotFoundError } from "../../utils/errors.js";
import type { EntityApi } from '../../helpers/EntityApi.js';
import type { StrictPoint2D, Town } from '../../types/index.js';
declare class Towns implements EntityApi<Town | NotFoundError> {
    #private;
    get map(): Dynmap;
    constructor(map: Dynmap);
    readonly fromNation: (nationName: string) => Promise<NotFoundError | {
        name: string;
        nation: string | "No Nation";
        mayor: string;
        residents: string[];
        area: number;
        x: number;
        z: number;
        bounds: import("../../types/town.js").TownBounds;
        colours: {
            fill: import("../../types/util.js").HexString;
            outline: import("../../types/util.js").HexString;
        };
        opacities?: {
            fill: import("../../types/util.js").Opacity;
            outline: import("../../types/util.js").Opacity;
        };
        wiki?: string;
        flags: import("../../types/town.js").TownFlags;
    } | (NotFoundError | {
        name: string;
        nation: string | "No Nation";
        mayor: string;
        residents: string[];
        area: number;
        x: number;
        z: number;
        bounds: import("../../types/town.js").TownBounds;
        colours: {
            fill: import("../../types/util.js").HexString;
            outline: import("../../types/util.js").HexString;
        };
        opacities?: {
            fill: import("../../types/util.js").Opacity;
            outline: import("../../types/util.js").Opacity;
        };
        wiki?: string;
        flags: import("../../types/town.js").TownFlags;
    })[]>;
    readonly get: (...townList: string[]) => Promise<NotFoundError | {
        name: string;
        nation: string | "No Nation";
        mayor: string;
        residents: string[];
        area: number;
        x: number;
        z: number;
        bounds: import("../../types/town.js").TownBounds;
        colours: {
            fill: import("../../types/util.js").HexString;
            outline: import("../../types/util.js").HexString;
        };
        opacities?: {
            fill: import("../../types/util.js").Opacity;
            outline: import("../../types/util.js").Opacity;
        };
        wiki?: string;
        flags: import("../../types/town.js").TownFlags;
    } | (NotFoundError | {
        name: string;
        nation: string | "No Nation";
        mayor: string;
        residents: string[];
        area: number;
        x: number;
        z: number;
        bounds: import("../../types/town.js").TownBounds;
        colours: {
            fill: import("../../types/util.js").HexString;
            outline: import("../../types/util.js").HexString;
        };
        opacities?: {
            fill: import("../../types/util.js").Opacity;
            outline: import("../../types/util.js").Opacity;
        };
        wiki?: string;
        flags: import("../../types/town.js").TownFlags;
    })[]>;
    readonly all: (removeAccents?: boolean) => Promise<{
        name: string;
        nation: string | "No Nation";
        mayor: string;
        residents: string[];
        area: number;
        x: number;
        z: number;
        bounds: import("../../types/town.js").TownBounds;
        colours: {
            fill: import("../../types/util.js").HexString;
            outline: import("../../types/util.js").HexString;
        };
        opacities?: {
            fill: import("../../types/util.js").Opacity;
            outline: import("../../types/util.js").Opacity;
        };
        wiki?: string;
        flags: import("../../types/town.js").TownFlags;
    }[]>;
    readonly nearby: (location: StrictPoint2D, radius: StrictPoint2D, towns?: Town[]) => Promise<{
        name: string;
        nation: string | "No Nation";
        mayor: string;
        residents: string[];
        area: number;
        x: number;
        z: number;
        bounds: import("../../types/town.js").TownBounds;
        colours: {
            fill: import("../../types/util.js").HexString;
            outline: import("../../types/util.js").HexString;
        };
        opacities?: {
            fill: import("../../types/util.js").Opacity;
            outline: import("../../types/util.js").Opacity;
        };
        wiki?: string;
        flags: import("../../types/town.js").TownFlags;
    }[]>;
    readonly invitable: (nationName: string, includeBelonging?: boolean) => Promise<{
        name: string;
        nation: string | "No Nation";
        mayor: string;
        residents: string[];
        area: number;
        x: number;
        z: number;
        bounds: import("../../types/town.js").TownBounds;
        colours: {
            fill: import("../../types/util.js").HexString;
            outline: import("../../types/util.js").HexString;
        };
        opacities?: {
            fill: import("../../types/util.js").Opacity;
            outline: import("../../types/util.js").Opacity;
        };
        wiki?: string;
        flags: import("../../types/town.js").TownFlags;
    }[]>;
}
export { Towns, Towns as default };
//# sourceMappingURL=Towns.d.ts.map