Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Function toNearest

    • Round a number to the closest number which substracted from the base is a multiple of the provided interval. This is a convenience function intended to humanize issues of floating point precision. The interval is treated as a standard string representation to determine the amount of decimal truncation applied.

      Parameters

      • this: number
      • interval: number = 1

        The step interval

      • Optionalmethod: "round" | "ceil" | "floor" = "round"

        The rounding method

      • Optionalbase: number = 0

        The step base

      Returns number

      The rounded number

      let n = 17.18;
      n.toNearest(5); // 15
      n.toNearest(10); // 20
      n.toNearest(10, "floor"); // 10
      n.toNearest(10, "ceil"); // 20
      n.toNearest(0.25); // 17.25
      n.toNearest(2, "round", 1); // 17