@tlua/gmod 1.0.1

package/vector.d.tlua

@@ -0,0 +1,413 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * List of all possible functions to manipulate vectors. Created by Global.Vector.
+ *
+ * Arithmetic operators are typed as metamethod members, which tlua dispatches
+ * ambiently on the declared type. The `number * Vector` form (scalar on the
+ * left) is a reverse overload the LuaLS `@operator` form could not express.
+ */
+interface Vector {
+    x: number;
+    y: number;
+    z: number;
+    // A vector is also indexable as v[1], v[2], v[3].
+    [index: number]: number;
+    __add(l: Vector, r: Vector): Vector;
+    __sub(l: Vector, r: Vector): Vector;
+    __mul(l: Vector, r: Vector | number): Vector;
+    __mul(l: number, r: Vector): Vector;
+    __div(l: Vector, r: Vector | number): Vector;
+    __unm(v: Vector): Vector;
+}
+
+interface Vector {
+    /**
+     * Adds the values of the argument vector to the original vector. This function is the same as vector1 + vector2 without creating a new vector object, skipping object construction and garbage collection.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Add
+     */
+    Add(self: Vector, vector: Vector): void;
+}
+
+interface Vector {
+    /**
+     * Returns an angle representing the normal of the vector.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Angle
+     */
+    Angle(self: Vector): Angle;
+}
+
+interface Vector {
+    /**
+     * Returns the angle of this vector (normalized), but instead of assuming that up is [Global.Vector](https://wiki.facepunch.com/gmod/Global.Vector)( 0, 0, 1 ) (Like [Vector:Angle](https://wiki.facepunch.com/gmod/Vector:Angle) does) you can specify which direction is 'up' for the angle.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:AngleEx
+     */
+    AngleEx(self: Vector, up: Vector): Angle;
+}
+
+interface Vector {
+    /**
+     * Calculates the cross product of this vector and the passed one.
+     *
+     * The cross product of two vectors is a 3-dimensional vector with a direction perpendicular (at right angles) to both of them (according to the [right-hand rule](https://en.wikipedia.org/wiki/Right-hand_rule)), and magnitude equal to the area of parallelogram they span. This is defined as the product of the magnitudes, the sine of the angle between them, and unit (normal) vector `n` defined by the right-hand rule:
+     * :**a** × **b** = |**a**| |**b**| sin(θ) **n̂**
+     * where **a** and **b** are vectors, and **n̂** is a unit vector (magnitude of 1) perpendicular to both.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Cross
+     */
+    Cross(self: Vector, otherVector: Vector): Vector;
+}
+
+interface Vector {
+    /**
+     * Returns the squared distance of 2 vectors, this is quicker to call than [Vector:Distance](https://wiki.facepunch.com/gmod/Vector:Distance) as DistToSqr does not need to calculate the square root, which is an expensive process.
+     *
+     * 	**NOTE**: Squared distances should not be summed. If you need to sum distances, use [Vector:Distance](https://wiki.facepunch.com/gmod/Vector:Distance).
+     *
+     * When performing a distance check, ensure the distance being checked against is squared. See example code below.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:DistToSqr
+     */
+    DistToSqr(self: Vector, otherVec: Vector): number;
+}
+
+interface Vector {
+    /**
+     * Returns the Euclidean distance between the vector and the other vector.
+     *
+     * **NOTE**: This function is more expensive than [Vector:DistToSqr](https://wiki.facepunch.com/gmod/Vector:DistToSqr). However, please see the notes for [Vector:DistToSqr](https://wiki.facepunch.com/gmod/Vector:DistToSqr) before using it as squared distances are not the same as euclidean distances.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Distance
+     */
+    Distance(self: Vector, otherVector: Vector): number;
+}
+
+interface Vector {
+    /**
+     * Returns the Euclidean distance between the vector and the other vector in 2D space. The Z axis is ignored.
+     *
+     * **NOTE**: This function is more expensive than [Vector:Distance2DSqr](https://wiki.facepunch.com/gmod/Vector:Distance2DSqr). However, please see the notes for [Vector:Distance2DSqr](https://wiki.facepunch.com/gmod/Vector:Distance2DSqr) before using it as squared distances are not the same as Euclidean distances.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Distance2D
+     */
+    Distance2D(self: Vector, otherVector: Vector): number;
+}
+
+interface Vector {
+    /**
+     * Returns the squared distance between 2 vectors in 2D space, ignoring the Z axis. This is faster than [Vector:Distance2D](https://wiki.facepunch.com/gmod/Vector:Distance2D) as calculating the square root is an expensive process.
+     *
+     * 	**NOTE**: Squared distances should not be summed. If you need to sum distances, use [Vector:Distance2D](https://wiki.facepunch.com/gmod/Vector:Distance2D).
+     *
+     * When performing a distance check, ensure the distance being checked against is squared.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Distance2DSqr
+     */
+    Distance2DSqr(self: Vector, otherVec: Vector): number;
+}
+
+interface Vector {
+    /**
+     * Divide the vector by the given number, that means x, y and z are divided by that value. This will change the value of the original vector, see example 2 for division without changing the value.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Div
+     */
+    Div(self: Vector, divisor: number): void;
+}
+
+interface Vector {
+    /**
+     * Returns the [dot product](https://en.wikipedia.org/wiki/Dot_product#Geometric_definition)  of this vector and the passed one.
+     *
+     * The dot product of two vectors is the product of their magnitudes (lengths), and the cosine of the angle between them:
+     * **a · b** = |**a**| |**b**| cos(θ)
+     * where **a** and **b** are vectors.
+     * See [Vector:Length](https://wiki.facepunch.com/gmod/Vector:Length) for obtaining magnitudes.
+     *
+     * A dot product returns just the cosine of the angle if both vectors are normalized, and zero if the vectors are at right angles to each other.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Dot
+     */
+    Dot(self: Vector, otherVector: Vector): number;
+}
+
+interface Vector {
+    /**
+     * Returns the dot product of the two vectors.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:DotProduct
+     * @deprecated This is an alias of Vector:Dot. Use that instead.
+     */
+    DotProduct(self: Vector, Vector: Vector): number;
+}
+
+interface Vector {
+    /**
+     * Returns the negative version of this vector, i.e. a vector with every component to the negative value of itself.
+     *
+     * See also [Vector:Negate](https://wiki.facepunch.com/gmod/Vector:Negate).
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:GetNegated
+     */
+    GetNegated(self: Vector): Vector;
+}
+
+interface Vector {
+    /**
+     * Returns a normalized version of the vector. This is a alias of [Vector:GetNormalized](https://wiki.facepunch.com/gmod/Vector:GetNormalized).
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:GetNormal
+     * @deprecated Use Vector:GetNormalized instead.
+     */
+    GetNormal(self: Vector): Vector;
+}
+
+interface Vector {
+    /**
+     * Returns a normalized version of the vector. Normalized means vector with same direction but with length of 1.
+     *
+     * This does not affect the vector you call it on; to do this, use [Vector:Normalize](https://wiki.facepunch.com/gmod/Vector:Normalize).
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:GetNormalized
+     */
+    GetNormalized(self: Vector): Vector;
+}
+
+interface Vector {
+    /**
+     * Returns if the vector is equal to another vector with the given tolerance.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:IsEqualTol
+     */
+    IsEqualTol(self: Vector, compare: Vector, tolerance: number): boolean;
+}
+
+interface Vector {
+    /**
+     * Checks whenever all fields of the vector are 0.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:IsZero
+     */
+    IsZero(self: Vector): boolean;
+}
+
+interface Vector {
+    /**
+     * 		Returns the [Euclidean length](https://en.wikipedia.org/wiki/Euclidean_vector#Length) of the vector: √(x² + y² + z²).
+     *
+     * 		**WARNING**: This is a relatively expensive process since it uses the square root. It is recommended that you use [Vector:LengthSqr](https://wiki.facepunch.com/gmod/Vector:LengthSqr) whenever possible.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Length
+     */
+    Length(self: Vector): number;
+}
+
+interface Vector {
+    /**
+     * 		Returns the length of the vector in two dimensions, without the Z axis.
+     *
+     * 		**WARNING**: This is a relatively expensive process since it uses the square root. It is recommended that you use [Vector:Length2DSqr](https://wiki.facepunch.com/gmod/Vector:Length2DSqr) whenever possible.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Length2D
+     */
+    Length2D(self: Vector): number;
+}
+
+interface Vector {
+    /**
+     * Returns the squared length of the vectors x and y value, x² + y².
+     *
+     * This is faster than [Vector:Length2D](https://wiki.facepunch.com/gmod/Vector:Length2D) as calculating the square root is an expensive process.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Length2DSqr
+     */
+    Length2DSqr(self: Vector): number;
+}
+
+interface Vector {
+    /**
+     * Returns the squared length of the vector, x² + y² + z².
+     *
+     * This is faster than [Vector:Length](https://wiki.facepunch.com/gmod/Vector:Length) as calculating the square root is an expensive process.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:LengthSqr
+     */
+    LengthSqr(self: Vector): number;
+}
+
+interface Vector {
+    /**
+     * Scales the vector by the given [number](https://wiki.facepunch.com/gmod/number) (that means x, y and z are multiplied by that value), a [Vector](https://wiki.facepunch.com/gmod/Vector) (X, Y, and Z of each vector are multiplied) or a [VMatrix](https://wiki.facepunch.com/gmod/VMatrix) (Transforms the vector by the matrix's rotation/translation).
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Mul
+     */
+    Mul(self: Vector, multiplier: number): void;
+}
+
+interface Vector {
+    Mul(self: Vector, multiplier: Vector): void;
+}
+
+interface Vector {
+    Mul(self: Vector, matrix: VMatrix): void;
+}
+
+interface Vector {
+    /**
+     * Negates this vector, i.e. sets every component to the negative value of itself. Same as `Vector( -vec.x, -vec.y, -vec.z )`
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Negate
+     */
+    Negate(self: Vector): void;
+}
+
+interface Vector {
+    /**
+     * Normalizes the given vector. This changes the vector you call it on, if you want to return a normalized copy without affecting the original, use [Vector:GetNormalized](https://wiki.facepunch.com/gmod/Vector:GetNormalized).
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Normalize
+     */
+    Normalize(self: Vector): void;
+}
+
+interface Vector {
+    /**
+     * Randomizes each element of this Vector object.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Random
+     */
+    Random(self: Vector, min?: number, max?: number): void;
+}
+
+interface Vector {
+    /**
+     * Rotates a vector by the given angle.
+     * Doesn't return anything, but rather changes the original vector.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Rotate
+     */
+    Rotate(self: Vector, rotation: Angle): void;
+}
+
+interface Vector {
+    /**
+     * Copies the values from the second vector to the first vector.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Set
+     */
+    Set(self: Vector, vector: Vector): void;
+}
+
+interface Vector {
+    /**
+     * Sets the x, y, and z of the vector.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:SetUnpacked
+     */
+    SetUnpacked(self: Vector, x: number, y: number, z: number): void;
+}
+
+interface Vector {
+    /**
+     * Substracts the values of the second vector from the orignal vector, this function can be used to avoid garbage collection.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Sub
+     */
+    Sub(self: Vector, vector: Vector): void;
+}
+
+interface Vector {
+    /**
+     * Translates the [Vector](https://wiki.facepunch.com/gmod/Vector) (values ranging from 0 to 1) into a [Color](https://wiki.facepunch.com/gmod/Color). This will also range the values from 0 - 1 to 0 - 255.
+     *
+     * x * 255 -> r
+     * y * 255 -> g
+     * z * 255 -> b
+     *
+     * This is the opposite of [Color:ToVector](https://wiki.facepunch.com/gmod/Color:ToVector)
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Vector:ToColor
+     */
+    ToColor(self: Vector): Color;
+}
+
+interface Vector {
+    /**
+     * Returns where on the screen the specified position vector would appear. A related function is [gui.ScreenToVector](https://wiki.facepunch.com/gmod/gui.ScreenToVector), which converts a 2D coordinate to a 3D direction.
+     *
+     * **NOTE**: Should be called from a 3D rendering environment or after [cam.Start3D](https://wiki.facepunch.com/gmod/cam.Start3D) or it may not work correctly.
+     *
+     *
+     * Errors in a render hook can make this value incorrect until the player restarts their game.
+     *
+     * [cam.Start3D](https://wiki.facepunch.com/gmod/cam.Start3D) or 3D context [cam.Start](https://wiki.facepunch.com/gmod/cam.Start) with non-default parameters incorrectly sets the reference FOV for this function, causing incorrect return values. This can be fixed by creating and ending a default 3D context ([cam.Start3D](https://wiki.facepunch.com/gmod/cam.Start3D) with no arguments).
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/Vector:ToScreen
+     */
+    ToScreen(self: Vector): ToScreenData;
+}
+
+interface Vector {
+    /**
+     * Returns the vector as a table with three elements.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:ToTable
+     */
+    ToTable(self: Vector): table;
+}
+
+interface Vector {
+    /**
+     * Returns the x, y, and z of the vector.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Unpack
+     */
+    Unpack(self: Vector): (number, number, number);
+}
+
+interface Vector {
+    /**
+     * Returns whenever the given vector is in a box created by the 2 other vectors.
+     *
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:WithinAABox
+     */
+    WithinAABox(self: Vector, boxStart: Vector, boxEnd: Vector): boolean;
+}
+
+interface Vector {
+    /**
+     * Sets x, y and z to 0.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Vector:Zero
+     */
+    Zero(self: Vector): void;
+}
+