@tlua/gmod 1.0.5 → 1.0.6

package/types/physobj.d.tlua

@@ -16,24 +16,28 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:AddAngleVelocity
      */
     AddAngleVelocity(self: PhysObj, angularVelocity: Vector): void;
+
     /**
      * Adds one or more bit flags.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:AddGameFlag
      */
     AddGameFlag(self: PhysObj, flags: number): void;
+
     /**
      * Adds the specified velocity to the current.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:AddVelocity
      */
     AddVelocity(self: PhysObj, velocity: Vector): void;
+
     /**
      * Rotates the object so that it's angles are aligned to the ones inputted.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:AlignAngles
      */
     AlignAngles(self: PhysObj, from: Angle, to: Angle): Angle;
+
     /**
      * Applies the specified impulse in the mass center of the physics object.
      *
@@ -44,18 +48,21 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:ApplyForceCenter
      */
     ApplyForceCenter(self: PhysObj, impulse: Vector): void;
+
     /**
      * Applies the specified impulse on the physics object at the specified position.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:ApplyForceOffset
      */
     ApplyForceOffset(self: PhysObj, impulse: Vector, position: Vector): void;
+
     /**
      * Applies the specified angular impulse to the physics object. See [PhysObj:CalculateForceOffset](https://wiki.facepunch.com/gmod/PhysObj:CalculateForceOffset)
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:ApplyTorqueCenter
      */
     ApplyTorqueCenter(self: PhysObj, angularImpulse: Vector): void;
+
     /**
      * Calculates the linear and angular impulse on the object's center of mass for an offset impulse.The outputs can be used with [PhysObj:ApplyForceCenter](https://wiki.facepunch.com/gmod/PhysObj:ApplyForceCenter) and [PhysObj:ApplyTorqueCenter](https://wiki.facepunch.com/gmod/PhysObj:ApplyTorqueCenter), respectively.
      *
@@ -64,6 +71,7 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:CalculateForceOffset
      */
     CalculateForceOffset(self: PhysObj, impulse: Vector, position: Vector): (Vector, Vector);
+
     /**
      * Calculates the linear and angular velocities on the center of mass for an offset impulse. The outputs can be directly passed to [PhysObj:AddVelocity](https://wiki.facepunch.com/gmod/PhysObj:AddVelocity) and [PhysObj:AddAngleVelocity](https://wiki.facepunch.com/gmod/PhysObj:AddAngleVelocity), respectively.
      *
@@ -73,18 +81,21 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:CalculateVelocityOffset
      */
     CalculateVelocityOffset(self: PhysObj, impulse: Vector, position: Vector): (Vector, Vector);
+
     /**
      * Removes one of more specified flags.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:ClearGameFlag
      */
     ClearGameFlag(self: PhysObj, flags: number): void;
+
     /**
      * Allows you to move a PhysObj to a point and angle in 3D space. Works with any PhysObj, not just physics shadows.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:ComputeShadowControl
      */
     ComputeShadowControl(self: PhysObj, shadowparams: ShadowControlParams): void;
+
     /**
      * Sets whether the physics object should collide with anything or not, including world.
      *
@@ -99,18 +110,21 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:EnableCollisions
      */
     EnableCollisions(self: PhysObj, enable: boolean): void;
+
     /**
      * Sets whenever the physics object should be affected by drag.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:EnableDrag
      */
     EnableDrag(self: PhysObj, enable: boolean): void;
+
     /**
      * Sets whether the PhysObject should be affected by gravity
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:EnableGravity
      */
     EnableGravity(self: PhysObj, enable: boolean): void;
+
     /**
      * Sets whether the physobject should be able to move or not.
      *
@@ -120,24 +134,28 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:EnableMotion
      */
     EnableMotion(self: PhysObj, enable: boolean): void;
+
     /**
      * Returns the mins and max of the physics object Axis-Aligned Bounding Box.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetAABB
      */
     GetAABB(self: PhysObj): (Vector | nil, Vector);
+
     /**
      * Gets the angular velocity of the object in degrees per second as a local vector. You can use dot product to read the magnitude from a specific axis.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetAngleVelocity
      */
     GetAngleVelocity(self: PhysObj): Vector;
+
     /**
      * Returns the angles of the physics object in degrees.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetAngles
      */
     GetAngles(self: PhysObj): Angle;
+
     /**
      * Returns the buoyancy ratio of the physics object. (How well it floats in water).
      *
@@ -148,36 +166,42 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetBuoyancyRatio
      */
     GetBuoyancyRatio(self: PhysObj): number;
+
     /**
      * Returns the contents flag of the [PhysObj](https://wiki.facepunch.com/gmod/PhysObj).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetContents
      */
     GetContents(self: PhysObj): number;
+
     /**
      * Returns the linear and angular damping of the physics object.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetDamping
      */
     GetDamping(self: PhysObj): (number, number);
+
     /**
      * Returns the sum of the linear and rotational kinetic energies of the physics object.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetEnergy
      */
     GetEnergy(self: PhysObj): number;
+
     /**
      * Returns the parent entity of the physics object.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetEntity
      */
     GetEntity(self: PhysObj): Entity;
+
     /**
      * Returns the friction snapshot of this physics object. This is useful for determining if an object touching ground for example.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetFrictionSnapshot
      */
     GetFrictionSnapshot(self: PhysObj): table;
+
     /**
      * Returns the index this physics object is on its [PhysObj:GetEntity](https://wiki.facepunch.com/gmod/PhysObj:GetEntity).
      *
@@ -187,36 +211,42 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetIndex
      */
     GetIndex(self: PhysObj): number;
+
     /**
      * Returns the principal moments of inertia `(Ixx, Iyy, Izz)` of the physics object, in the local frame, with respect to the center of mass.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetInertia
      */
     GetInertia(self: PhysObj): Vector;
+
     /**
      * Returns 1 divided by the angular inertia. See [PhysObj:GetInertia](https://wiki.facepunch.com/gmod/PhysObj:GetInertia)
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetInvInertia
      */
     GetInvInertia(self: PhysObj): Vector;
+
     /**
      * Returns 1 divided by the physics object's mass (in kilograms).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetInvMass
      */
     GetInvMass(self: PhysObj): number;
+
     /**
      * Returns the mass of the physics object.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetMass
      */
     GetMass(self: PhysObj): number;
+
     /**
      * Returns the center of mass of the physics object as a local vector.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetMassCenter
      */
     GetMassCenter(self: PhysObj): Vector;
+
     /**
      * Returns the [physical material](https://developer.valvesoftware.com/wiki/Material_surface_properties) ($surfaceprop) of the physics object.
      *
@@ -225,96 +255,112 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetMaterial
      */
     GetMaterial(self: PhysObj): string;
+
     /**
      * Returns the physics mesh of the object which is used for physobj-on-physobj collision.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetMesh
      */
     GetMesh(self: PhysObj): table;
+
     /**
      * Returns all convex physics meshes of the object. See [Entity:PhysicsInitMultiConvex](https://wiki.facepunch.com/gmod/Entity:PhysicsInitMultiConvex) for more information.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetMeshConvexes
      */
     GetMeshConvexes(self: PhysObj): table;
+
     /**
      * Returns the name of the physics object.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetName
      */
     GetName(self: PhysObj): string;
+
     /**
      * Returns the position of the physics object.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetPos
      */
     GetPos(self: PhysObj): Vector;
+
     /**
      * Returns the position and angle of the physics object as a 3x4 matrix ([VMatrix](https://wiki.facepunch.com/gmod/VMatrix) is 4x4 so the fourth row goes unused). The first three columns store the angle as a [rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix), and the fourth column stores the position vector.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetPositionMatrix
      */
     GetPositionMatrix(self: PhysObj): VMatrix;
+
     /**
      * Returns the rotation damping of the physics object.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetRotDamping
      */
     GetRotDamping(self: PhysObj): number;
+
     /**
      * Returns the angles of the [PhysObj](https://wiki.facepunch.com/gmod/PhysObj) shadow. See [PhysObj:UpdateShadow](https://wiki.facepunch.com/gmod/PhysObj:UpdateShadow).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetShadowAngles
      */
     GetShadowAngles(self: PhysObj): Angle;
+
     /**
      * Returns the position of the [PhysObj](https://wiki.facepunch.com/gmod/PhysObj) shadow. See [PhysObj:UpdateShadow](https://wiki.facepunch.com/gmod/PhysObj:UpdateShadow).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetShadowPos
      */
     GetShadowPos(self: PhysObj): Vector;
+
     /**
      * Returns the speed damping of the physics object.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetSpeedDamping
      */
     GetSpeedDamping(self: PhysObj): number;
+
     /**
      * Returns the internal and external stress of the entity.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetStress
      */
     GetStress(self: PhysObj): (number, number);
+
     /**
      * Returns the surface area of the physics object in source-units². Or nil if the PhysObj is a generated sphere or box.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetSurfaceArea
      */
     GetSurfaceArea(self: PhysObj): number | nil;
+
     /**
      * Returns the absolute directional velocity of the physobject.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetVelocity
      */
     GetVelocity(self: PhysObj): Vector;
+
     /**
      * Returns the world velocity of a point in world coordinates about the object. This is useful for objects rotating around their own axis/origin.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetVelocityAtPoint
      */
     GetVelocityAtPoint(self: PhysObj, point: Vector): Vector;
+
     /**
      * Returns the volume in source units³. Or nil if the PhysObj is a generated sphere or box.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:GetVolume
      */
     GetVolume(self: PhysObj): number | nil;
+
     /**
      * Returns whenever the specified flag(s) is/are set.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:HasGameFlag
      */
     HasGameFlag(self: PhysObj, flags: number): boolean;
+
     /**
      * Returns whether the physics object is "sleeping".
      *
@@ -324,36 +370,42 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:IsAsleep
      */
     IsAsleep(self: PhysObj): boolean;
+
     /**
      * Returns whenever the entity is able to collide or not.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:IsCollisionEnabled
      */
     IsCollisionEnabled(self: PhysObj): boolean;
+
     /**
      * Returns whenever the entity is affected by drag.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:IsDragEnabled
      */
     IsDragEnabled(self: PhysObj): boolean;
+
     /**
      * Returns whenever the entity is affected by gravity.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:IsGravityEnabled
      */
     IsGravityEnabled(self: PhysObj): boolean;
+
     /**
      * Returns if the physics object can move itself (by velocity, acceleration)
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:IsMotionEnabled
      */
     IsMotionEnabled(self: PhysObj): boolean;
+
     /**
      * Returns whenever the entity is able to move.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:IsMoveable
      */
     IsMoveable(self: PhysObj): boolean;
+
     /**
      * Returns whenever the physics object is penetrating another physics object.
      *
@@ -363,12 +415,14 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:IsPenetrating
      */
     IsPenetrating(self: PhysObj): boolean;
+
     /**
      * Returns if the physics object is valid/not NULL.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:IsValid
      */
     IsValid(self: PhysObj): boolean;
+
     /**
      * Translates a vector in the physics object's local space into worldspace coordinates.
      *
@@ -389,6 +443,7 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:LocalToWorld
      */
     LocalToWorld(self: PhysObj, vecLocal: Vector): Vector;
+
     /**
      * Rotationally transforms a vector in the physics object's local space by the [PhysObj:GetPositionMatrix](https://wiki.facepunch.com/gmod/PhysObj:GetPositionMatrix).
      *
@@ -399,72 +454,84 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:LocalToWorldVector
      */
     LocalToWorldVector(self: PhysObj, vecLocal: Vector): Vector;
+
     /**
      * Prints debug info about the state of the physics object to the console.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:OutputDebugInfo
      */
     OutputDebugInfo(self: PhysObj): void;
+
     /**
      * Call this when the collision filter conditions change due to this object's state (e.g. changing solid type or collision group)
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:RecheckCollisionFilter
      */
     RecheckCollisionFilter(self: PhysObj): void;
+
     /**
      * A convinience function for [Angle:RotateAroundAxis](https://wiki.facepunch.com/gmod/Angle:RotateAroundAxis).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:RotateAroundAxis
      */
     RotateAroundAxis(self: PhysObj, dir: Vector, ang: number): Angle;
+
     /**
      * Sets the amount of [drag](https://en.wikipedia.org/wiki/Drag_(physics)) to apply to a physics object when attempting to rotate.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetAngleDragCoefficient
      */
     SetAngleDragCoefficient(self: PhysObj, coefficient: number): void;
+
     /**
      * Sets the specified [angular velocity](https://en.wikipedia.org/wiki/Angular_velocity) on the [PhysObj](https://wiki.facepunch.com/gmod/PhysObj)
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetAngleVelocity
      */
     SetAngleVelocity(self: PhysObj, angularVelocity: Vector): void;
+
     /**
      * Sets the specified instantaneous [angular velocity](https://en.wikipedia.org/wiki/Angular_velocity) on the [PhysObj](https://wiki.facepunch.com/gmod/PhysObj)
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetAngleVelocityInstantaneous
      */
     SetAngleVelocityInstantaneous(self: PhysObj, angularVelocity: Vector): void;
+
     /**
      * Sets the angles of the physobject in degrees.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetAngles
      */
     SetAngles(self: PhysObj, angles: Angle): void;
+
     /**
      * Sets the buoyancy ratio of the physics object. (How well it floats in water)
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetBuoyancyRatio
      */
     SetBuoyancyRatio(self: PhysObj, buoyancy: number): void;
+
     /**
      * Sets the contents flag of the [PhysObj](https://wiki.facepunch.com/gmod/PhysObj).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetContents
      */
     SetContents(self: PhysObj, contents: CONTENTS): void;
+
     /**
      * Sets the linear and angular damping of the physics object.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetDamping
      */
     SetDamping(self: PhysObj, linearDamping: number, angularDamping: number): void;
+
     /**
      * Modifies how much drag (air resistance) affects the object.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetDragCoefficient
      */
     SetDragCoefficient(self: PhysObj, drag: number): void;
+
     /**
      * Sets the angular inertia. See [PhysObj:GetInertia](https://wiki.facepunch.com/gmod/PhysObj:GetInertia).
      *
@@ -475,6 +542,7 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetInertia
      */
     SetInertia(self: PhysObj, angularInertia: Vector): void;
+
     /**
      * Sets the mass of the physics object.
      *
@@ -487,6 +555,7 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetMass
      */
     SetMass(self: PhysObj, mass: number): void;
+
     /**
      * Sets the material of the physobject.
      *
@@ -497,24 +566,28 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetMaterial
      */
     SetMaterial(self: PhysObj, materialName: string): void;
+
     /**
      * Sets the position of the physobject.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetPos
      */
     SetPos(self: PhysObj, position: Vector, teleport?: boolean): void;
+
     /**
      * Sets the velocity of the physics object for the next iteration.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetVelocity
      */
     SetVelocity(self: PhysObj, velocity: Vector): void;
+
     /**
      * Sets the velocity of the physics object.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:SetVelocityInstantaneous
      */
     SetVelocityInstantaneous(self: PhysObj, velocity: Vector): void;
+
     /**
      * Makes the physics object "sleep". The physics object will no longer be moving unless it is "woken up" by either a collision with another moving object, or by [PhysObj:Wake](https://wiki.facepunch.com/gmod/PhysObj:Wake).
      *
@@ -524,6 +597,7 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:Sleep
      */
     Sleep(self: PhysObj): void;
+
     /**
      * Unlike [PhysObj:SetPos](https://wiki.facepunch.com/gmod/PhysObj:SetPos) and [PhysObj:SetAngles](https://wiki.facepunch.com/gmod/PhysObj:SetAngles), this allows the movement of a physobj while leaving physics interactions intact.
      * This is used internally by the motion controller of the Gravity Gun , the +use pickup and the Physics Gun, and entities such as the crane.
@@ -535,6 +609,7 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:UpdateShadow
      */
     UpdateShadow(self: PhysObj, targetPosition: Vector, targetAngles: Angle, frameTime: number): void;
+
     /**
      * Wakes the physics object, so that it will continue to simulate physics/gravity.
      *
@@ -544,12 +619,14 @@ interface PhysObj {
      * @source https://wiki.facepunch.com/gmod/PhysObj:Wake
      */
     Wake(self: PhysObj): void;
+
     /**
      * Translates a worldspace vector into the physics object's local space.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/PhysObj:WorldToLocal
      */
     WorldToLocal(self: PhysObj, vec: Vector): Vector;
+
     /**
      * Rotationally transforms a worldspace vector into the physics object's local space by the inverted [PhysObj:GetPositionMatrix](https://wiki.facepunch.com/gmod/PhysObj:GetPositionMatrix).
      *
@@ -563,82 +640,3 @@ interface PhysObj {
      */
     WorldToLocalVector(self: PhysObj, vec: Vector): Vector;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/pixelvis_handle_t.d.tlua

@@ -6,4 +6,3 @@
  * @source https://wiki.facepunch.com/gmod/pixelvis_handle_t
  */
 interface pixelvis_handle_t {}
-