@tlua/gmod 1.0.5 → 1.0.6

package/types/vector.d.tlua

@@ -19,24 +19,28 @@ interface Vector {
     __mul(l: number, r: Vector): Vector;
     __div(l: Vector, r: Vector | number): Vector;
     __unm(v: Vector): 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * Calculates the cross product of this vector and the passed one.
      *
@@ -48,6 +52,7 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:Cross
      */
     Cross(self: Vector, otherVector: Vector): 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.
      *
@@ -60,6 +65,7 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:DistToSqr
      */
     DistToSqr(self: Vector, otherVec: Vector): number;
+
     /**
      * Returns the Euclidean distance between the vector and the other vector.
      *
@@ -70,6 +76,7 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:Distance
      */
     Distance(self: Vector, otherVector: Vector): number;
+
     /**
      * Returns the Euclidean distance between the vector and the other vector in 2D space. The Z axis is ignored.
      *
@@ -80,6 +87,7 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:Distance2D
      */
     Distance2D(self: Vector, otherVector: Vector): number;
+
     /**
      * 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.
      *
@@ -92,12 +100,14 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:Distance2DSqr
      */
     Distance2DSqr(self: Vector, otherVec: Vector): number;
+
     /**
      * 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;
+
     /**
      * Returns the [dot product](https://en.wikipedia.org/wiki/Dot_product#Geometric_definition)  of this vector and the passed one.
      *
@@ -112,6 +122,7 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:Dot
      */
     Dot(self: Vector, otherVector: Vector): number;
+
     /**
      * Returns the dot product of the two vectors.
      * @realm shared and menu
@@ -119,6 +130,7 @@ interface Vector {
      * @deprecated This is an alias of Vector:Dot. Use that instead.
      */
     DotProduct(self: Vector, Vector: Vector): number;
+
     /**
      * Returns the negative version of this vector, i.e. a vector with every component to the negative value of itself.
      *
@@ -128,6 +140,7 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:GetNegated
      */
     GetNegated(self: Vector): Vector;
+
     /**
      * Returns a normalized version of the vector. This is a alias of [Vector:GetNormalized](https://wiki.facepunch.com/gmod/Vector:GetNormalized).
      *
@@ -136,6 +149,7 @@ interface Vector {
      * @deprecated Use Vector:GetNormalized instead.
      */
     GetNormal(self: Vector): Vector;
+
     /**
      * Returns a normalized version of the vector. Normalized means vector with same direction but with length of 1.
      *
@@ -145,18 +159,21 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:GetNormalized
      */
     GetNormalized(self: Vector): 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;
+
     /**
      * 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;
+
     /**
      * 		Returns the [Euclidean length](https://en.wikipedia.org/wiki/Euclidean_vector#Length) of the vector: √(x² + y² + z²).
      *
@@ -167,6 +184,7 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:Length
      */
     Length(self: Vector): number;
+
     /**
      * 		Returns the length of the vector in two dimensions, without the Z axis.
      *
@@ -177,6 +195,7 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:Length2D
      */
     Length2D(self: Vector): number;
+
     /**
      * Returns the squared length of the vectors x and y value, x² + y².
      *
@@ -186,6 +205,7 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:Length2DSqr
      */
     Length2DSqr(self: Vector): number;
+
     /**
      * Returns the squared length of the vector, x² + y² + z².
      *
@@ -195,32 +215,39 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:LengthSqr
      */
     LengthSqr(self: Vector): number;
+
     /**
      * 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;
+
     Mul(self: Vector, multiplier: Vector): void;
+
     Mul(self: Vector, matrix: VMatrix): void;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * Rotates a vector by the given angle.
      * Doesn't return anything, but rather changes the original vector.
@@ -229,24 +256,28 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:Rotate
      */
     Rotate(self: Vector, rotation: Angle): void;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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.
      *
@@ -260,6 +291,7 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:ToColor
      */
     ToColor(self: Vector): Color;
+
     /**
      * 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.
      *
@@ -274,18 +306,21 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:ToScreen
      */
     ToScreen(self: Vector): ToScreenData;
+
     /**
      * 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;
+
     /**
      * 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);
+
     /**
      * Returns whenever the given vector is in a box created by the 2 other vectors.
      *
@@ -295,6 +330,7 @@ interface Vector {
      * @source https://wiki.facepunch.com/gmod/Vector:WithinAABox
      */
     WithinAABox(self: Vector, boxStart: Vector, boxEnd: Vector): boolean;
+
     /**
      * Sets x, y and z to 0.
      * @realm shared and menu
@@ -302,40 +338,3 @@ interface Vector {
      */
     Zero(self: Vector): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/vehicle.d.tlua

@@ -11,30 +11,35 @@ interface Vehicle extends Entity {
      * @source https://wiki.facepunch.com/gmod/Vehicle:BoostTimeLeft
      */
     BoostTimeLeft(self: Vehicle): number;
+
     /**
      * Tries to find an Exit Point for leaving vehicle, if one is unobstructed in the direction given.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:CheckExitPoint
      */
     CheckExitPoint(self: Vehicle, yaw: number, distance: number): Vector;
+
     /**
      * Sets whether the engine is enabled or disabled, i.e. can be started or not.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:EnableEngine
      */
     EnableEngine(self: Vehicle, enable: boolean): void;
+
     /**
      * Returns information about the ammo of the vehicle
      * @realm client
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetAmmo
      */
     GetAmmo(self: Vehicle): (number, number, number);
+
     /**
      * Returns third person camera distance.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetCameraDistance
      */
     GetCameraDistance(self: Vehicle): number;
+
     /**
      * Gets the driver of the vehicle, returns NULL Entity if no driver is present.
      * In Garry's Mod, only Players can drive vehicles.
@@ -42,24 +47,28 @@ interface Vehicle extends Entity {
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetDriver
      */
     GetDriver(self: Vehicle): Player | NULL;
+
     /**
      * Returns the current speed of the vehicle in Half-Life Hammer Units (in/s). Same as [Entity:GetVelocity](https://wiki.facepunch.com/gmod/Entity:GetVelocity) + [Vector:Length](https://wiki.facepunch.com/gmod/Vector:Length).
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetHLSpeed
      */
     GetHLSpeed(self: Vehicle): number;
+
     /**
      * Returns the max speed of the vehicle in MPH.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetMaxSpeed
      */
     GetMaxSpeed(self: Vehicle): number;
+
     /**
      * Returns some info about the vehicle.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetOperatingParams
      */
     GetOperatingParams(self: Vehicle): OperatingParams;
+
     /**
      * Gets the passenger of the vehicle, returns [NULL](https://wiki.facepunch.com/gmod/NULL) if no drivers is present.
      *
@@ -67,60 +76,70 @@ interface Vehicle extends Entity {
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetPassenger
      */
     GetPassenger(self: Vehicle, passenger: number): Entity;
+
     /**
      * Returns the seat position and angle of a given passenger seat.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetPassengerSeatPoint
      */
     GetPassengerSeatPoint(self: Vehicle, role: number): (Vector, Angle);
+
     /**
      * Returns the current RPM of the vehicle. This value is fake and doesn't actually affect the vehicle movement.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetRPM
      */
     GetRPM(self: Vehicle): number;
+
     /**
      * Returns the current speed of the vehicle in MPH.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetSpeed
      */
     GetSpeed(self: Vehicle): number;
+
     /**
      * Returns the current steering of the vehicle.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetSteering
      */
     GetSteering(self: Vehicle): number;
+
     /**
      * Returns the maximum steering degree of the vehicle
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetSteeringDegrees
      */
     GetSteeringDegrees(self: Vehicle): number;
+
     /**
      * Returns if vehicle has thirdperson mode enabled or not.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetThirdPersonMode
      */
     GetThirdPersonMode(self: Vehicle): boolean;
+
     /**
      * Returns the current throttle of the vehicle.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetThrottle
      */
     GetThrottle(self: Vehicle): number;
+
     /**
      * Returns the vehicle class name. This is only useful for Sandbox spawned vehicles or any vehicle that properly sets the vehicle class with [Vehicle:SetVehicleClass](https://wiki.facepunch.com/gmod/Vehicle:SetVehicleClass).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetVehicleClass
      */
     GetVehicleClass(self: Vehicle): string;
+
     /**
      * Returns the vehicle parameters of given vehicle.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetVehicleParams
      */
     GetVehicleParams(self: Vehicle): VehicleParams;
+
     /**
      * Returns the view position and forward angle of a given passenger seat.
      *
@@ -128,66 +147,77 @@ interface Vehicle extends Entity {
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetVehicleViewPosition
      */
     GetVehicleViewPosition(self: Vehicle, role?: number): (Vector, Angle, number);
+
     /**
      * Returns the [PhysObj](https://wiki.facepunch.com/gmod/PhysObj) of given wheel.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetWheel
      */
     GetWheel(self: Vehicle, wheel: number): PhysObj;
+
     /**
      * Returns the base wheel height.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetWheelBaseHeight
      */
     GetWheelBaseHeight(self: Vehicle, wheel: number): number;
+
     /**
      * Returns the wheel contact point.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetWheelContactPoint
      */
     GetWheelContactPoint(self: Vehicle, wheel: number): (Vector, number, boolean);
+
     /**
      * Returns the wheel count of the vehicle
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetWheelCount
      */
     GetWheelCount(self: Vehicle): number;
+
     /**
      * Returns the total wheel height.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:GetWheelTotalHeight
      */
     GetWheelTotalHeight(self: Vehicle, wheel: number): number;
+
     /**
      * Returns whether this vehicle has boost at all.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:HasBoost
      */
     HasBoost(self: Vehicle): boolean;
+
     /**
      * Returns whether this vehicle has a brake pedal. See [Vehicle:SetHasBrakePedal](https://wiki.facepunch.com/gmod/Vehicle:SetHasBrakePedal).
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:HasBrakePedal
      */
     HasBrakePedal(self: Vehicle): boolean;
+
     /**
      * Returns whether this vehicle is currently boosting or not.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:IsBoosting
      */
     IsBoosting(self: Vehicle): boolean;
+
     /**
      * Returns whether the engine is enabled or not, i.e. whether it can be started.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:IsEngineEnabled
      */
     IsEngineEnabled(self: Vehicle): boolean;
+
     /**
      * Returns whether the engine is started or not.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:IsEngineStarted
      */
     IsEngineStarted(self: Vehicle): boolean;
+
     /**
      * Determines whether a given [Vehicle](https://wiki.facepunch.com/gmod/Vehicle) is fully initialized.
      *
@@ -199,12 +229,14 @@ interface Vehicle extends Entity {
      * @source https://wiki.facepunch.com/gmod/Vehicle:IsValidVehicle
      */
     IsValidVehicle(self: Vehicle): boolean;
+
     /**
      * Returns whether this vehicle's engine is underwater or not. ( Internally the attachment point "engine" or "vehicle_engine" is checked )
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:IsVehicleBodyInWater
      */
     IsVehicleBodyInWater(self: Vehicle): boolean;
+
     /**
      * Releases the vehicle's handbrake (Jeep) so it can roll without any passengers.
      *
@@ -214,18 +246,21 @@ interface Vehicle extends Entity {
      * @source https://wiki.facepunch.com/gmod/Vehicle:ReleaseHandbrake
      */
     ReleaseHandbrake(self: Vehicle): void;
+
     /**
      * Sets the boost. It is possible that this function does not work while the vehicle has a valid driver in it.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetBoost
      */
     SetBoost(self: Vehicle, boost: number): void;
+
     /**
      * Sets the third person camera distance of the vehicle.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetCameraDistance
      */
     SetCameraDistance(self: Vehicle, distance: number): void;
+
     /**
      * Turns on or off the Jeep handbrake so it can roll without a driver inside.
      *
@@ -235,30 +270,35 @@ interface Vehicle extends Entity {
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetHandbrake
      */
     SetHandbrake(self: Vehicle, handbrake: boolean): void;
+
     /**
      * Sets whether this vehicle has a brake pedal.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetHasBrakePedal
      */
     SetHasBrakePedal(self: Vehicle, brakePedal: boolean): void;
+
     /**
      * Sets maximum reverse throttle
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetMaxReverseThrottle
      */
     SetMaxReverseThrottle(self: Vehicle, maxRevThrottle: number): void;
+
     /**
      * Sets maximum forward throttle
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetMaxThrottle
      */
     SetMaxThrottle(self: Vehicle, maxThrottle: number): void;
+
     /**
      * Sets spring length of given wheel
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetSpringLength
      */
     SetSpringLength(self: Vehicle, wheel: number, length: number): void;
+
     /**
      * Sets the steering of the vehicle.
      * The correct range, 0 to 1 or -1 to 1
@@ -267,24 +307,28 @@ interface Vehicle extends Entity {
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetSteering
      */
     SetSteering(self: Vehicle, front: number, rear: number): void;
+
     /**
      * Sets the maximum steering degrees of the vehicle
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetSteeringDegrees
      */
     SetSteeringDegrees(self: Vehicle, steeringDegrees: number): void;
+
     /**
      * Sets the third person mode state.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetThirdPersonMode
      */
     SetThirdPersonMode(self: Vehicle, enable: boolean): void;
+
     /**
      * Sets the throttle of the vehicle. It is possible that this function does not work with a valid driver in it.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetThrottle
      */
     SetThrottle(self: Vehicle, throttle: number): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      * Sets the vehicle class name.
@@ -292,12 +336,14 @@ interface Vehicle extends Entity {
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetVehicleClass
      */
     SetVehicleClass(self: Vehicle, _class: string): void;
+
     /**
      * Sets whether the entry or exit camera animation should be played or not.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetVehicleEntryAnim
      */
     SetVehicleEntryAnim(self: Vehicle, bOn: boolean): void;
+
     /**
      * Sets the vehicle parameters for given vehicle.
      *
@@ -308,12 +354,14 @@ interface Vehicle extends Entity {
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetVehicleParams
      */
     SetVehicleParams(self: Vehicle, params: VehicleParams): void;
+
     /**
      * Sets friction of given wheel.  This function may be broken.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Vehicle:SetWheelFriction
      */
     SetWheelFriction(self: Vehicle, wheel: number, friction: number): void;
+
     /**
      * Starts or stops the engine.
      * @realm server
@@ -322,54 +370,3 @@ interface Vehicle extends Entity {
     StartEngine(self: Vehicle, start: boolean): void;
 }
 interface VEHICLE extends Vehicle {}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-