@glitchybyte/dash
    Preparing search index...

    Class GMath

    Math utilities.

    Index

    Constructors

    Methods

    • Returns the clamped value, no lower than low and not higher than high.

      Parameters

      • value: number

        Value to clamp.

      • low: number

        Low limit.

      • high: number

        High limit.

      Returns number

    • Linear interpolation between two values.

      Parameters

      • x: number

        Interpolation value. 0 aligns to low, 1 aligns to high.

      • low: number

        Low limit.

      • high: number

        High limit.

      Returns number

    • Return the largest value.

      This is way faster than Math.max for two values.

      Parameters

      • v1: number

        The 1st value.

      • v2: number

        The 2nd value.

      Returns number

      The largest value.

    • Return the smallest value.

      This is way faster than Math.min for two values.

      Parameters

      • v1: number

        The 1st value.

      • v2: number

        The 2nd value.

      Returns number

      The smallest value.

    • Returns a random float within range [0, limit)

      Parameters

      • limit: number

        The upper exclusive limit of the range.

      Returns number

      A random float.

    • Returns a random "true" or "false" value.

      Parameters

      • truthProbability: number = 0.5

        The probability of returning true. Default is 50%.

      Returns boolean

      A random int.

    • Returns a random float within range [low, high)

      Parameters

      • low: number

        The lower inclusive limit.

      • high: number

        The upper exclusive limit.

      Returns number

      A random float.

    • Returns a random int within range [0, limit)

      Parameters

      • limit: number

        The upper exclusive limit of the range.

      Returns number

      A random int.

    • Returns a random int within range [low, high)

      Parameters

      • low: number

        The lower inclusive limit.

      • high: number

        The upper exclusive limit.

      Returns number

      A random int.

    • Returns a random index picked according to its weight.

      Parameters

      • weights: number[]

        An array of weights.

      Returns number

    • Returns the calculated average of adding one more value to a previous average.

      Parameters

      • count: number

        Item count including the new one.

      • previousAverage: number

        Average so far.

      • value: number

        New item to add to average.

      Returns number

    • Returns a rectangle that covers the enclosing rectangle whose smaller side is minSide with the given rectangle of the given width and height, maintaining aspect ratio.

      Parameters

      • width: number

        Width of a rectangle.

      • height: number

        Height of a rectangle.

      • minSize: number

        Smaller side of the enclosing rectangle.

      Returns { height: number; width: number }

    • Returns a rectangle that fits the given rectangle of the given width and height into an enclosing rectangle whose large side is maxSide, maintaining aspect ratio.

      Parameters

      • width: number

        Width of a rectangle.

      • height: number

        Height of a rectangle.

      • maxSize: number

        Larger side of the enclosing rectangle.

      Returns { height: number; width: number }