Class Nations

Implements

Constructors

constructor

Accessors

map

Methods

all get joinable nearby

Constructors

constructor

Accessors

map

Methods

Readonlyall

  • all(towns?): Promise<{
        allies?: string[];
        area: number;
        capital: {
            name: string;
            x: string | number;
            z: string | number;
        };
        councillors: string[];
        enemies?: string[];
        king: string;
        mapColorHexCode?: string;
        name: string;
        ranks?: {
            [key: string]: string[];
        };
        residents: string[];
        spawn?: {
            pitch?: number;
            world: string;
            x: string | number;
            y?: string | number;
            yaw?: number;
            z: string | number;
        };
        stats?: {
            balance: number;
            maxTownBlocks?: number;
            numResidents?: number;
            numTownBlocks?: number;
            numTowns?: number;
        };
        status?: Partial<{
            isCapital: boolean;
            isNPC: boolean;
            isNeutral: boolean;
            isOnline: boolean;
            isOpen: boolean;
            isOverClaimed: boolean;
            isPublic: boolean;
            isRuined: boolean;
        }>;
        towns: string[];
        uuid?: string;
        wealth?: number;
        wiki?: string;
    }[]>

  • Parameters

    • Optionaltowns: {
          area: number;
          balance?: number;
          board?: string;
          bounds: TownBounds;
          colours: {
              fill: `#${string}`;
              outline: `#${string}`;
          };
          councillors: string[];
          flags: {
              capital: boolean;
              public: boolean;
              pvp: boolean;
          };
          foundedTimestamp: number;
          founder?: string;
          mayor: string;
          name: string;
          nation: string;
          opacities?: {
              fill: Opacity;
              outline: Opacity;
          };
          outlaws?: string[];
          points: {
              x: number;
              z: number;
          }[];
          residents: string[];
          timestamps?: {
              founded: number;
              joinedNation?: number;
          };
          trusted?: string[];
          wealth?: number;
          wikis?: {
              nation?: string;
              town?: string;
          };
          x: number;
          z: number;
      }[]

    Returns Promise<{
        allies?: string[];
        area: number;
        capital: {
            name: string;
            x: string | number;
            z: string | number;
        };
        councillors: string[];
        enemies?: string[];
        king: string;
        mapColorHexCode?: string;
        name: string;
        ranks?: {
            [key: string]: string[];
        };
        residents: string[];
        spawn?: {
            pitch?: number;
            world: string;
            x: string | number;
            y?: string | number;
            yaw?: number;
            z: string | number;
        };
        stats?: {
            balance: number;
            maxTownBlocks?: number;
            numResidents?: number;
            numTownBlocks?: number;
            numTowns?: number;
        };
        status?: Partial<{
            isCapital: boolean;
            isNPC: boolean;
            isNeutral: boolean;
            isOnline: boolean;
            isOpen: boolean;
            isOverClaimed: boolean;
            isPublic: boolean;
            isRuined: boolean;
        }>;
        towns: string[];
        uuid?: string;
        wealth?: number;
        wiki?: string;
    }[]>

Readonlyget

  • get(...names): Promise<NotFoundError | {
        allies?: string[];
        area: number;
        capital: {
            name: string;
            x: string | number;
            z: string | number;
        };
        councillors: string[];
        enemies?: string[];
        king: string;
        mapColorHexCode?: string;
        name: string;
        ranks?: {
            [key: string]: string[];
        };
        residents: string[];
        spawn?: {
            pitch?: number;
            world: string;
            x: string | number;
            y?: string | number;
            yaw?: number;
            z: string | number;
        };
        stats?: {
            balance: number;
            maxTownBlocks?: number;
            numResidents?: number;
            numTownBlocks?: number;
            numTowns?: number;
        };
        status?: Partial<{
            isCapital: boolean;
            isNPC: boolean;
            isNeutral: boolean;
            isOnline: boolean;
            isOpen: boolean;
            isOverClaimed: boolean;
            isPublic: boolean;
            isRuined: boolean;
        }>;
        towns: string[];
        uuid?: string;
        wealth?: number;
        wiki?: string;
    } | (NotFoundError | {
        allies?: string[];
        area: number;
        capital: {
            name: string;
            x: string | number;
            z: string | number;
        };
        councillors: string[];
        enemies?: string[];
        king: string;
        mapColorHexCode?: string;
        name: string;
        ranks?: {
            [key: string]: string[];
        };
        residents: string[];
        spawn?: {
            pitch?: number;
            world: string;
            x: string | number;
            y?: string | number;
            yaw?: number;
            z: string | number;
        };
        stats?: {
            balance: number;
            maxTownBlocks?: number;
            numResidents?: number;
            numTownBlocks?: number;
            numTowns?: number;
        };
        status?: Partial<{
            isCapital: boolean;
            isNPC: boolean;
            isNeutral: boolean;
            isOnline: boolean;
            isOpen: boolean;
            isOverClaimed: boolean;
            isPublic: boolean;
            isRuined: boolean;
        }>;
        towns: string[];
        uuid?: string;
        wealth?: number;
        wiki?: string;
    })[]>

  • Parameters

    • Rest...names: string[]

    Returns Promise<NotFoundError | {
        allies?: string[];
        area: number;
        capital: {
            name: string;
            x: string | number;
            z: string | number;
        };
        councillors: string[];
        enemies?: string[];
        king: string;
        mapColorHexCode?: string;
        name: string;
        ranks?: {
            [key: string]: string[];
        };
        residents: string[];
        spawn?: {
            pitch?: number;
            world: string;
            x: string | number;
            y?: string | number;
            yaw?: number;
            z: string | number;
        };
        stats?: {
            balance: number;
            maxTownBlocks?: number;
            numResidents?: number;
            numTownBlocks?: number;
            numTowns?: number;
        };
        status?: Partial<{
            isCapital: boolean;
            isNPC: boolean;
            isNeutral: boolean;
            isOnline: boolean;
            isOpen: boolean;
            isOverClaimed: boolean;
            isPublic: boolean;
            isRuined: boolean;
        }>;
        towns: string[];
        uuid?: string;
        wealth?: number;
        wiki?: string;
    } | (NotFoundError | {
        allies?: string[];
        area: number;
        capital: {
            name: string;
            x: string | number;
            z: string | number;
        };
        councillors: string[];
        enemies?: string[];
        king: string;
        mapColorHexCode?: string;
        name: string;
        ranks?: {
            [key: string]: string[];
        };
        residents: string[];
        spawn?: {
            pitch?: number;
            world: string;
            x: string | number;
            y?: string | number;
            yaw?: number;
            z: string | number;
        };
        stats?: {
            balance: number;
            maxTownBlocks?: number;
            numResidents?: number;
            numTownBlocks?: number;
            numTowns?: number;
        };
        status?: Partial<{
            isCapital: boolean;
            isNPC: boolean;
            isNeutral: boolean;
            isOnline: boolean;
            isOpen: boolean;
            isOverClaimed: boolean;
            isPublic: boolean;
            isRuined: boolean;
        }>;
        towns: string[];
        uuid?: string;
        wealth?: number;
        wiki?: string;
    })[]>

Readonlyjoinable

  • joinable(townName, nationless?): Promise<{
        allies?: string[];
        area: number;
        capital: {
            name: string;
            x: string | number;
            z: string | number;
        };
        councillors: string[];
        enemies?: string[];
        king: string;
        mapColorHexCode?: string;
        name: string;
        ranks?: {
            [key: string]: string[];
        };
        residents: string[];
        spawn?: {
            pitch?: number;
            world: string;
            x: string | number;
            y?: string | number;
            yaw?: number;
            z: string | number;
        };
        stats?: {
            balance: number;
            maxTownBlocks?: number;
            numResidents?: number;
            numTownBlocks?: number;
            numTowns?: number;
        };
        status?: Partial<{
            isCapital: boolean;
            isNPC: boolean;
            isNeutral: boolean;
            isOnline: boolean;
            isOpen: boolean;
            isOverClaimed: boolean;
            isPublic: boolean;
            isRuined: boolean;
        }>;
        towns: string[];
        uuid?: string;
        wealth?: number;
        wiki?: string;
    }[]>

  • Parameters

    • townName: string
    • nationless: boolean = true

    Returns Promise<{
        allies?: string[];
        area: number;
        capital: {
            name: string;
            x: string | number;
            z: string | number;
        };
        councillors: string[];
        enemies?: string[];
        king: string;
        mapColorHexCode?: string;
        name: string;
        ranks?: {
            [key: string]: string[];
        };
        residents: string[];
        spawn?: {
            pitch?: number;
            world: string;
            x: string | number;
            y?: string | number;
            yaw?: number;
            z: string | number;
        };
        stats?: {
            balance: number;
            maxTownBlocks?: number;
            numResidents?: number;
            numTownBlocks?: number;
            numTowns?: number;
        };
        status?: Partial<{
            isCapital: boolean;
            isNPC: boolean;
            isNeutral: boolean;
            isOnline: boolean;
            isOpen: boolean;
            isOverClaimed: boolean;
            isPublic: boolean;
            isRuined: boolean;
        }>;
        towns: string[];
        uuid?: string;
        wealth?: number;
        wiki?: string;
    }[]>

Readonlynearby

  • nearby(location, radius, nations?): Promise<{
        allies?: string[];
        area: number;
        capital: {
            name: string;
            x: string | number;
            z: string | number;
        };
        councillors: string[];
        enemies?: string[];
        king: string;
        mapColorHexCode?: string;
        name: string;
        ranks?: {
            [key: string]: string[];
        };
        residents: string[];
        spawn?: {
            pitch?: number;
            world: string;
            x: string | number;
            y?: string | number;
            yaw?: number;
            z: string | number;
        };
        stats?: {
            balance: number;
            maxTownBlocks?: number;
            numResidents?: number;
            numTownBlocks?: number;
            numTowns?: number;
        };
        status?: Partial<{
            isCapital: boolean;
            isNPC: boolean;
            isNeutral: boolean;
            isOnline: boolean;
            isOpen: boolean;
            isOverClaimed: boolean;
            isPublic: boolean;
            isRuined: boolean;
        }>;
        towns: string[];
        uuid?: string;
        wealth?: number;
        wiki?: string;
    }[]>

  • Parameters

    • location: StrictPoint2D
    • radius: StrictPoint2D
    • Optionalnations: {
          allies?: string[];
          area: number;
          capital: {
              name: string;
              x: string | number;
              z: string | number;
          };
          councillors: string[];
          enemies?: string[];
          king: string;
          mapColorHexCode?: string;
          name: string;
          ranks?: {
              [key: string]: string[];
          };
          residents: string[];
          spawn?: {
              pitch?: number;
              world: string;
              x: string | number;
              y?: string | number;
              yaw?: number;
              z: string | number;
          };
          stats?: {
              balance: number;
              maxTownBlocks?: number;
              numResidents?: number;
              numTownBlocks?: number;
              numTowns?: number;
          };
          status?: Partial<{
              isCapital: boolean;
              isNPC: boolean;
              isNeutral: boolean;
              isOnline: boolean;
              isOpen: boolean;
              isOverClaimed: boolean;
              isPublic: boolean;
              isRuined: boolean;
          }>;
          towns: string[];
          uuid?: string;
          wealth?: number;
          wiki?: string;
      }[]

    Returns Promise<{
        allies?: string[];
        area: number;
        capital: {
            name: string;
            x: string | number;
            z: string | number;
        };
        councillors: string[];
        enemies?: string[];
        king: string;
        mapColorHexCode?: string;
        name: string;
        ranks?: {
            [key: string]: string[];
        };
        residents: string[];
        spawn?: {
            pitch?: number;
            world: string;
            x: string | number;
            y?: string | number;
            yaw?: number;
            z: string | number;
        };
        stats?: {
            balance: number;
            maxTownBlocks?: number;
            numResidents?: number;
            numTownBlocks?: number;
            numTowns?: number;
        };
        status?: Partial<{
            isCapital: boolean;
            isNPC: boolean;
            isNeutral: boolean;
            isOnline: boolean;
            isOpen: boolean;
            isOverClaimed: boolean;
            isPublic: boolean;
            isRuined: boolean;
        }>;
        towns: string[];
        uuid?: string;
        wealth?: number;
        wiki?: string;
    }[]>

Settings

Member Visibility

On This Page

constructormapallgetjoinablenearby