@tlua/gmod 1.0.5 → 1.0.6

package/types/steamworks.d.tlua

@@ -13,6 +13,7 @@ interface SteamworksLib {
      * @source https://wiki.facepunch.com/gmod/steamworks.ApplyAddons
      */
     ApplyAddons(): void;
+
     /**
      * **NOTE**: You really should be using [steamworks.DownloadUGC](https://wiki.facepunch.com/gmod/steamworks.DownloadUGC) when downloading Steam Workshop items. This is a legacy function for preview images.
      *
@@ -27,12 +28,14 @@ interface SteamworksLib {
      * @source https://wiki.facepunch.com/gmod/steamworks.Download
      */
     Download(workshopPreviewID: string, uncompress: boolean, resultCallback: (path: string) => void): void;
+
     /**
      * Downloads the Fire Extinguisher addon from Steam Workshop prints path to its .gma file to be used with [game.MountGMA](https://wiki.facepunch.com/gmod/game.MountGMA).
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/steamworks.DownloadUGC
      */
     DownloadUGC(workshopID: string, resultCallback: (path: string, file: file_class) => void): void;
+
     /**
      * 		Retrieves info about supplied Steam Workshop addon.
      *
@@ -40,12 +43,14 @@ interface SteamworksLib {
      * @source https://wiki.facepunch.com/gmod/steamworks.FileInfo
      */
     FileInfo(workshopItemID: string, resultCallback: (data: table) => void, extraInfo?: boolean): void;
+
     /**
      * Retrieves a customized list of Steam Workshop addons.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/steamworks.GetList
      */
     GetList(type: string, tags: table, offset: number, numRetrieve: number, days: number, userID?: string, resultCallback?: (data: table) => void, searchText?: string): void;
+
     /**
      * Retrieves players name by their 64bit SteamID.
      *
@@ -56,18 +61,21 @@ interface SteamworksLib {
      * @deprecated You should use the callback of steamworks.RequestPlayerInfo instead.
      */
     GetPlayerName(steamID64: string): string;
+
     /**
      * Returns whenever the client is subscribed to the specified Steam Workshop item.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/steamworks.IsSubscribed
      */
     IsSubscribed(workshopItemID: string): boolean;
+
     /**
      * Opens the workshop website in the steam overlay browser.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/steamworks.OpenWorkshop
      */
     OpenWorkshop(): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -77,18 +85,21 @@ interface SteamworksLib {
      * @source https://wiki.facepunch.com/gmod/steamworks.Publish
      */
     Publish(filename: string, image: string, name: string, desc: string, tags: table, callback: (fileID: number, error: string) => void, fileid?: number, changelist?: string): void;
+
     /**
      * Requests information of the player with SteamID64 for later use with [steamworks.GetPlayerName](https://wiki.facepunch.com/gmod/steamworks.GetPlayerName).
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/steamworks.RequestPlayerInfo
      */
     RequestPlayerInfo(steamID64: string, callback: (name: string) => void): void;
+
     /**
      * Sets the workshop item as "completed" by the player. There will be a visual indicator on the Steam Workshop for completed items.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/steamworks.SetFileCompleted
      */
     SetFileCompleted(workshopid: string): string;
+
     /**
      * Sets whether you have played this addon or not. This will be shown to the user in the Steam Workshop itself:
      *
@@ -97,18 +108,21 @@ interface SteamworksLib {
      * @source https://wiki.facepunch.com/gmod/steamworks.SetFilePlayed
      */
     SetFilePlayed(workshopid: string): string;
+
     /**
      * Sets if an addon should be enabled or disabled. Call [steamworks.ApplyAddons](https://wiki.facepunch.com/gmod/steamworks.ApplyAddons) afterwards to update.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/steamworks.SetShouldMountAddon
      */
     SetShouldMountAddon(workshopItemID: string, shouldMount: boolean): void;
+
     /**
      * Returns whenever the specified Steam Workshop addon will be mounted or not.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/steamworks.ShouldMountAddon
      */
     ShouldMountAddon(workshopItemID: string): boolean;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -119,6 +133,7 @@ interface SteamworksLib {
      * @source https://wiki.facepunch.com/gmod/steamworks.Subscribe
      */
     Subscribe(workshopItemID: string): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *  Unsubscribes to the specified workshop addon. Call [steamworks.ApplyAddons](https://wiki.facepunch.com/gmod/steamworks.ApplyAddons) afterwards to update.
@@ -129,12 +144,14 @@ interface SteamworksLib {
      * @source https://wiki.facepunch.com/gmod/steamworks.Unsubscribe
      */
     Unsubscribe(workshopItemID: string): void;
+
     /**
      * Opens the workshop website for specified Steam Workshop item in the Steam overlay browser.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/steamworks.ViewFile
      */
     ViewFile(workshopItemID: string): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *  Makes the user vote for the specified addon
@@ -142,6 +159,7 @@ interface SteamworksLib {
      * @source https://wiki.facepunch.com/gmod/steamworks.Vote
      */
     Vote(workshopItemID: string, upOrDown: boolean): void;
+
     /**
      * Retrieves vote info of supplied addon.
      *
@@ -151,22 +169,3 @@ interface SteamworksLib {
      */
     VoteInfo(workshopItemID: string, resultCallback: (data: table) => void): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/string.d.tlua

@@ -49,18 +49,21 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.CardinalToOrdinal
      */
     CardinalToOrdinal(input: number): string;
+
     /**
      * Inserts commas for every third digit of a given number.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.Comma
      */
     Comma(value: number, separator?: string): string;
+
     /**
      * Returns whether or not the second passed string matches the end of the first.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.EndsWith
      */
     EndsWith(str: string, _end: string): boolean;
+
     /**
      * Splits a string up wherever it finds the given separator. string.Split is an
      * alias of this, except that it doesn't support patterns.
@@ -72,18 +75,21 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.Explode
      */
     Explode<Sep extends string, Str extends string>(separator: ConstTpl<Sep>, str: ConstTpl<Str>, withpattern?: boolean): Split<Sep, Str>;
+
     /**
      * Returns the time as a formatted string or as a table if no format is given.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.FormattedTime
      */
     FormattedTime(float: number, format?: string): string | FormattedTime;
+
     /**
      * Creates a string from a Color variable.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.FromColor
      */
     FromColor(color: Color): string;
+
     /**
      *  Returns char value from the specified index in the supplied string.
      * @realm shared and menu
@@ -91,6 +97,7 @@ interface StringLib {
      * @deprecated Use either string.sub(str, index, index) or str[index].
      */
     GetChar(str: string, index: number): string;
+
     /**
      * Returns extension of the file.
      *
@@ -104,6 +111,7 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.GetExtensionFromFilename
      */
     GetExtensionFromFilename(path: string): string;
+
     /**
      * Returns file name and extension.
      *
@@ -114,6 +122,7 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.GetFileFromFilename
      */
     GetFileFromFilename(path: string): string;
+
     /**
      * Returns the path part of a full file path.
      *
@@ -125,6 +134,7 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.GetPathFromFilename
      */
     GetPathFromFilename(path: string): string;
+
     /**
      * Joins the values of a table together to form a string.
      *
@@ -135,24 +145,28 @@ interface StringLib {
      * @deprecated You really should just use table.concat.
      */
     Implode(separator?: string, pieces?: table): string;
+
     /**
      * Interpolates a given string with the given table. This is useful for formatting localized strings.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.Interpolate
      */
     Interpolate(str: string, lookuptable: table): string;
+
     /**
      * Escapes special characters for JavaScript in a string, making the string safe for inclusion in to JavaScript strings.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.JavascriptSafe
      */
     JavascriptSafe(str: string): string;
+
     /**
      * Returns everything left of supplied place of that string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.Left
      */
     Left(str: string, num: number): string;
+
     /**
      * Converts a `"string_likeThis"` to a more human-friendly `"String like This"`.
      *
@@ -162,42 +176,49 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.NiceName
      */
     NiceName(text: string): string;
+
     /**
      * Converts a digital filesize to human-readable text.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.NiceSize
      */
     NiceSize(bytes: number): string;
+
     /**
      * Formats the supplied number (in seconds) to the highest possible time unit.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.NiceTime
      */
     NiceTime(num: number): string;
+
     /**
      * Escapes all special characters within a string, making the string safe for inclusion in a Lua pattern.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.PatternSafe
      */
     PatternSafe(str: string): string;
+
     /**
      * Replaces all occurrences of the supplied second string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.Replace
      */
     Replace(str: string, find: string, replace: string): string;
+
     /**
      * Returns the last n-th characters of the string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.Right
      */
     Right(str: string, num: number): string;
+
     /**
      * Sets the character at the specific index of the string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.SetChar
      */
     SetChar(InputString: string, Index: number, ReplacementChar: string): string;
+
     /**
      * Splits the string into a table of strings, separated by the second argument.
      * An alias of string.Explode, but with flipped arguments.
@@ -209,6 +230,7 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.Split
      */
     Split<Sep extends string, Str extends string>(Inputstring: ConstTpl<Str>, Separator: ConstTpl<Sep>): Split<Sep, Str>;
+
     /**
      * Returns whether or not the first string starts with the second. This is a alias of [string.StartsWith](https://wiki.facepunch.com/gmod/string.StartsWith).
      * @realm shared and menu
@@ -216,12 +238,14 @@ interface StringLib {
      * @deprecated Use string.StartsWith.
      */
     StartWith(inputStr: string, start: string): boolean;
+
     /**
      * Returns whether or not the first string starts with the second.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.StartsWith
      */
     StartsWith(inputStr: string, start: string): boolean;
+
     /**
      * Removes the extension of a path.
      *
@@ -231,6 +255,7 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.StripExtension
      */
     StripExtension(path: string): string;
+
     /**
      * 		Attempts to create a Color from a string.
      *
@@ -238,18 +263,21 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.ToColor
      */
     ToColor(colorString: string): Color;
+
     /**
      * Returns given time in "MM:SS" format.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.ToMinutesSeconds
      */
     ToMinutesSeconds(time: number): string;
+
     /**
      * Returns given time in "MM:SS:MS" format.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.ToMinutesSecondsMilliseconds
      */
     ToMinutesSecondsMilliseconds(time: number): string;
+
     /**
      * Splits the string into characters and creates a sequential table of characters.
      *
@@ -260,24 +288,28 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.ToTable
      */
     ToTable(str: string): table;
+
     /**
      * Removes leading and trailing matches of a string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.Trim
      */
     Trim(Inputstring: string, Char?: string): string;
+
     /**
      * Removes leading spaces/characters from a string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.TrimLeft
      */
     TrimLeft(str: string, char?: string): string;
+
     /**
      * Removes trailing spaces/passed character from a string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.TrimRight
      */
     TrimRight(str: string, char?: string): string;
+
     /**
      * 		Returns the given string's characters in their numeric ASCII representation.
      * 		**WARNING**: This function will throw an error if the slice length is greater than 8000 characters.
@@ -287,12 +319,14 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.byte
      */
     byte(string: string, startPos?: number, endPos?: number): (...any);
+
     /**
      * Takes the given numerical bytes and converts them to a string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.char
      */
     char(...: any): string;
+
     /**
      * Returns the binary bytecode of the given function.
      *
@@ -303,6 +337,7 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.dump
      */
     dump(func: function, stripDebugInfo?: boolean): string;
+
     /**
      * Attempts to find the specified substring in a string.
      *
@@ -313,12 +348,14 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.find
      */
     find(haystack: string, needle: string, startPos?: number, noPatterns?: boolean): (number, number, string);
+
     /**
      * Formats the specified values into the string given.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.format
      */
     format(format: string, ...: any): string;
+
     /**
      * Returns an iterator function that is called for every complete match of the pattern, all sub matches will be passed as to the loop.
      * @realm shared and menu
@@ -326,12 +363,14 @@ interface StringLib {
      * @deprecated This function is removed in Lua versions later than what GMod is currently using. Use string.gmatch instead.
      */
     gfind(data: string, pattern: string): function;
+
     /**
      * Using [Patterns](https://wiki.facepunch.com/gmod/Patterns), returns an iterator which will return either one value if no capture groups are defined, or any capture group matches.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.gmatch
      */
     gmatch(data: string, pattern: string): function;
+
     /**
      * Replaces certain character sequences in a string using Patterns.
      *
@@ -342,12 +381,14 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.gsub
      */
     gsub(string: string, pattern: string, replacement: string | table | ((...: string) => string), maxReplaces?: number): (string, number);
+
     /**
      * Counts the number of characters in the string (length). This is equivalent to using the length operator (#).
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.len
      */
     len(str: string): number;
+
     /**
      * 		Changes any upper-case letters in a string to lower-case letters.
      * 		**NOTE**: This function doesn't work on special non-English UTF-8 characters.
@@ -357,30 +398,35 @@ interface StringLib {
      * @source https://wiki.facepunch.com/gmod/string.lower
      */
     lower(str: string): string;
+
     /**
      * Finds a [Pattern](https://wiki.facepunch.com/gmod/Patterns) in a string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.match
      */
     match(string: string, pattern: string, startPosition?: number): (...any);
+
     /**
      * Repeats a string by the provided number, with an optional separator.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.rep
      */
     rep(str: string, repetitions: number, separator?: string): string;
+
     /**
      * Reverses a string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.reverse
      */
     reverse(str: string): string;
+
     /**
      * Returns a sub-string, starting from the character at position `StartPos` of the string (inclusive), and optionally ending at the character at position `EndPos` of the string (also inclusive). If EndPos is not given, the rest of the string is returned.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/string.sub
      */
     sub(string: string, StartPos: number, EndPos?: number): string;
+
     /**
      * 		Changes any lower-case letters in a string to upper-case letters.
      * 		**NOTE**: This function doesn't work on special non-English UTF-8 characters.
@@ -391,53 +437,3 @@ interface StringLib {
      */
     upper(str: string): string;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/structures.d.tlua

@@ -1128,7 +1128,6 @@ interface EntityCopyData {
     WorkshopID?: number;
 }
 
-
 /**
  * 		The table structure used for bullets that have already been fired.
  *
@@ -1409,7 +1408,6 @@ interface HTTPRequestWithoutParameters extends HTTPRequest {
     parameters: nil;
 }
 
-
 /**
  * Table used by util.TraceHull.
  * @realm shared
@@ -1444,7 +1442,6 @@ interface HullTrace {
     hitclientonly?: boolean;
 }
 
-
 /**
  * Table structure used for [render.SetLocalModelLights](https://wiki.facepunch.com/gmod/render.SetLocalModelLights).
  * @realm client
@@ -3148,7 +3145,6 @@ interface SoundData {
     pitchend?: number;
 }
 
-
 /**
  * Table describing a sound hint, used by [NPC:GetBestSoundHint](https://wiki.facepunch.com/gmod/NPC:GetBestSoundHint) and [sound.GetLoudestSoundHint](https://wiki.facepunch.com/gmod/sound.GetLoudestSoundHint).
  * @realm server
@@ -3380,7 +3376,6 @@ interface Tool {
     RightClickAutomatic?: boolean;
 }
 
-
 /**
  * Table is one element from [team.GetAllTeams](https://wiki.facepunch.com/gmod/team.GetAllTeams).
  * @realm shared
@@ -3523,7 +3518,6 @@ interface Trace {
     hitclientonly?: boolean;
 }
 
-
 /**
  * Table structure used as trace result. Default values are when the trace hits nothing.
  *
@@ -4439,4 +4433,3 @@ interface ViewSetup {
      */
     offcenter: table;
 }
-