Blockbench Reference Docs
    Preparing search index...

    Interface Math

    interface Math {
        clamp: (number: number, min: number, max: number) => number;
        getLerp: (a: number, b: number, m: number) => number;
        hermiteBlend: (input: number) => number;
        lerp: (a: number, b: number, alpha: number) => number;
        randomInteger: (a: number, b: number) => number;
        areMultiples(number1: number, number2: number): boolean;
        degToRad(degrees: number): number;
        epsilon(a: number, b: number, epsilon: number): boolean;
        getNextPower(num: number, min: number): number;
        isBetween(number: number, limit1: number, limit2: number): boolean;
        isNumber(number: any): boolean;
        isPowerOfTwo(number: number): boolean;
        limitNumber(number: number, min: number, max: number): number;
        radToDeg(radians: number): number;
        randomab(a: number, b: number): number;
        roundTo(number: number, digits: number): number;
        snapToValues(
            number: number,
            snap_points: number[],
            epsilon: number,
        ): number;
        trimDeg(degrees: number): number;
    }
    Index

    Properties

    clamp getLerp hermiteBlend lerp randomInteger

    Methods

    areMultiples degToRad epsilon getNextPower isBetween isNumber isPowerOfTwo limitNumber radToDeg randomab roundTo snapToValues trimDeg

    Properties

    clamp: (number: number, min: number, max: number) => number
    getLerp: (a: number, b: number, m: number) => number

    Get the lerp alpha value of m, between points a and b

    hermiteBlend: (input: number) => number
    lerp: (a: number, b: number, alpha: number) => number

    Lerp between a and b using the 0-1 alpha value

    randomInteger: (a: number, b: number) => number

    Return a random integer

    Methods

    • Parameters

      • number1: number
      • number2: number

      Returns boolean

    • Checks if the absolute difference between a and b is smaller than epsilon

      Parameters

      • a: number
      • b: number
      • epsilon: number

      Returns boolean

    • Return the next highest power of n

      Parameters

      • num: number

        Power

      • min: number

        Value that the result should be equal to or higher than

      Returns number

    • Test if the number is between two other numbers

      Parameters

      • number: number
      • limit1: number
      • limit2: number

      Returns boolean

    • Checks if the input is of type number

      Parameters

      • number: any

      Returns boolean

    • Parameters

      • number: number
      • min: number
      • max: number

      Returns number

    • Generates a random float between a and b

      Parameters

      • a: number
      • b: number

      Returns number

    • Rounds the input number to N digits

      Parameters

      • number: number
      • digits: number

      Returns number

    • Snap the value to the closest number in a list of 1 or more snap points

      Parameters

      • number: number
      • snap_points: number[]
      • epsilon: number

      Returns number

    • Take a rotation value in degrees, and trim it to a value between -180 and 180, while keeping the same angle

      Parameters

      • degrees: number

      Returns number

    Settings

    Member Visibility

    On This Page

    Properties
    Methods