Class GPS

constructor

• new GPS(map): GPS

• Parameters

  • map: Dynmap

  Returns GPS

Static ReadonlyRoutes

emittedUnderground

• get emittedUnderground(): boolean

• Returns boolean

• set emittedUnderground(val): void

• Parameters

  • val: boolean

  Returns void

lastLoc

• get lastLoc(): {
      x: number;
      z: number;
  }

• Returns {
      x: number;
      z: number;
  }

  • x: number

  • z: number

• set lastLoc(val): void

• Parameters

  • val: {
        x: number;
        z: number;
    }

    • x: number

    • z: number

  Returns void

map

• get map(): Dynmap

• Returns Dynmap

ReadonlyfastestRoute

• fastestRoute(loc): Promise<{
      direction: string;
      distance: number;
      nation: RouteInfoNation | {
          capital: {
              name: string;
              x: string | number;
              z: string | number;
          };
          name: string;
      };
  }>

• Parameters

  • loc: {
        x: string | number;
        y?: string | number;
        z: string | number;
    }

    • x: string | number

    • Optionaly?: string | number

    • z: string | number

  Returns Promise<{
      direction: string;
      distance: number;
      nation: RouteInfoNation | {
          capital: {
              name: string;
              x: string | number;
              z: string | number;
          };
          name: string;
      };
  }>

ReadonlyfindRoute

• findRoute(loc, options): Promise<{
      direction: string;
      distance: number;
      nation: RouteInfoNation | {
          capital: {
              name: string;
              x: string | number;
              z: string | number;
          };
          name: string;
      };
  }>

• Parameters

  • loc: {
        x: string | number;
        y?: string | number;
        z: string | number;
    }

    • x: string | number

    • Optionaly?: string | number

    • z: string | number

  • options: {
        avoidPrivate: boolean;
        avoidPvp: boolean;
    }

    • avoidPrivate: boolean

    • avoidPvp: boolean

  Returns Promise<{
      direction: string;
      distance: number;
      nation: RouteInfoNation | {
          capital: {
              name: string;
              x: string | number;
              z: string | number;
          };
          name: string;
      };
  }>

playerIsOnline

• playerIsOnline(player): boolean

• Parameters

  • player: {
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        y?: string | number;
        z?: string | number;
    }

    • name: string

    • Optionalnation?: string

    • Optionalnickname?: string

    • online: boolean

    • rank: string

    • town: string

    • Optionalunderground?: boolean

    • Optionalworld?: string

    • Optionalx?: string | number

    • Optionaly?: string | number

    • Optionalz?: string | number

  Returns boolean

ReadonlysafestRoute

• safestRoute(loc): Promise<{
      direction: string;
      distance: number;
      nation: RouteInfoNation | {
          capital: {
              name: string;
              x: string | number;
              z: string | number;
          };
          name: string;
      };
  }>

• Parameters

  • loc: {
        x: string | number;
        y?: string | number;
        z: string | number;
    }

    • x: string | number

    • Optionaly?: string | number

    • z: string | number

  Returns Promise<{
      direction: string;
      distance: number;
      nation: RouteInfoNation | {
          capital: {
              name: string;
              x: string | number;
              z: string | number;
          };
          name: string;
      };
  }>

Readonlytrack

• track(playerName, interval?, route?): Promise<GPS>

• Parameters

  • playerName: string
  • interval: number = 3000
  • route: {
        avoidPrivate: boolean;
        avoidPvp: boolean;
    } = Routes.FASTEST

    • avoidPrivate: boolean

    • avoidPvp: boolean

  Returns Promise<GPS>

StaticcardinalDirection

• cardinalDirection(origin, destination):
      | "east"
      | "north"
      | "west"
      | "south"

• Determines the direction to the destination from the origin.

  Only one of the main four directions (N, S, W, E) can be returned, no intermediates.

  Parameters

  • origin: {
        x: string | number;
        y?: string | number;
        z: string | number;
    }

    The location where something is currently at.

    • x: string | number

    • Optionaly?: string | number

    • z: string | number

  • destination: {
        x: string | number;
        y?: string | number;
        z: string | number;
    }

    The location we wish to arrive at.

    • x: string | number

    • Optionaly?: string | number

    • z: string | number

  Returns
      | "east"
      | "north"
      | "west"
      | "south"