Pathfinder 1e for Foundry VTT
    Preparing search index...

    Function swapDistance

    • Convert miles, feet and inches to metric units and kilometers, meters and centimeters to imperial units as appropriate.

      Parameters

      • value: number

        A numeric value representing the length of the distance

      • type: "m" | "mi" | "km" | "ft" | "in" | "cm"

        The distance unit

      • exact: boolean = false

        If true, conversions are by tactical map logic (5ft = 1.5m). If false, exact conversions are used.

      Returns [range: number, unit: "m" | "mi" | "km" | "ft" | "in" | "cm"]

      • The resulting value and unit
      pf1.utils.swapDistance(30, "ft"); // => [9, "m"]
      pf1.utils.swapDistance(9, "m"); // => [30, "ft"]
      pf1.utils.swapDistance(1, "in"); // => [2.5, "cm"]
      • On invalid parameters.