@tlua/gmod 1.0.5 → 1.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tlua/gmod",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Garry's Mod type declarations for tlua, generated from the GMod wiki.",
   "types": "index.d.tlua",
   "files": [

package/types/achievementicon.d.tlua

@@ -9,4 +9,3 @@
  * @source https://wiki.facepunch.com/gmod/AchievementIcon
  */
 interface AchievementIcon extends Panel {}
-

package/types/achievements.d.tlua

@@ -14,12 +14,14 @@ interface AchievementsLib {
      * @source https://wiki.facepunch.com/gmod/achievements.BalloonPopped
      */
     BalloonPopped(): void;
+
     /**
      * Returns the amount of achievements currently in Garry's Mod.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/achievements.Count
      */
     Count(): number;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      * Adds one to the count of balls eaten. Once this count reaches 200, the 'Ball Eater' achievement is unlocked.
@@ -27,30 +29,35 @@ interface AchievementsLib {
      * @source https://wiki.facepunch.com/gmod/achievements.EatBall
      */
     EatBall(): void;
+
     /**
      * Retrieves progress of given achievement.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/achievements.GetCount
      */
     GetCount(achievementID: number): number;
+
     /**
      * Retrieves the description of the given achievement.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/achievements.GetDesc
      */
     GetDesc(achievementID: number): string;
+
     /**
      * Retrieves the end progress goal of the given achievement.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/achievements.GetGoal
      */
     GetGoal(achievementID: number): number;
+
     /**
      * Retrieves the name of the given achievement.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/achievements.GetName
      */
     GetName(achievementID: number): string;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      * Adds one to the count of baddies killed. Once this count reaches 1000, the 'War Zone' achievement is unlocked.
@@ -58,6 +65,7 @@ interface AchievementsLib {
      * @source https://wiki.facepunch.com/gmod/achievements.IncBaddies
      */
     IncBaddies(): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      * Adds one to the count of innocent animals killed. Once this count reaches 1000, the 'Innocent Bystander' achievement is unlocked.
@@ -65,6 +73,7 @@ interface AchievementsLib {
      * @source https://wiki.facepunch.com/gmod/achievements.IncBystander
      */
     IncBystander(): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      * Adds one to the count of friendly NPCs killed. Once this count reaches 1000, the 'Bad Friend' achievement is unlocked.
@@ -72,12 +81,14 @@ interface AchievementsLib {
      * @source https://wiki.facepunch.com/gmod/achievements.IncGoodies
      */
     IncGoodies(): void;
+
     /**
      * Returns whether the given achievement is obtained or not.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/achievements.IsAchieved
      */
     IsAchieved(achievementID: number): boolean;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      * Adds one to the count of things removed. Once this count reaches 5000, the 'Destroyer' achievement is unlocked.
@@ -85,6 +96,7 @@ interface AchievementsLib {
      * @source https://wiki.facepunch.com/gmod/achievements.Remover
      */
     Remover(): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      * Adds one to the count of how many times the spawnmenu has been opened. Once this count reaches 100,000, the 'Menu User' achievement is unlocked.
@@ -92,6 +104,7 @@ interface AchievementsLib {
      * @source https://wiki.facepunch.com/gmod/achievements.SpawnMenuOpen
      */
     SpawnMenuOpen(): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      * Adds one to the count of NPCs spawned. Once this count reaches 1000, the 'Procreator' achievement is unlocked.
@@ -99,6 +112,7 @@ interface AchievementsLib {
      * @source https://wiki.facepunch.com/gmod/achievements.SpawnedNPC
      */
     SpawnedNPC(): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      * Adds one to the count of props spawned. Once this count reaches 5000, the 'Creator' achievement is unlocked.
@@ -106,6 +120,7 @@ interface AchievementsLib {
      * @source https://wiki.facepunch.com/gmod/achievements.SpawnedProp
      */
     SpawnedProp(): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      * Adds one to the count of ragdolls spawned. Once this count reaches 2000, the 'Dollhouse' achievement is unlocked.
@@ -114,19 +129,3 @@ interface AchievementsLib {
      */
     SpawnedRagdoll(): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/ai.d.tlua

@@ -16,30 +16,35 @@ interface AiLib {
      * @source https://wiki.facepunch.com/gmod/ai.GetNodeCount
      */
     GetNodeCount(): number;
+
     /**
      * Translates a schedule name to its corresponding ID.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/ai.GetScheduleID
      */
     GetScheduleID(sched: string): number;
+
     /**
      * Returns the squad leader of the given squad.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/ai.GetSquadLeader
      */
     GetSquadLeader(squad: string): NPC;
+
     /**
      * Returns the amount of members a given squad has. See also [ai.GetSquadMembers](https://wiki.facepunch.com/gmod/ai.GetSquadMembers).
      * @realm server
      * @source https://wiki.facepunch.com/gmod/ai.GetSquadMemberCount
      */
     GetSquadMemberCount(squad: string): number;
+
     /**
      * Returns all members of a given squad. See also [ai.GetSquadMemberCount](https://wiki.facepunch.com/gmod/ai.GetSquadMemberCount) and [NPC:GetSquad](https://wiki.facepunch.com/gmod/NPC:GetSquad).
      * @realm server
      * @source https://wiki.facepunch.com/gmod/ai.GetSquadMembers
      */
     GetSquadMembers(squad: string): table;
+
     /**
      * Translates a task name to its corresponding ID.
      * @realm server
@@ -47,9 +52,3 @@ interface AiLib {
      */
     GetTaskID(task: string): number;
 }
-
-
-
-
-
-

package/types/ai_schedule.d.tlua

@@ -14,4 +14,3 @@ interface Ai_scheduleLib {
      */
     New(name: string): table;
 }
-

package/types/ai_task.d.tlua

@@ -14,4 +14,3 @@ interface Ai_taskLib {
      */
     New(): Task;
 }
-

package/types/angle.d.tlua

@@ -23,6 +23,7 @@ interface Angle {
     __mul(l: number, r: Angle): Angle;
     __div(l: Angle, r: number): Angle;
     __unm(a: Angle): Angle;
+
     /**
      * Adds the values of the argument angle to the orignal angle.
      *
@@ -31,72 +32,84 @@ interface Angle {
      * @source https://wiki.facepunch.com/gmod/Angle:Add
      */
     Add(self: Angle, angle: Angle): void;
+
     /**
      * Divides all values of the original angle by a scalar. This functions the same as angle1 / num without creating a new angle object, skipping object construction and garbage collection.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:Div
      */
     Div(self: Angle, scalar: number): void;
+
     /**
      * Returns a normal vector facing in the direction that the angle points.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:Forward
      */
     Forward(self: Angle): Vector;
+
     /**
      * Returns if the angle is equal to another angle with the given tolerance.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:IsEqualTol
      */
     IsEqualTol(self: Angle, compare: Angle, tolerance: number): boolean;
+
     /**
      * Returns whether the pitch, yaw and roll are 0 or not.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:IsZero
      */
     IsZero(self: Angle): boolean;
+
     /**
      * Multiplies a scalar to all the values of the orignal angle. This functions the same as num * angle without creating a new angle object, skipping object construction and garbage collection.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:Mul
      */
     Mul(self: Angle, scalar: number): void;
+
     /**
      * Normalizes the angles by applying a modulo with 360 to pitch, yaw and roll.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:Normalize
      */
     Normalize(self: Angle): void;
+
     /**
      * Randomizes each element of this Angle object.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:Random
      */
     Random(self: Angle, min?: number, max?: number): void;
+
     /**
      * Returns a normal vector facing in the direction that points right relative to the angle's direction.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:Right
      */
     Right(self: Angle): Vector;
+
     /**
      * Rotates the angle around the specified axis by the specified degrees.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:RotateAroundAxis
      */
     RotateAroundAxis(self: Angle, axis: Vector, rotation: number): void;
+
     /**
      * Copies pitch, yaw and roll from the second angle to the first.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:Set
      */
     Set(self: Angle, originalAngle: Angle): void;
+
     /**
      * Sets the p, y, and r of the angle.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:SetUnpacked
      */
     SetUnpacked(self: Angle, p: number, y: number, r: number): void;
+
     /**
      * Snaps the angle to nearest interval of degrees.
      *
@@ -107,30 +120,35 @@ interface Angle {
      * @source https://wiki.facepunch.com/gmod/Angle:SnapTo
      */
     SnapTo(self: Angle, axis: string, target: number): Angle;
+
     /**
      * Subtracts the values of the argument angle to the orignal angle. This functions the same as angle1 - angle2 without creating a new angle object, skipping object construction and garbage collection.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:Sub
      */
     Sub(self: Angle, angle: Angle): void;
+
     /**
      * Returns the angle as a table with three elements.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:ToTable
      */
     ToTable(self: Angle): table;
+
     /**
      * Returns the pitch, yaw, and roll components of the angle.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:Unpack
      */
     Unpack(self: Angle): (number, number, number);
+
     /**
      * Returns a normal vector facing in the direction that points up relative to the angle's direction.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Angle:Up
      */
     Up(self: Angle): Vector;
+
     /**
      * Sets pitch, yaw and roll to 0.
      * This function is faster than doing it manually.
@@ -140,22 +158,3 @@ interface Angle {
      */
     Zero(self: Angle): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/avatarimage.d.tlua

@@ -7,4 +7,3 @@
  * @source https://wiki.facepunch.com/gmod/AvatarImage
  */
 interface AvatarImage extends Panel {}
-

package/types/awesomium.d.tlua

@@ -11,4 +11,3 @@
  * @deprecated You should be using HTML panel, which this is an alias of.
  */
 interface Awesomium extends Panel {}
-

package/types/baseclass.d.tlua

@@ -20,6 +20,7 @@ interface BaseclassLib {
      * @source https://wiki.facepunch.com/gmod/baseclass.Get
      */
     Get<T>(name: T): T;
+
     /**
      * Add a new base class that can be derived by others. This is done automatically for:
      * * [panels](https://wiki.facepunch.com/gmod/vgui.Register)
@@ -35,6 +36,3 @@ interface BaseclassLib {
      */
     Set(name: string, tab: table): void;
 }
-
-
-

package/types/bf_read.d.tlua

@@ -14,60 +14,70 @@ interface bf_read {
      * @source https://wiki.facepunch.com/gmod/bf_read:ReadAngle
      */
     ReadAngle(self: bf_read): Angle;
+
     /**
      * Reads 1 bit and returns a bool representing the bit.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/bf_read:ReadBool
      */
     ReadBool(self: bf_read): boolean;
+
     /**
      * Reads a signed char and returns a number from -127 to 127 representing the ascii value of that char.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/bf_read:ReadChar
      */
     ReadChar(self: bf_read): number;
+
     /**
      * Reads a short representing an entity index and returns the matching entity handle.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/bf_read:ReadEntity
      */
     ReadEntity(self: bf_read): Entity;
+
     /**
      * Reads a 4 byte float from the bitstream and returns it.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/bf_read:ReadFloat
      */
     ReadFloat(self: bf_read): number;
+
     /**
      * Reads a 4 byte long from the bitstream and returns it.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/bf_read:ReadLong
      */
     ReadLong(self: bf_read): number;
+
     /**
      * Reads a 2 byte short from the bitstream and returns it.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/bf_read:ReadShort
      */
     ReadShort(self: bf_read): number;
+
     /**
      * Reads a null terminated string from the bitstream.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/bf_read:ReadString
      */
     ReadString(self: bf_read): string;
+
     /**
      * Reads a special encoded vector from the bitstream and returns it, this function is not suitable to send normals.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/bf_read:ReadVector
      */
     ReadVector(self: bf_read): Vector;
+
     /**
      * Reads a special encoded vector normal from the bitstream and returns it, this function is not suitable to send vectors that represent a position.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/bf_read:ReadVectorNormal
      */
     ReadVectorNormal(self: bf_read): Vector;
+
     /**
      * Rewinds the bitstream so it can be read again.
      * @realm client
@@ -75,15 +85,3 @@ interface bf_read {
      */
     Reset(self: bf_read): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-

package/types/bit.d.tlua

@@ -12,36 +12,42 @@ interface BitLib {
      * @source https://wiki.facepunch.com/gmod/bit.arshift
      */
     arshift(value: number, shiftCount: number): number;
+
     /**
      * Performs the bitwise `and` for all values specified.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/bit.band
      */
     band(value: number, ...: any): number;
+
     /**
      * Returns the bitwise not of the value. Inverts every bit of the 32bit integer.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/bit.bnot
      */
     bnot(value: number): number;
+
     /**
      * Returns the bitwise OR of all values specified.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/bit.bor
      */
     bor(value1: number, ...: any): number;
+
     /**
      * Swaps the byte order.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/bit.bswap
      */
     bswap(value: number): number;
+
     /**
      * Returns the bitwise xor of all values specified.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/bit.bxor
      */
     bxor(value: number, otherValues?: number): number;
+
     /**
      * 		Returns the result of shifting given value left bitwise by given number of bits. See [this wiki article](https://en.wikipedia.org/wiki/Bitwise_operation#Bit_shifts) for more details.
      * 		**NOTE**: The returned value will be clamped to a signed 32-bit integer, even on 64-bit builds.
@@ -51,18 +57,21 @@ interface BitLib {
      * @source https://wiki.facepunch.com/gmod/bit.lshift
      */
     lshift(value: number, shiftCount: number): number;
+
     /**
      * Returns the left rotated value.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/bit.rol
      */
     rol(value: number, shiftCount: number): number;
+
     /**
      * Returns the right rotated value.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/bit.ror
      */
     ror(value: number, shiftCount: number): number;
+
     /**
      * 		Returns the right shifted value.
      * 		**NOTE**: The returned value will be clamped to a signed 32-bit integer, even on 64-bit builds.
@@ -72,12 +81,14 @@ interface BitLib {
      * @source https://wiki.facepunch.com/gmod/bit.rshift
      */
     rshift(value: number, shiftCount: number): number;
+
     /**
      * Normalizes the specified value and clamps it in the range of a signed 32bit integer.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/bit.tobit
      */
     tobit(value: number): number;
+
     /**
      * Returns the hexadecimal representation of the number with the specified number of characters.
      * @realm shared and menu
@@ -85,15 +96,3 @@ interface BitLib {
      */
     tohex(value: number, characters?: number): string;
 }
-
-
-
-
-
-
-
-
-
-
-
-

package/types/button.d.tlua

@@ -10,4 +10,3 @@
  * @deprecated Only exists for backwards compatibility with Panel:SetActionFunction. Use DButton instead.
  */
 interface Button extends DButton {}
-