@tlua/gmod 1.0.5 → 1.0.6

package/types/cam.d.tlua

@@ -15,6 +15,7 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.ApplyShake
      */
     ApplyShake(pos: Vector, angles: Angle, factor: number): void;
+
     /**
      * Switches the renderer back to the previous drawing mode from a 3D context.
      *
@@ -24,6 +25,7 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.End
      */
     End(): void;
+
     /**
      * Switches the renderer back to the previous drawing mode from a 2D context.
      *
@@ -31,6 +33,7 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.End2D
      */
     End2D(): void;
+
     /**
      * Switches the renderer back to the previous drawing mode from a 3D context.
      *
@@ -38,6 +41,7 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.End3D
      */
     End3D(): void;
+
     /**
      * Switches the renderer back to the previous drawing mode from a 3D2D context.
      *
@@ -45,12 +49,14 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.End3D2D
      */
     End3D2D(): void;
+
     /**
      * Switches the renderer back to the previous drawing mode from a 3D orthographic rendering context.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/cam.EndOrthoView
      */
     EndOrthoView(): void;
+
     /**
      * Returns a copy of the model matrix that is at the top of the stack.
      * 	**NOTE**: Editing the matrix **will not** edit the current view. To do so, you will have to use [cam.PushModelMatrix](https://wiki.facepunch.com/gmod/cam.PushModelMatrix).
@@ -60,6 +66,7 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.GetModelMatrix
      */
     GetModelMatrix(): VMatrix;
+
     /**
      * Returns a copy of the projection matrix. Also see [cam.GetViewMatrix](https://wiki.facepunch.com/gmod/cam.GetViewMatrix).
      *
@@ -69,6 +76,7 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.GetProjectionMatrix
      */
     GetProjectionMatrix(): VMatrix;
+
     /**
      * Returns a copy of the view matrix. Also see [cam.GetProjectionMatrix](https://wiki.facepunch.com/gmod/cam.GetProjectionMatrix).
      *
@@ -78,6 +86,7 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.GetViewMatrix
      */
     GetViewMatrix(): VMatrix;
+
     /**
      * Tells the renderer to ignore the depth buffer and draw any upcoming operation "ontop" of everything that was drawn yet.
      *
@@ -87,12 +96,14 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.IgnoreZ
      */
     IgnoreZ(ignoreZ: boolean): void;
+
     /**
      * Removes the currently active model matrix (pushed previously with [cam.PushModelMatrix](https://wiki.facepunch.com/gmod/cam.PushModelMatrix)) from the stack and reinstates the previous one.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/cam.PopModelMatrix
      */
     PopModelMatrix(): void;
+
     /**
      * Pushes the specified matrix onto the render matrix stack. Each pushed matrix must be popped via [cam.PopModelMatrix](https://wiki.facepunch.com/gmod/cam.PopModelMatrix).
      *
@@ -104,6 +115,7 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.PushModelMatrix
      */
     PushModelMatrix(matrix: VMatrix, multiply?: boolean): void;
+
     /**
      * Sets up a new rendering context. This is an extended version of [cam.Start3D](https://wiki.facepunch.com/gmod/cam.Start3D) and [cam.Start2D](https://wiki.facepunch.com/gmod/cam.Start2D). Must be finished by [cam.End3D](https://wiki.facepunch.com/gmod/cam.End3D) or [cam.End2D](https://wiki.facepunch.com/gmod/cam.End2D).
      *
@@ -113,6 +125,7 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.Start
      */
     Start(dataTbl: RenderCamData): void;
+
     /**
      * Sets up a new 2D rendering context. Must be finished by [cam.End2D](https://wiki.facepunch.com/gmod/cam.End2D).
      *
@@ -126,6 +139,7 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.Start2D
      */
     Start2D(): void;
+
     /**
      * Sets up a new 3D rendering context. Must be finished by [cam.End3D](https://wiki.facepunch.com/gmod/cam.End3D).
      *
@@ -143,6 +157,7 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.Start3D
      */
     Start3D(pos?: Vector, angles?: Angle, fov?: number, x?: number, y?: number, w?: number, h?: number, zNear?: number, zFar?: number): void;
+
     /**
      * Sets up the model transformation matrix to draw 2D content in 3D space and pushes it into the stack ([cam.PushModelMatrix](https://wiki.facepunch.com/gmod/cam.PushModelMatrix)).
      *
@@ -162,6 +177,7 @@ interface CamLib {
      * @source https://wiki.facepunch.com/gmod/cam.Start3D2D
      */
     Start3D2D(pos: Vector, angles: Angle, scale: number): void;
+
     /**
      * Sets up a new 3d context using orthographic projection.
      * @realm client
@@ -169,20 +185,3 @@ interface CamLib {
      */
     StartOrthoView(leftOffset: number, topOffset: number, rightOffset: number, bottomOffset: number): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/ceffectdata.d.tlua

@@ -11,90 +11,105 @@ interface CEffectData {
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetAngles
      */
     GetAngles(self: CEffectData): Angle;
+
     /**
      * Returns the attachment ID for the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetAttachment
      */
     GetAttachment(self: CEffectData): number;
+
     /**
      * Returns byte which represents the color of the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetColor
      */
     GetColor(self: CEffectData): number;
+
     /**
      * Returns the damage type of the effect
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetDamageType
      */
     GetDamageType(self: CEffectData): number;
+
     /**
      * Returns the entity index of the entity set for the effect.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetEntIndex
      */
     GetEntIndex(self: CEffectData): number;
+
     /**
      * Returns the entity assigned to the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetEntity
      */
     GetEntity(self: CEffectData): Entity;
+
     /**
      * Returns the flags of the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetFlags
      */
     GetFlags(self: CEffectData): number;
+
     /**
      * Returns the hit box ID of the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetHitBox
      */
     GetHitBox(self: CEffectData): number;
+
     /**
      * Returns the magnitude of the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetMagnitude
      */
     GetMagnitude(self: CEffectData): number;
+
     /**
      * Returns the material ID of the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetMaterialIndex
      */
     GetMaterialIndex(self: CEffectData): number;
+
     /**
      * Returns the normalized direction vector of the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetNormal
      */
     GetNormal(self: CEffectData): Vector;
+
     /**
      * Returns the origin position of the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetOrigin
      */
     GetOrigin(self: CEffectData): Vector;
+
     /**
      * Returns the radius of the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetRadius
      */
     GetRadius(self: CEffectData): number;
+
     /**
      * Returns the scale of the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetScale
      */
     GetScale(self: CEffectData): number;
+
     /**
      * Returns the start position of the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetStart
      */
     GetStart(self: CEffectData): Vector;
+
     /**
      * Returns the surface property index of the effect. See [util.GetSurfaceData](https://wiki.facepunch.com/gmod/util.GetSurfaceData) for more details about what they are.
      *
@@ -104,12 +119,14 @@ interface CEffectData {
      * @source https://wiki.facepunch.com/gmod/CEffectData:GetSurfaceProp
      */
     GetSurfaceProp(self: CEffectData): number;
+
     /**
      * Sets the angles of the effect.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetAngles
      */
     SetAngles(self: CEffectData, ang: Angle): void;
+
     /**
      * Sets the attachment id of the effect to be created with this effect data.
      *
@@ -120,6 +137,7 @@ interface CEffectData {
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetAttachment
      */
     SetAttachment(self: CEffectData, attachment: number): void;
+
     /**
      * Sets the "color" of the effect.
      *
@@ -132,24 +150,28 @@ interface CEffectData {
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetColor
      */
     SetColor(self: CEffectData, color: number): void;
+
     /**
      * Sets the damage type of the effect to be created with this effect data.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetDamageType
      */
     SetDamageType(self: CEffectData, damageType: number): void;
+
     /**
      * Sets the entity of the effect via its index.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetEntIndex
      */
     SetEntIndex(self: CEffectData, entIndex: number): void;
+
     /**
      * Sets the entity of the effect to be created with this effect data.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetEntity
      */
     SetEntity(self: CEffectData, entity: Entity): void;
+
     /**
      * Sets the flags for the effect. What flags do depends entirely on the effect. See [Default Effects](https://wiki.facepunch.com/gmod/Default_Effects).
      *
@@ -160,6 +182,7 @@ interface CEffectData {
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetFlags
      */
     SetFlags(self: CEffectData, flags: number): void;
+
     /**
      * Sets the hit box index of the effect. Used by various effects for various purposes.
      *
@@ -170,6 +193,7 @@ interface CEffectData {
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetHitBox
      */
     SetHitBox(self: CEffectData, hitBoxIndex: number): void;
+
     /**
      * Sets the magnitude of the effect.
      * **NOTE**: Internally stored as a float with 12 bit precision for networking purposes, limited to range of 0-1023.
@@ -178,6 +202,7 @@ interface CEffectData {
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetMagnitude
      */
     SetMagnitude(self: CEffectData, magnitude: number): void;
+
     /**
      * Sets the material index of the effect.
      *
@@ -188,12 +213,14 @@ interface CEffectData {
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetMaterialIndex
      */
     SetMaterialIndex(self: CEffectData, materialIndex: number): void;
+
     /**
      * Sets the normalized (length=1) direction vector of the effect to be created with this effect data. This **must** be a normalized vector for networking purposes.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetNormal
      */
     SetNormal(self: CEffectData, normal: Vector): void;
+
     /**
      * Sets the origin of the effect to be created with this effect data.
      * **NOTE**: Limited to world bounds (+-16386 on every axis) and has horrible networking precision. (17 bit float per component)
@@ -203,6 +230,7 @@ interface CEffectData {
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetOrigin
      */
     SetOrigin(self: CEffectData, origin: Vector): void;
+
     /**
      * Sets the radius of the effect to be created with this effect data.
      *
@@ -213,12 +241,14 @@ interface CEffectData {
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetRadius
      */
     SetRadius(self: CEffectData, radius: number): void;
+
     /**
      * Sets the scale of the effect to be created with this effect data.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetScale
      */
     SetScale(self: CEffectData, scale: number): void;
+
     /**
      * Sets the start of the effect to be created with this effect data.
      * **NOTE**: Limited to world bounds (+-16386 on every axis) and has horrible networking precision. (17 bit float per component)
@@ -228,6 +258,7 @@ interface CEffectData {
      * @source https://wiki.facepunch.com/gmod/CEffectData:SetStart
      */
     SetStart(self: CEffectData, start: Vector): void;
+
     /**
      * Sets the surface property index of the effect. See [util.GetSurfaceData](https://wiki.facepunch.com/gmod/util.GetSurfaceData) for more details about what they are.
      *
@@ -239,36 +270,3 @@ interface CEffectData {
      */
     SetSurfaceProp(self: CEffectData, surfaceProperties: number): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/chat.d.tlua

@@ -13,30 +13,35 @@ interface ChatLib {
      * @source https://wiki.facepunch.com/gmod/chat.AddText
      */
     AddText(...: any): void;
+
     /**
      * Closes the chat window.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/chat.Close
      */
     Close(): void;
+
     /**
      * Returns the chatbox position.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/chat.GetChatBoxPos
      */
     GetChatBoxPos(): (number, number);
+
     /**
      * Returns the chatbox size.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/chat.GetChatBoxSize
      */
     GetChatBoxSize(): (number, number);
+
     /**
      * Opens the chat window.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/chat.Open
      */
     Open(mode: number): void;
+
     /**
      * Plays the chat "tick" sound.
      * @realm client
@@ -44,9 +49,3 @@ interface ChatLib {
      */
     PlaySound(): void;
 }
-
-
-
-
-
-

package/types/checkbutton.d.tlua

@@ -11,4 +11,3 @@
  * @deprecated Use DCheckBoxLabel instead.
  */
 interface CheckButton {}
-

package/types/cleanup.d.tlua

@@ -13,6 +13,7 @@ interface CleanupLib {
      * @source https://wiki.facepunch.com/gmod/cleanup.Add
      */
     Add(pl: Player, type: string, ent: Entity): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *  Called by the `gmod_admin_cleanup` console command. Allows admins to clean up the server.
@@ -20,6 +21,7 @@ interface CleanupLib {
      * @source https://wiki.facepunch.com/gmod/cleanup.CC_AdminCleanup
      */
     CC_AdminCleanup(pl: Player, command: string, args: table): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *  Called by the `gmod_cleanup` console command. Allows players to cleanup their own props.
@@ -27,24 +29,28 @@ interface CleanupLib {
      * @source https://wiki.facepunch.com/gmod/cleanup.CC_Cleanup
      */
     CC_Cleanup(pl: Player, command: string, args: table): void;
+
     /**
      * Gets the cleanup list.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/cleanup.GetList
      */
     GetList(): void;
+
     /**
      * Gets the table of cleanup types.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/cleanup.GetTable
      */
     GetTable(): table;
+
     /**
      * Registers a new cleanup type.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/cleanup.Register
      */
     Register(type: string): void;
+
     /**
      * Replaces one entity in the cleanup module with another.
      *
@@ -54,6 +60,7 @@ interface CleanupLib {
      * @source https://wiki.facepunch.com/gmod/cleanup.ReplaceEntity
      */
     ReplaceEntity(from: Entity, to: Entity | nil): boolean;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -64,11 +71,3 @@ interface CleanupLib {
      */
     UpdateUI(): void;
 }
-
-
-
-
-
-
-
-

package/types/cluaemitter.d.tlua

@@ -11,42 +11,49 @@ interface CLuaEmitter {
      * @source https://wiki.facepunch.com/gmod/CLuaEmitter:Add
      */
     Add(self: CLuaEmitter, material: string, position: Vector): CLuaParticle;
+
     /**
      * Manually renders all particles the emitter has created.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/CLuaEmitter:Draw
      */
     Draw(self: CLuaEmitter): void;
+
     /**
      * Removes the emitter, making it no longer usable from Lua. If particles remain, the emitter will be removed when all particles die.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/CLuaEmitter:Finish
      */
     Finish(self: CLuaEmitter): void;
+
     /**
      * Returns the amount of active particles of this emitter.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/CLuaEmitter:GetNumActiveParticles
      */
     GetNumActiveParticles(self: CLuaEmitter): number;
+
     /**
      * Returns the position of this emitter. This is set when creating the emitter with [Global.ParticleEmitter](https://wiki.facepunch.com/gmod/Global.ParticleEmitter).
      * @realm client
      * @source https://wiki.facepunch.com/gmod/CLuaEmitter:GetPos
      */
     GetPos(self: CLuaEmitter): Vector;
+
     /**
      * Returns whether this emitter is 3D or not. This is set when creating the emitter with [Global.ParticleEmitter](https://wiki.facepunch.com/gmod/Global.ParticleEmitter).
      * @realm client
      * @source https://wiki.facepunch.com/gmod/CLuaEmitter:Is3D
      */
     Is3D(self: CLuaEmitter): boolean;
+
     /**
      * Returns whether this [CLuaEmitter](https://wiki.facepunch.com/gmod/CLuaEmitter) is valid or not.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/CLuaEmitter:IsValid
      */
     IsValid(self: CLuaEmitter): boolean;
+
     /**
      * Sets the bounding box for this emitter.
      *
@@ -56,24 +63,28 @@ interface CLuaEmitter {
      * @source https://wiki.facepunch.com/gmod/CLuaEmitter:SetBBox
      */
     SetBBox(self: CLuaEmitter, mins: Vector, maxs: Vector): void;
+
     /**
      * This function sets the the distance between the render camera and the emitter at which the particles should start fading and at which distance fade ends ( alpha becomes 0 ).
      * @realm client
      * @source https://wiki.facepunch.com/gmod/CLuaEmitter:SetNearClip
      */
     SetNearClip(self: CLuaEmitter, distanceMin: number, distanceMax: number): void;
+
     /**
      * Prevents all particles of the emitter from automatically drawing.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/CLuaEmitter:SetNoDraw
      */
     SetNoDraw(self: CLuaEmitter, noDraw: boolean): void;
+
     /**
      * The function name has not much in common with its actual function, it applies a radius to every particles that affects the building of the bounding box, as it, usually is constructed by the particle that has the lowest x, y and z and the highest x, y and z, this function just adds/subtracts the radius and inflates the bounding box.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/CLuaEmitter:SetParticleCullRadius
      */
     SetParticleCullRadius(self: CLuaEmitter, radius: number): void;
+
     /**
      * Sets the position of the particle emitter.
      * @realm client
@@ -81,16 +92,3 @@ interface CLuaEmitter {
      */
     SetPos(self: CLuaEmitter, position: Vector): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-