@tlua/gmod 1.0.5 → 1.0.6

package/types/convar.d.tlua

@@ -13,66 +13,77 @@ interface ConVar {
      * @source https://wiki.facepunch.com/gmod/ConVar:GetBool
      */
     GetBool(self: ConVar): boolean;
+
     /**
      * Returns the default value of the [ConVar](https://wiki.facepunch.com/gmod/ConVar)
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ConVar:GetDefault
      */
     GetDefault(self: ConVar): string;
+
     /**
      * Returns the [Enums/FCVAR](https://wiki.facepunch.com/gmod/Enums/FCVAR) flags of the ConVar
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ConVar:GetFlags
      */
     GetFlags(self: ConVar): number;
+
     /**
      * Attempts to convert the [ConVar](https://wiki.facepunch.com/gmod/ConVar) value to a float
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ConVar:GetFloat
      */
     GetFloat(self: ConVar): number;
+
     /**
      * Returns the help text assigned to that convar.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ConVar:GetHelpText
      */
     GetHelpText(self: ConVar): string;
+
     /**
      * Attempts to convert the [ConVar](https://wiki.facepunch.com/gmod/ConVar) value to a integer.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ConVar:GetInt
      */
     GetInt(self: ConVar): number;
+
     /**
      * Returns the maximum value of the [ConVar](https://wiki.facepunch.com/gmod/ConVar)
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ConVar:GetMax
      */
     GetMax(self: ConVar): number;
+
     /**
      * Returns the minimum value of the [ConVar](https://wiki.facepunch.com/gmod/ConVar)
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ConVar:GetMin
      */
     GetMin(self: ConVar): number;
+
     /**
      * Returns the name of the [ConVar](https://wiki.facepunch.com/gmod/ConVar).
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ConVar:GetName
      */
     GetName(self: ConVar): string;
+
     /**
      * Returns the current [ConVar](https://wiki.facepunch.com/gmod/ConVar) value as a string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ConVar:GetString
      */
     GetString(self: ConVar): string;
+
     /**
      * Returns whether the specified flag is set on the [ConVar](https://wiki.facepunch.com/gmod/ConVar)
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ConVar:IsFlagSet
      */
     IsFlagSet(self: ConVar, flag: number): boolean;
+
     /**
      * Reverts [ConVar](https://wiki.facepunch.com/gmod/ConVar) to its default value
      *
@@ -82,12 +93,14 @@ interface ConVar {
      * @source https://wiki.facepunch.com/gmod/ConVar:Revert
      */
     Revert(self: ConVar): void;
+
     /**
      * Sets a ConVar's value to 1 or 0 based on the input boolean. This can only be ran on ConVars created from within Lua.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ConVar:SetBool
      */
     SetBool(self: ConVar, value: boolean): void;
+
     /**
      * Sets a ConVar's value to the input number.
      * 	**NOTE**: This can only be ran on ConVars created from within Lua.
@@ -96,6 +109,7 @@ interface ConVar {
      * @source https://wiki.facepunch.com/gmod/ConVar:SetFloat
      */
     SetFloat(self: ConVar, value: number): void;
+
     /**
      * Sets a ConVar's value to the input number after converting it to an integer.
      *
@@ -105,6 +119,7 @@ interface ConVar {
      * @source https://wiki.facepunch.com/gmod/ConVar:SetInt
      */
     SetInt(self: ConVar, value: number): void;
+
     /**
      * Sets a ConVar's value to the input string. This can only be ran on ConVars created from within Lua.
      * @realm shared and menu
@@ -112,20 +127,3 @@ interface ConVar {
      */
     SetString(self: ConVar, value: string): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/cookie.d.tlua

@@ -27,18 +27,21 @@ interface CookieLib {
      * @source https://wiki.facepunch.com/gmod/cookie.Delete
      */
     Delete(key: string): void;
+
     /**
      * Gets the value of a cookie on the client as a number.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/cookie.GetNumber
      */
     GetNumber(name: string, _default?: any): number;
+
     /**
      * Gets the value of a cookie on the client as a string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/cookie.GetString
      */
     GetString(name: string, _default?: any): string;
+
     /**
      * 		Creates / updates a cookie in the [Database](https://wiki.facepunch.com/gmod/cookie).
      *
@@ -48,7 +51,3 @@ interface CookieLib {
      */
     Set(key: string, value: string): void;
 }
-
-
-
-

package/types/coroutine.d.tlua

@@ -11,6 +11,7 @@ interface CoroutineLib {
      * @source https://wiki.facepunch.com/gmod/coroutine.create
      */
     create(func: function): thread;
+
     /**
      * 		Returns whether the running coroutine can yield.
      * 		A running coroutine is yieldable if it is not in the main thread, and it is not inside a non-yieldable C function.
@@ -21,24 +22,28 @@ interface CoroutineLib {
      * @source https://wiki.facepunch.com/gmod/coroutine.isyieldable
      */
     isyieldable(): boolean;
+
     /**
      * Resumes the given coroutine and passes the given vararg to either the function arguments or the [coroutine.yield](https://wiki.facepunch.com/gmod/coroutine.yield) that is inside that function and returns whatever yield is called with the next time or by the final return in the function.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/coroutine.resume
      */
     resume(coroutine: thread, ...: any): (boolean, ...any);
+
     /**
      * Returns the active coroutine or nil if we are not within a coroutine.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/coroutine.running
      */
     running(): thread;
+
     /**
      * Returns the status of the coroutine passed to it, the possible statuses are "suspended", "running", and "dead".
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/coroutine.status
      */
     status(coroutine: thread): string;
+
     /**
      * Repeatedly yields the coroutine for the given duration before continuing.
      *
@@ -50,6 +55,7 @@ interface CoroutineLib {
      * @source https://wiki.facepunch.com/gmod/coroutine.wait
      */
     wait(duration: number): void;
+
     /**
      * Returns a function which calling is equivalent with calling [coroutine.resume](https://wiki.facepunch.com/gmod/coroutine.resume) with the coroutine and all extra parameters.
      *
@@ -59,6 +65,7 @@ interface CoroutineLib {
      * @source https://wiki.facepunch.com/gmod/coroutine.wrap
      */
     wrap(coroutine: function): function;
+
     /**
      * Pauses the active coroutine and passes all additional variables to the call of [coroutine.resume](https://wiki.facepunch.com/gmod/coroutine.resume) that resumed the coroutine last time, and returns all additional variables that were passed to the previous call of resume.
      * @realm shared and menu
@@ -66,11 +73,3 @@ interface CoroutineLib {
      */
     yield(...: any): (...any);
 }
-
-
-
-
-
-
-
-

package/types/crecipientfilter.d.tlua

@@ -11,90 +11,105 @@ interface CRecipientFilter {
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:AddAllPlayers
      */
     AddAllPlayers(self: CRecipientFilter): void;
+
     /**
      * Adds all players that are in the same [PAS (Potentially Audible Set)](https://developer.valvesoftware.com/wiki/PAS "PAS - Valve Developer Community") as this position.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:AddPAS
      */
     AddPAS(self: CRecipientFilter, pos: Vector): void;
+
     /**
      * Adds all players that are in the same [PVS (Potential Visibility Set)](https://developer.valvesoftware.com/wiki/PVS "PVS - Valve Developer Community") as this position.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:AddPVS
      */
     AddPVS(self: CRecipientFilter, Position: Vector): void;
+
     /**
      * Adds a player to the recipient filter
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:AddPlayer
      */
     AddPlayer(self: CRecipientFilter, Player: Player): void;
+
     /**
      * Adds players to the recipient filter from a given table or another recipient filter.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:AddPlayers
      */
     AddPlayers(self: CRecipientFilter, input: CRecipientFilter | Player[]): void;
+
     /**
      * Adds all players that are on the given team to the filter.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:AddRecipientsByTeam
      */
     AddRecipientsByTeam(self: CRecipientFilter, teamid: number): void;
+
     /**
      * Returns the number of valid players in the recipient filter.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:GetCount
      */
     GetCount(self: CRecipientFilter): number;
+
     /**
      * Returns a table of all valid players currently in the recipient filter.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:GetPlayers
      */
     GetPlayers(self: CRecipientFilter): Player[];
+
     /**
      * Removes all players from the recipient filter.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:RemoveAllPlayers
      */
     RemoveAllPlayers(self: CRecipientFilter): void;
+
     /**
      * Remove players from this recipient filter that are **NOT** present in a given table or recipient filter.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:RemoveMismatchedPlayers
      */
     RemoveMismatchedPlayers(self: CRecipientFilter, input: CRecipientFilter): void;
+
     /**
      * Removes all players from the filter that are in [PAS (Potentially Audible Set)](https://developer.valvesoftware.com/wiki/PAS "PAS - Valve Developer Community") for given position.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:RemovePAS
      */
     RemovePAS(self: CRecipientFilter, position: Vector): void;
+
     /**
      * Removes all players that can see this [PVS (Potential Visibility Set)](https://developer.valvesoftware.com/wiki/PVS "PVS - Valve Developer Community") from the recipient filter.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:RemovePVS
      */
     RemovePVS(self: CRecipientFilter, pos: Vector): void;
+
     /**
      * Removes the player from the recipient filter.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:RemovePlayer
      */
     RemovePlayer(self: CRecipientFilter, Player: Player): void;
+
     /**
      * Remove players from this recipient filter that are present in a given table or recipient filter.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:RemovePlayers
      */
     RemovePlayers(self: CRecipientFilter, input: CRecipientFilter): void;
+
     /**
      * Removes all players that are on the given team from the filter.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/CRecipientFilter:RemoveRecipientsByTeam
      */
     RemoveRecipientsByTeam(self: CRecipientFilter, teamid: number): void;
+
     /**
      * Removes all players that are not on the given team from the filter.
      * @realm server
@@ -102,20 +117,3 @@ interface CRecipientFilter {
      */
     RemoveRecipientsNotOnTeam(self: CRecipientFilter, teamid: number): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/csent.d.tlua

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

package/types/csoundpatch.d.tlua

@@ -18,6 +18,7 @@ interface CSoundPatch {
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:ChangePitch
      */
     ChangePitch(self: CSoundPatch, pitch: number, deltaTime?: number): void;
+
     /**
      * Adjusts the volume of the sound played.
      *
@@ -27,60 +28,70 @@ interface CSoundPatch {
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:ChangeVolume
      */
     ChangeVolume(self: CSoundPatch, volume: number, deltaTime?: number): void;
+
     /**
      * Fades out the volume of the sound from the current volume to 0 in the given amount of seconds.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:FadeOut
      */
     FadeOut(self: CSoundPatch, seconds: number): void;
+
     /**
      * Returns the DSP (Digital Signal Processor) effect ID for the sound.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:GetDSP
      */
     GetDSP(self: CSoundPatch): number;
+
     /**
      * Returns the current pitch.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:GetPitch
      */
     GetPitch(self: CSoundPatch): number;
+
     /**
      * Returns the current sound level.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:GetSoundLevel
      */
     GetSoundLevel(self: CSoundPatch): number;
+
     /**
      * Returns the sound name of this sound patch. This may be name of a sound script ([sound.Add](https://wiki.facepunch.com/gmod/sound.Add)) or a file path.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:GetSoundName
      */
     GetSoundName(self: CSoundPatch): string;
+
     /**
      * Returns the current volume.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:GetVolume
      */
     GetVolume(self: CSoundPatch): number;
+
     /**
      * Returns whenever the sound is being played.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:IsPlaying
      */
     IsPlaying(self: CSoundPatch): boolean;
+
     /**
      * Starts to play the sound. This will reset the sound's volume and pitch to their default values. See [CSoundPatch:PlayEx](https://wiki.facepunch.com/gmod/CSoundPatch:PlayEx)
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:Play
      */
     Play(self: CSoundPatch): void;
+
     /**
      * Same as [CSoundPatch:Play](https://wiki.facepunch.com/gmod/CSoundPatch:Play) but with 2 extra arguments allowing to set volume and pitch directly.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:PlayEx
      */
     PlayEx(self: CSoundPatch, volume: number, pitch: number): void;
+
     /**
      * Sets the DSP (Digital Signal Processor) effect for the sound.
      *
@@ -90,12 +101,14 @@ interface CSoundPatch {
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:SetDSP
      */
     SetDSP(self: CSoundPatch, dspEffectId: number): void;
+
     /**
      * Sets the sound level in decibel.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/CSoundPatch:SetSoundLevel
      */
     SetSoundLevel(self: CSoundPatch, level: number): void;
+
     /**
      * Stops the sound from being played.
      *
@@ -106,18 +119,3 @@ interface CSoundPatch {
      */
     Stop(self: CSoundPatch): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-