@tlua/gmod 1.0.5 → 1.0.6

package/types/math.d.tlua

@@ -40,18 +40,21 @@
  */
 interface MathLib {
     ease: MatheaseLib;
+
     /**
      * Calculates the difference between two angles.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.AngleDifference
      */
     AngleDifference(a: number, b: number): number;
+
     /**
      * Gradually approaches the target value by the specified amount.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.Approach
      */
     Approach(current: number, target: number, change: number): number;
+
     /**
      * Increments an angle towards another by specified rate.
      *
@@ -62,30 +65,35 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.ApproachAngle
      */
     ApproachAngle(currentAngle: number, targetAngle: number, rate: number): number;
+
     /**
      * Basic code for Bézier-Spline algorithm.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.BSplinePoint
      */
     BSplinePoint(fraction: number, points: table, fractionMax: number): Vector;
+
     /**
      * Converts a binary string into a number.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.BinToInt
      */
     BinToInt(string: string): number;
+
     /**
      * Cubic Hermite spline algorithm.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.CHSpline
      */
     CHSpline(frac: number, point0: Vector, tan0: Vector, point1: Vector, tan1: Vector): Vector;
+
     /**
      * Clamps a number between a minimum and maximum value.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.Clamp
      */
     Clamp(input: number, min: number, max: number): number;
+
     /**
      * Lerp point between 4 control points with cubic bezier.
      *
@@ -95,6 +103,7 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.CubicBezier
      */
     CubicBezier(frac: number, p0: Vector, p1: Vector, p2: Vector, p3: Vector): Vector;
+
     /**
      * Returns the difference between two points in 2D space. Alias of [math.Distance](https://wiki.facepunch.com/gmod/math.Distance).
      *
@@ -103,12 +112,14 @@ interface MathLib {
      * @deprecated You should use math.Distance instead
      */
     Dist(x1: number, y1: number, x2: number, y2: number): number;
+
     /**
      * Returns the difference between two points in 2D space.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.Distance
      */
     Distance(x1: number, y1: number, x2: number, y2: number): number;
+
     /**
      * Returns the squared difference between two points in 2D space. This is computationally faster than [math.Distance](https://wiki.facepunch.com/gmod/math.Distance).
      *
@@ -116,24 +127,28 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.DistanceSqr
      */
     DistanceSqr(x1: number, y1: number, x2: number, y2: number): number;
+
     /**
      * Calculates the progress of a value fraction, taking in to account given easing fractions
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.EaseInOut
      */
     EaseInOut(progress: number, easeIn?: number, easeOut?: number): number;
+
     /**
      * Simple function that calculates [factorial](https://en.wikipedia.org/wiki/Factorial) of a whole number.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.Factorial
      */
     Factorial(val_in: number): number;
+
     /**
      * Converts an integer to a binary (base-2) string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.IntToBin
      */
     IntToBin(int: number): string;
+
     /**
      * Checks if two floating point numbers are nearly equal.
      *
@@ -144,12 +159,14 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.IsNearlyEqual
      */
     IsNearlyEqual(a: number, b: number, tolerance?: number): boolean;
+
     /**
      * Normalizes angle, so it returns value between -180 and 180.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.NormalizeAngle
      */
     NormalizeAngle(angle: number): number;
+
     /**
      * Lerp point between 3 control points with quadratic bezier.
      *
@@ -159,6 +176,7 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.QuadraticBezier
      */
     QuadraticBezier(frac: number, p0: Vector, p1: Vector, p2: Vector): Vector;
+
     /**
      * Returns a random float between min and max.
      *
@@ -168,18 +186,21 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.Rand
      */
     Rand(min: number, max: number): number;
+
     /**
      * Remaps the value from one range to another
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.Remap
      */
     Remap(value: number, inMin: number, inMax: number, outMin: number, outMax: number): number;
+
     /**
      * Rounds the given value to the nearest whole number or to the given decimal places.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.Round
      */
     Round(value: number, decimals?: number): number;
+
     /**
      * Returns the mathematical negative/positive sign of the input number.
      *
@@ -187,48 +208,56 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.Sign
      */
     Sign(value: number): number;
+
     /**
      * Snaps a number to the closest multiplicative of given number. See also [Angle:SnapTo](https://wiki.facepunch.com/gmod/Angle:SnapTo).
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.SnapTo
      */
     SnapTo(input: number, snapTo: number): number;
+
     /**
      * Returns the fraction of where the current time is relative to the start and end times
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.TimeFraction
      */
     TimeFraction(start: number, _end: number, current: number): number;
+
     /**
      * Trim unwanted decimal places.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.Truncate
      */
     Truncate(num: number, digits?: number): number;
+
     /**
      * Calculates the absolute value of a number (effectively removes any negative sign).
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.abs
      */
     abs(x: number): number;
+
     /**
      * Returns the [arccosine](https://en.wikipedia.org/wiki/Arccosine) of the given number.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.acos
      */
     acos(cos: number): number;
+
     /**
      * Returns the [arcsine](https://en.wikipedia.org/wiki/Inverse_trigonometric_functions) of the given number.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.asin
      */
     asin(normal: number): number;
+
     /**
      * Returns the [arctangent](https://en.wikipedia.org/wiki/Inverse_trigonometric_functions) of the given number.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.atan
      */
     atan(normal: number): number;
+
     /**
      * functions like [math.atan](https://wiki.facepunch.com/gmod/math.atan)(y / x), except it also takes into account the quadrant of the angle and so doesn't have a limited range of output.
      *
@@ -239,6 +268,7 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.atan2
      */
     atan2(y: number, x: number): number;
+
     /**
      * **INTERNAL**: Use [math.BSplinePoint](https://wiki.facepunch.com/gmod/math.BSplinePoint) instead.
      *
@@ -249,6 +279,7 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.calcBSplineN
      */
     calcBSplineN(i: number, k: number, t: number, tinc: number): number;
+
     /**
      * Ceils or rounds a number up.
      *
@@ -257,30 +288,35 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.ceil
      */
     ceil(number: number): number;
+
     /**
      * Returns the [cosine](https://en.wikipedia.org/wiki/Trigonometric_functions#cos) of given angle.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.cos
      */
     cos(number: number): number;
+
     /**
      * Returns the [hyperbolic cosine](https://en.wikipedia.org/wiki/Cosh_(mathematical_function)) of the given angle.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.cosh
      */
     cosh(number: number): number;
+
     /**
      * Converts radians to degrees.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.deg
      */
     deg(radians: number): number;
+
     /**
      * Returns e to the power of the input.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.exp
      */
     exp(exponent: number): number;
+
     /**
      * Floors or rounds a number down.
      *
@@ -289,6 +325,7 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.floor
      */
     floor(number: number): number;
+
     /**
      * Returns the modulus of the specified values.
      *
@@ -300,6 +337,7 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.fmod
      */
     fmod(base: number, modulator: number): number;
+
     /**
      * **Lua reference description**: Returns `m` and `e` such that `x = m2e`, `e` is an integer and the absolute value of `m` is in the range ((0.5, 1) (or zero when x is zero).
      *
@@ -311,6 +349,7 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.frexp
      */
     frexp(x: number): (number, number);
+
     /**
      * Takes a normalised number and returns the floating point representation.
      *
@@ -320,6 +359,7 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.ldexp
      */
     ldexp(normalizedFraction: number, exponent: number): number;
+
     /**
      * With one argument, return the natural logarithm of x (to base e).
      *
@@ -329,24 +369,28 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.log
      */
     log(x: number, base?: number): number;
+
     /**
      * Returns the base-10 logarithm of x. This is usually more accurate than math.log(x, 10).
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.log10
      */
     log10(x: number): number;
+
     /**
      * Returns the largest value of all arguments.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.max
      */
     max(...: any): number;
+
     /**
      * Returns the smallest value of all arguments.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.min
      */
     min(...: any): number;
+
     /**
      * Returns the modulus of the specified values. Same as [math.fmod](https://wiki.facepunch.com/gmod/math.fmod).
      *
@@ -355,12 +399,14 @@ interface MathLib {
      * @deprecated This is removed in Lua versions later than what GMod is currently using. You should use the % operator or math.fmod instead.
      */
     mod(base: number, modulator: number): number;
+
     /**
      * Returns the integral and fractional component of the modulo operation.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.modf
      */
     modf(base: number): (number, number);
+
     /**
      * Returns x raised to the power y.
      * In particular, math.pow(1.0, x) and math.pow(x, 0.0) always return 1.0, even when x is a zero or a [nan](https://wiki.facepunch.com/gmod/nan). If both x and y are finite, x is negative, and y is not an integer then math.pow(x, y) is undefined.
@@ -369,12 +415,14 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.pow
      */
     pow(x: number, y: number): number;
+
     /**
      * Converts an angle in degrees to it's equivalent in radians.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.rad
      */
     rad(degrees: number): number;
+
     /**
      * When called without arguments, returns a uniform pseudo-random real number in the range 0 to 1 which includes 0 but excludes 1.
      *
@@ -388,6 +436,7 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.random
      */
     random(m?: number, n?: number): number;
+
     /**
      * Seeds the random number generator. The same seed will guarantee the same sequence of numbers each time with [math.random](https://wiki.facepunch.com/gmod/math.random).
      *
@@ -402,30 +451,35 @@ interface MathLib {
      * @source https://wiki.facepunch.com/gmod/math.randomseed
      */
     randomseed(seed: number): void;
+
     /**
      * Returns the [sine](https://en.wikipedia.org/wiki/Trigonometric_functions) of given angle.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.sin
      */
     sin(number: number): number;
+
     /**
      * Returns the [hyperbolic sine](https://en.wikipedia.org/wiki/Hyperbolic_functions) of the given angle.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.sinh
      */
     sinh(number: number): number;
+
     /**
      * Returns the square root of the number.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.sqrt
      */
     sqrt(value: number): number;
+
     /**
      * Returns the tangent of the given angle.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.tan
      */
     tan(value: number): number;
+
     /**
      * Returns the [hyperbolic tangent](https://en.wikipedia.org/wiki/Hyperbolic_functions) of the given number.
      * @realm shared and menu
@@ -434,40 +488,6 @@ interface MathLib {
     tanh(number: number): number;
 }
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 interface MatheaseLib {
     /**
      * Eases in by reversing the direction of the ease slightly before returning.
@@ -478,6 +498,7 @@ interface MatheaseLib {
      * @source https://wiki.facepunch.com/gmod/math.ease.InBack
      */
     InBack(fraction: number): number;
+
     /**
      * Eases in like a bouncy ball.
      * 	**NOTE**: This doesn't work properly when used with [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) as it clamps the fraction between 0 and 1. Using your own version of [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) that is unclamped would be necessary instead.
@@ -487,18 +508,21 @@ interface MatheaseLib {
      * @source https://wiki.facepunch.com/gmod/math.ease.InBounce
      */
     InBounce(fraction: number): number;
+
     /**
      * Eases in using a circular function.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InCirc
      */
     InCirc(fraction: number): number;
+
     /**
      * Eases in by cubing the fraction.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InCubic
      */
     InCubic(fraction: number): number;
+
     /**
      * Eases in like a rubber band.
      * 	**NOTE**: This doesn't work properly when used with [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) as it clamps the fraction between 0 and 1. Using your own version of [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) that is unclamped would be necessary instead.
@@ -508,12 +532,14 @@ interface MatheaseLib {
      * @source https://wiki.facepunch.com/gmod/math.ease.InElastic
      */
     InElastic(fraction: number): number;
+
     /**
      * Eases in using an exponential equation with a base of 2 and where the fraction is used in the exponent.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InExpo
      */
     InExpo(fraction: number): number;
+
     /**
      * Eases in and out by reversing the direction of the ease slightly before returning on both ends.
      * 	**NOTE**: This doesn't work properly when used with [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) as it clamps the fraction between 0 and 1. Using your own version of [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) that is unclamped would be necessary instead.
@@ -523,6 +549,7 @@ interface MatheaseLib {
      * @source https://wiki.facepunch.com/gmod/math.ease.InOutBack
      */
     InOutBack(fraction: number): number;
+
     /**
      * Eases in and out like a bouncy ball.
      * 	**NOTE**: This doesn't work properly when used with [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) as it clamps the fraction between 0 and 1. Using your own version of [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) that is unclamped would be necessary instead.
@@ -532,18 +559,21 @@ interface MatheaseLib {
      * @source https://wiki.facepunch.com/gmod/math.ease.InOutBounce
      */
     InOutBounce(fraction: number): number;
+
     /**
      * Eases in and out using a circular function.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InOutCirc
      */
     InOutCirc(fraction: number): number;
+
     /**
      * Eases in and out by cubing the fraction.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InOutCubic
      */
     InOutCubic(fraction: number): number;
+
     /**
      * Eases in and out like a rubber band.
      * 	**NOTE**: This doesn't work properly when used with [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) as it clamps the fraction between 0 and 1. Using your own version of [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) that is unclamped would be necessary instead.
@@ -553,60 +583,70 @@ interface MatheaseLib {
      * @source https://wiki.facepunch.com/gmod/math.ease.InOutElastic
      */
     InOutElastic(fraction: number): number;
+
     /**
      * Eases in and out using an exponential equation with a base of 2 and where the fraction is used in the exponent.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InOutExpo
      */
     InOutExpo(fraction: number): number;
+
     /**
      * Eases in and out by squaring the fraction.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InOutQuad
      */
     InOutQuad(fraction: number): number;
+
     /**
      * Eases in and out by raising the fraction to the power of 4.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InOutQuart
      */
     InOutQuart(fraction: number): number;
+
     /**
      * Eases in and out by raising the fraction to the power of 5.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InOutQuint
      */
     InOutQuint(fraction: number): number;
+
     /**
      * Eases in and out using [math.sin](https://wiki.facepunch.com/gmod/math.sin).
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InOutSine
      */
     InOutSine(fraction: number): number;
+
     /**
      * Eases in by squaring the fraction.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InQuad
      */
     InQuad(fraction: number): number;
+
     /**
      * Eases in by raising the fraction to the power of 4.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InQuart
      */
     InQuart(fraction: number): number;
+
     /**
      * Eases in by raising the fraction to the power of 5.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InQuint
      */
     InQuint(fraction: number): number;
+
     /**
      * Eases in using [math.sin](https://wiki.facepunch.com/gmod/math.sin).
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.InSine
      */
     InSine(fraction: number): number;
+
     /**
      * Eases out by reversing the direction of the ease slightly before finishing.
      * 	**NOTE**: This doesn't work properly when used with [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) as it clamps the fraction between 0 and 1. Using your own version of [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) that is unclamped would be necessary instead.
@@ -616,6 +656,7 @@ interface MatheaseLib {
      * @source https://wiki.facepunch.com/gmod/math.ease.OutBack
      */
     OutBack(fraction: number): number;
+
     /**
      * Eases out like a bouncy ball.
      * 	**NOTE**: This doesn't work properly when used with [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) as it clamps the fraction between 0 and 1. Using your own version of [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) that is unclamped would be necessary instead.
@@ -625,18 +666,21 @@ interface MatheaseLib {
      * @source https://wiki.facepunch.com/gmod/math.ease.OutBounce
      */
     OutBounce(fraction: number): number;
+
     /**
      * Eases out using a circular function.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.OutCirc
      */
     OutCirc(fraction: number): number;
+
     /**
      * Eases out by cubing the fraction.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.OutCubic
      */
     OutCubic(fraction: number): number;
+
     /**
      * Eases out like a rubber band.
      * 	**NOTE**: This doesn't work properly when used with [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) as it clamps the fraction between 0 and 1. Using your own version of [Global.Lerp](https://wiki.facepunch.com/gmod/Global.Lerp) that is unclamped would be necessary instead.
@@ -646,30 +690,35 @@ interface MatheaseLib {
      * @source https://wiki.facepunch.com/gmod/math.ease.OutElastic
      */
     OutElastic(fraction: number): number;
+
     /**
      * Eases out using an exponential equation with a base of 2 and where the fraction is used in the exponent.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.OutExpo
      */
     OutExpo(fraction: number): number;
+
     /**
      * Eases out by squaring the fraction.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.OutQuad
      */
     OutQuad(fraction: number): number;
+
     /**
      * Eases out by raising the fraction to the power of 4.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.OutQuart
      */
     OutQuart(fraction: number): number;
+
     /**
      * Eases out by raising the fraction to the power of 5.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/math.ease.OutQuint
      */
     OutQuint(fraction: number): number;
+
     /**
      * Eases out using [math.sin](https://wiki.facepunch.com/gmod/math.sin).
      * @realm shared and menu
@@ -677,53 +726,3 @@ interface MatheaseLib {
      */
     OutSine(fraction: number): number;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-