From 324857217462f94797a63b59b82ab6abec6f7e55 Mon Sep 17 00:00:00 2001 From: Owen Date: Sat, 13 Jul 2024 12:04:51 +0100 Subject: [PATCH] docs --- docs/classes/OAPI.OAPIV2.html | 4 ++-- docs/classes/OAPI.OAPIV3.html | 4 ++-- docs/functions/api_squaremap_parser.parseInfoString.html | 2 +- docs/functions/api_squaremap_parser.parseNations.html | 2 +- docs/functions/api_squaremap_parser.parsePlayers.html | 2 +- docs/functions/api_squaremap_parser.parsePopup.html | 2 +- docs/functions/api_squaremap_parser.parseResidents.html | 2 +- docs/functions/api_squaremap_parser.parseTowns.html | 2 +- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/classes/OAPI.OAPIV2.html b/docs/classes/OAPI.OAPIV2.html index e3f8823..ca474f2 100644 --- a/docs/classes/OAPI.OAPIV2.html +++ b/docs/classes/OAPI.OAPIV2.html @@ -1,6 +1,6 @@ -OAPIV2 | EarthMC-NPM

Class OAPIV2

Constructors

constructor +OAPIV2 | EarthMC-NPM

Class OAPIV2

Constructors

constructor

Methods

nation resident serverInfo town -

Constructors

constructor

Methods

Staticnation

Staticresident

StaticserverInfo

Statictown

Settings

Member Visibility

On This Page

constructornationresidentserverInfotown
\ No newline at end of file +

Constructors

constructor

Methods

Staticnation

Staticresident

StaticserverInfo

Statictown

Settings

Member Visibility

On This Page

constructornationresidentserverInfotown
\ No newline at end of file diff --git a/docs/classes/OAPI.OAPIV3.html b/docs/classes/OAPI.OAPIV3.html index 14411f6..b3bc59d 100644 --- a/docs/classes/OAPI.OAPIV3.html +++ b/docs/classes/OAPI.OAPIV3.html @@ -1,3 +1,3 @@ -OAPIV3 | EarthMC-NPM

Class OAPIV3

Constructors

constructor +OAPIV3 | EarthMC-NPM

Class OAPIV3

Constructors

constructor

Methods

serverInfo -

Constructors

constructor

Methods

StaticserverInfo

Settings

Member Visibility

On This Page

constructorserverInfo
\ No newline at end of file +

Constructors

constructor

Methods

StaticserverInfo

Settings

Member Visibility

On This Page

constructorserverInfo
\ No newline at end of file diff --git a/docs/functions/api_squaremap_parser.parseInfoString.html b/docs/functions/api_squaremap_parser.parseInfoString.html index c238d3f..6ded24e 100644 --- a/docs/functions/api_squaremap_parser.parseInfoString.html +++ b/docs/functions/api_squaremap_parser.parseInfoString.html @@ -1 +1 @@ -parseInfoString | EarthMC-NPM

Function parseInfoString

Settings

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

Function parseInfoString

Settings

Member Visibility
\ 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 47ffb22..875dd19 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 62c3541..c6282ee 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): SquaremapPlayer[]

  • Parameters

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

    Returns SquaremapPlayer[]

Settings

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

Function parsePlayers

  • parsePlayers(players): SquaremapPlayer[]

  • Parameters

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

    Returns SquaremapPlayer[]

Settings

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

Function parsePopup

Settings

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

Function parsePopup

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 6753f1a..611ad0d 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/functions/api_squaremap_parser.parseTowns.html b/docs/functions/api_squaremap_parser.parseTowns.html index 169baae..737632c 100644 --- a/docs/functions/api_squaremap_parser.parseTowns.html +++ b/docs/functions/api_squaremap_parser.parseTowns.html @@ -1 +1 @@ -parseTowns | EarthMC-NPM

Function parseTowns

  • parseTowns(res, removeAccents?): Promise<{
        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;
    }[]>

  • Parameters

    • res: {
          control: boolean;
          hide: boolean;
          id: "towny" | "chunky";
          markers: {
              anchor?: Point2D;
              color?: `#${string}`;
              fill?: boolean;
              fillColor?: `#${string}`;
              fillOpacity?: Opacity;
              icon?: string;
              opacity?: Opacity;
              point?: Point2D;
              points?: StrictPoint2D[] | StrictPoint2D[][][];
              popup: string;
              size?: Point2D;
              tooltip: string;
              tooltip_anchor?: Point2D;
              type: SquaremapAreaType;
          }[];
          name: string;
          order: number;
          timestamp: number;
          z_index: number;
      }
      • control: boolean
      • hide: boolean
      • id: "towny" | "chunky"
      • markers: {
            anchor?: Point2D;
            color?: `#${string}`;
            fill?: boolean;
            fillColor?: `#${string}`;
            fillOpacity?: Opacity;
            icon?: string;
            opacity?: Opacity;
            point?: Point2D;
            points?: StrictPoint2D[] | StrictPoint2D[][][];
            popup: string;
            size?: Point2D;
            tooltip: string;
            tooltip_anchor?: Point2D;
            type: SquaremapAreaType;
        }[]
      • name: string
      • order: number
      • timestamp: number
      • z_index: number
    • removeAccents: boolean = false

    Returns Promise<{
        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;
    }[]>

Settings

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

Function parseTowns

  • parseTowns(res, removeAccents?): Promise<{
        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;
    }[]>

  • Parameters

    • res: {
          control: boolean;
          hide: boolean;
          id: "towny" | "chunky";
          markers: {
              anchor?: Point2D;
              color?: `#${string}`;
              fill?: boolean;
              fillColor?: `#${string}`;
              fillOpacity?: Opacity;
              icon?: string;
              opacity?: Opacity;
              point?: Point2D;
              points?: StrictPoint2D[] | StrictPoint2D[][][];
              popup: string;
              size?: Point2D;
              tooltip: string;
              tooltip_anchor?: Point2D;
              type: SquaremapAreaType;
          }[];
          name: string;
          order: number;
          timestamp: number;
          z_index: number;
      }
      • control: boolean
      • hide: boolean
      • id: "towny" | "chunky"
      • markers: {
            anchor?: Point2D;
            color?: `#${string}`;
            fill?: boolean;
            fillColor?: `#${string}`;
            fillOpacity?: Opacity;
            icon?: string;
            opacity?: Opacity;
            point?: Point2D;
            points?: StrictPoint2D[] | StrictPoint2D[][][];
            popup: string;
            size?: Point2D;
            tooltip: string;
            tooltip_anchor?: Point2D;
            type: SquaremapAreaType;
        }[]
      • name: string
      • order: number
      • timestamp: number
      • z_index: number
    • removeAccents: boolean = false

    Returns Promise<{
        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;
    }[]>

Settings

Member Visibility
\ No newline at end of file