From 7b226c22d33fd08fbe0888adeb397a7ae437a337 Mon Sep 17 00:00:00 2001 From: Owen Date: Thu, 1 Aug 2024 07:46:20 +0100 Subject: [PATCH] docs --- docs/classes/api_squaremap_Nations.Nations.html | 2 +- docs/functions/api_squaremap_parser.parseNations.html | 2 +- docs/functions/api_squaremap_parser.parsePlayers.html | 2 +- docs/functions/api_squaremap_parser.parseResidents.html | 2 +- docs/types/types_nation.SquaremapNation.html | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/classes/api_squaremap_Nations.Nations.html b/docs/classes/api_squaremap_Nations.Nations.html index 7538bf7..6a49d74 100644 --- a/docs/classes/api_squaremap_Nations.Nations.html +++ b/docs/classes/api_squaremap_Nations.Nations.html @@ -4,4 +4,4 @@ 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
\ No newline at end of file +

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
\ No newline at end of file diff --git a/docs/functions/api_squaremap_parser.parseNations.html b/docs/functions/api_squaremap_parser.parseNations.html index d5c4d33..4b67fd5 100644 --- a/docs/functions/api_squaremap_parser.parseNations.html +++ b/docs/functions/api_squaremap_parser.parseNations.html @@ -1 +1 @@ -parseNations | EarthMC-NPM

Function parseNations

  • parseNations(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

    • towns: {
          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;
    }[]>

Settings

Member Visibility
\ No newline at end of file +parseNations | EarthMC-NPM

Function parseNations

  • parseNations(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

    • towns: {
          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;
    }[]>

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/api_squaremap_parser.parsePlayers.html b/docs/functions/api_squaremap_parser.parsePlayers.html index d9f1397..830aaf3 100644 --- a/docs/functions/api_squaremap_parser.parsePlayers.html +++ b/docs/functions/api_squaremap_parser.parsePlayers.html @@ -1 +1 @@ -parsePlayers | EarthMC-NPM

Function parsePlayers

  • parsePlayers(players): {
        name: string;
        nickname?: string;
        underground?: boolean;
        world?: string;
        x: string | number;
        yaw?: string | number;
        z: string | number;
    }[]

  • Parameters

    • players: {
          display_name: string;
          name: string;
          uuid: string;
          world: string;
          x: string | number;
          yaw: string | number;
          z: string | number;
      }[]

    Returns {
        name: string;
        nickname?: string;
        underground?: boolean;
        world?: string;
        x: string | number;
        yaw?: string | number;
        z: string | number;
    }[]

Settings

Member Visibility
\ No newline at end of file +parsePlayers | EarthMC-NPM

Function parsePlayers

  • parsePlayers(players): {
        name: string;
        nickname?: string;
        underground?: boolean;
        world?: string;
        x: string | number;
        yaw?: string | number;
        z: string | number;
    }[]

  • Parameters

    • players: {
          display_name: string;
          name: string;
          uuid: string;
          world: string;
          x: string | number;
          yaw: string | number;
          z: string | number;
      }[]

    Returns {
        name: string;
        nickname?: string;
        underground?: boolean;
        world?: string;
        x: string | number;
        yaw?: string | number;
        z: string | number;
    }[]

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/api_squaremap_parser.parseResidents.html b/docs/functions/api_squaremap_parser.parseResidents.html index 3add95c..b85c700 100644 --- a/docs/functions/api_squaremap_parser.parseResidents.html +++ b/docs/functions/api_squaremap_parser.parseResidents.html @@ -1 +1 @@ -parseResidents | EarthMC-NPM

Function parseResidents

  • parseResidents(towns): Resident[]

  • Parameters

    • towns: {
          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 Resident[]

Settings

Member Visibility
\ No newline at end of file +parseResidents | EarthMC-NPM

Function parseResidents

  • parseResidents(towns): Resident[]

  • Parameters

    • towns: {
          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 Resident[]

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/types/types_nation.SquaremapNation.html b/docs/types/types_nation.SquaremapNation.html index 3b11437..66da898 100644 --- a/docs/types/types_nation.SquaremapNation.html +++ b/docs/types/types_nation.SquaremapNation.html @@ -1 +1 @@ -SquaremapNation | EarthMC-NPM

Type Alias SquaremapNation

SquaremapNation: Prettify<Nation & {
    councillors: string[];
    wealth: number;
}>

Settings

Member Visibility
\ No newline at end of file +SquaremapNation | EarthMC-NPM

Type Alias SquaremapNation

SquaremapNation: Prettify<Nation & {
    councillors: string[];
    wealth?: number;
}>

Settings

Member Visibility
\ No newline at end of file