earthmc/dist/api/squaremap/Players.d.ts

An unofficial EarthMC library providing handy methods and extensive info.

import type Squaremap from "./Squaremap.js";
import type { EntityApi } from "../../helpers/EntityApi.js";
import type { SquaremapOnlinePlayer, SquaremapPlayer, StrictPoint2D } from "../../types/index.js";
import { type NotFoundError } from "../../utils/errors.js";
declare class Players implements EntityApi<SquaremapPlayer | NotFoundError> {
    #private;
    get map(): Squaremap;
    constructor(map: Squaremap);
    readonly get: (...names: string[]) => Promise<NotFoundError | {
        name: string;
        town: string;
        nation?: string;
        rank: string;
        uuid?: string;
        nickname?: string;
        world?: string;
        x?: number | string;
        z?: number | string;
        y?: number | string;
        yaw?: number | string;
        online: boolean;
    } | (NotFoundError | {
        name: string;
        town: string;
        nation?: string;
        rank: string;
        uuid?: string;
        nickname?: string;
        world?: string;
        x?: number | string;
        z?: number | string;
        y?: number | string;
        yaw?: number | string;
        online: boolean;
    })[]>;
    readonly all: () => Promise<{
        name: string;
        town: string;
        nation?: string;
        rank: string;
        uuid?: string;
        nickname?: string;
        world?: string;
        x?: number | string;
        z?: number | string;
        y?: number | string;
        yaw?: number | string;
        online: boolean;
    }[]>;
    readonly online: (includeResidentInfo?: boolean) => Promise<{
        uuid: string;
        name: string;
        nickname?: string;
        world?: string;
        x: number | string;
        z: number | string;
        y?: number | string;
        yaw?: number | string;
    }[] | {
        name: string;
        town: string;
        nation?: string;
        rank: string;
        uuid?: string;
        nickname?: string;
        world?: string;
        x?: number | string;
        z?: number | string;
        y?: number | string;
        yaw?: number | string;
        online: boolean;
    }[]>;
    readonly townless: () => Promise<({
        name: string;
        town: string;
        nation?: string;
        rank: string;
        uuid?: string;
        nickname?: string;
        world?: string;
        x?: number | string;
        z?: number | string;
        y?: number | string;
        yaw?: number | string;
        online: boolean;
    } | {
        uuid: string;
        name: string;
        nickname?: string;
        world?: string;
        x: number | string;
        z: number | string;
        y?: number | string;
        yaw?: number | string;
    })[]>;
    readonly nearby: (location: StrictPoint2D, radius: StrictPoint2D, players?: SquaremapOnlinePlayer[]) => Promise<Partial<{
        name: string;
        town: string;
        nation?: string;
        rank: string;
        uuid?: string;
        nickname?: string;
        world?: string;
        x?: number | string;
        z?: number | string;
        y?: number | string;
        yaw?: number | string;
        online: boolean;
    }>[]>;
}
export { Players, Players as default };
//# sourceMappingURL=Players.d.ts.map