earthmc
Version:
An unofficial EarthMC library providing handy methods and extensive info.
104 lines • 2.98 kB
TypeScript
import type Dynmap from './Dynmap.js';
import type { OnlinePlayer, Player, StrictPoint2D } from '../../types/index.js';
import { type NotFoundError } from "../../utils/errors.js";
import type { EntityApi } from '../../helpers/EntityApi.js';
declare class Players implements EntityApi<Player | NotFoundError> {
#private;
get map(): Dynmap;
constructor(map: Dynmap);
readonly get: (...playerList: string[]) => Promise<NotFoundError | {
name: string;
town: string;
nation?: string;
rank: string;
nickname?: string;
underground?: boolean;
world?: string;
x?: number | string;
z?: number | string;
y?: number | string;
online: boolean;
} | (NotFoundError | {
name: string;
town: string;
nation?: string;
rank: string;
nickname?: string;
underground?: boolean;
world?: string;
x?: number | string;
z?: number | string;
y?: number | string;
online: boolean;
})[]>;
readonly all: () => Promise<{
name: string;
town: string;
nation?: string;
rank: string;
nickname?: string;
underground?: boolean;
world?: string;
x?: number | string;
z?: number | string;
y?: number | string;
online: boolean;
}[]>;
readonly townless: () => Promise<({
name: string;
town: string;
nation?: string;
rank: string;
nickname?: string;
underground?: boolean;
world?: string;
x?: number | string;
z?: number | string;
y?: number | string;
online: boolean;
} | {
name: string;
nickname?: string;
underground?: boolean;
world?: string;
x: number | string;
z: number | string;
y?: number | string;
})[]>;
readonly online: (includeResidentInfo?: boolean) => Promise<{
name: string;
nickname?: string;
underground?: boolean;
world?: string;
x: number | string;
z: number | string;
y?: number | string;
}[] | {
name: string;
town: string;
nation?: string;
rank: string;
nickname?: string;
underground?: boolean;
world?: string;
x?: number | string;
z?: number | string;
y?: number | string;
online: boolean;
}[]>;
readonly nearby: (location: StrictPoint2D, radius: StrictPoint2D, players?: OnlinePlayer[]) => Promise<Partial<{
name: string;
town: string;
nation?: string;
rank: string;
nickname?: string;
underground?: boolean;
world?: string;
x?: number | string;
z?: number | string;
y?: number | string;
online: boolean;
}>[]>;
}
export { Players, Players as default };
//# sourceMappingURL=Players.d.ts.map