Class Towns

Implements

Constructors

constructor

Accessors

map

Methods

all fromNation get invitable nearby

Constructors

constructor

Accessors

map

Methods

Readonlyall

  • all(removeAccents?): Promise<{
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    }[]>

  • Parameters

    • removeAccents: boolean = false

    Returns Promise<{
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    }[]>

ReadonlyfromNation

  • fromNation(nationName): Promise<NotFoundError | {
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    } | (NotFoundError | {
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    })[]>

  • Parameters

    • nationName: string

    Returns Promise<NotFoundError | {
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    } | (NotFoundError | {
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    })[]>

Readonlyget

  • get(...townList): Promise<NotFoundError | {
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    } | (NotFoundError | {
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    })[]>
  • Internal

    Parameters

    • Rest...townList: string[]

    Returns Promise<NotFoundError | {
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    } | (NotFoundError | {
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    })[]>

Readonlyinvitable

  • invitable(nationName, includeBelonging?): Promise<{
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    }[]>

  • Parameters

    • nationName: string
    • includeBelonging: boolean = false

    Returns Promise<{
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    }[]>

Readonlynearby

  • nearby(location, radius, towns?): Promise<{
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    }[]>

  • Parameters

    • location: StrictPoint2D
    • radius: StrictPoint2D
    • Optionaltowns: {
          area: number;
          balance?: number;
          bounds: TownBounds;
          colours: {
              fill: `#${string}`;
              outline: `#${string}`;
          };
          flags: {
              capital: boolean;
              explosion: boolean;
              fire: boolean;
              mobs: boolean;
              public: boolean;
              pvp: boolean;
          };
          founder?: string;
          mayor: string;
          name: string;
          nation: string;
          opacities?: {
              fill: Opacity;
              outline: Opacity;
          };
          outlaws?: string[];
          residents: string[];
          timestamps?: {
              founded: number;
              joinedNation?: number;
          };
          trusted?: string[];
          wiki?: string;
          x: number;
          z: number;
      }[]

    Returns Promise<{
        area: number;
        balance?: number;
        bounds: TownBounds;
        colours: {
            fill: `#${string}`;
            outline: `#${string}`;
        };
        flags: {
            capital: boolean;
            explosion: boolean;
            fire: boolean;
            mobs: boolean;
            public: boolean;
            pvp: boolean;
        };
        founder?: string;
        mayor: string;
        name: string;
        nation: string;
        opacities?: {
            fill: Opacity;
            outline: Opacity;
        };
        outlaws?: string[];
        residents: string[];
        timestamps?: {
            founded: number;
            joinedNation?: number;
        };
        trusted?: string[];
        wiki?: string;
        x: number;
        z: number;
    }[]>

Settings

Member Visibility

On This Page

constructormapallfromNationgetinvitablenearby