Class Squaremap

constructor

• new Squaremap(mapName, cacheTimeoutMs?): Squaremap

• Parameters

  • mapName: "aurora"
  • cacheTimeoutMs: number = 5000

  Returns Squaremap

ReadonlyGPS

ReadonlyNations

ReadonlyPlayers

ReadonlyResidents

ReadonlyTowns

URLBuilder

ReadonlyinviteRange

Readonlyname

ReadonlybuildMapLink

• buildMapLink(location?, zoom?): URL

• Parameters

  • Optionallocation: Point2D
  • Optionalzoom: number

  Returns URL

  Deprecated

  May be removed in future. Prefer URLBuilder instead.

ReadonlyisWilderness

• isWilderness(location): Promise<boolean>

• Parameters

  • location: Point2D

  Returns Promise<boolean>

Readonlymarkerset

• markerset(): Promise<{
      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;
  }>

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

ReadonlyonlinePlayerData

• onlinePlayerData(): Promise<{
      name: string;
      nickname?: string;
      underground?: boolean;
      world?: string;
      x: string | number;
      yaw?: string | number;
      z: string | number;
  }[]>

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

ReadonlywithinBounds

• withinBounds(location, bounds): boolean

• Parameters

  • location: Point2D
  • bounds: TownBounds

  Returns boolean

ReadonlywithinTown

• withinTown(location): Promise<boolean>

• Parameters

  • location: Point2D

  Returns Promise<boolean>