@tlua/gmod 1.0.1

package/string.d.tlua

@@ -0,0 +1,535 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The string *type* is a sequence of characters.
+ *
+ * The string *library* is a standard Lua library which provides functions for the manipulation of strings.[[1]](https://www.lua.org/pil/20.html)
+ *
+ * In Garry's Mod there are several extra useful functions and features added to this library.
+ * Most notably all strings will access this library through the string metatable index function.[[2]](https://github.com/Facepunch/garrysmod/blob/master/garrysmod/lua/includes/extensions/string.lua#L311-L322)
+ *
+ * This means all strings are treated like table objects and the string library as its [Meta Table](https://wiki.facepunch.com/gmod/Meta_Tables)
+ *
+ * ```lua
+ * local x = "Kittens"
+ * function string.Foobar(self) return self:Right(4) end
+ *
+ * string.Right(x,4) == x:Right(4) == x:Foobar() == ("Kittens"):Right(4) == x[-4]..x[-3]..x[-2]..x[-1]
+ * ```
+ *
+ *
+ * The string *metatable* however is something else, and to access that you must use `getmetatable("")`.
+ *
+ * The difference here is related to [Metamethods](https://wiki.facepunch.com/gmod/Metamethods), such as using (+) instead of (..) to concatenate strings.
+ * **WARNING**: Using `+` operator for concatenation breaks lua metamethod to sum string as numbers (Example: `"10" + "1"` return `11` (number)) and this is 400 times SLOWER!
+ *
+ *
+ * ```lua
+ * local stringmeta = getmetatable("")
+ * function stringmeta.__add(str,x) return str..x end -- This will work
+ * function string.__add(str,x) return str..x end -- But this will not.
+ *
+ * print("Kittens" + " And " + "Puppies")
+ * ```
+ *
+ * See [Meta Tables](https://wiki.facepunch.com/gmod/Meta_Tables) and [Metamethods](https://wiki.facepunch.com/gmod/Metamethods) for more information.
+ * **WARNING**: Making changes to the string *metatable* is not a good idea unless you know what you are doing. Use the string *library* instead.
+ *
+ *
+ * This category lists functions available in the string *library*.
+ * @source https://wiki.facepunch.com/gmod/string
+ */
+interface StringLib {
+    /**
+     * Converts a cardinal (`111`) number to its [ordinal/sequential variation](https://en.wikipedia.org/wiki/Ordinal_numeral) (`111th`).
+     *
+     * See also [Global.STNDRD](https://wiki.facepunch.com/gmod/Global.STNDRD) for a function that returns just the suffix.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.CardinalToOrdinal
+     */
+    CardinalToOrdinal(input: number): string;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * Splits a string up wherever it finds the given separator. string.Split is an
+     * alias of this, except that it doesn't support patterns.
+     *
+     * Literal inputs split into a precise tuple via `Split` (the tlua port of
+     * `std.Split`); a plain `string` input yields `string[]`.
+     * @realm shared
+     * @realm menu
+     * @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>;
+}
+
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * Creates a string from a Color variable.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.FromColor
+     */
+    FromColor(color: Color): string;
+}
+
+interface StringLib {
+    /**
+     *  Returns char value from the specified index in the supplied string.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.GetChar
+     * @deprecated Use either string.sub(str, index, index) or str[index].
+     */
+    GetChar(str: string, index: number): string;
+}
+
+interface StringLib {
+    /**
+     * Returns extension of the file.
+     *
+     * See [string.StripExtension](https://wiki.facepunch.com/gmod/string.StripExtension) for a function to remove the extension.
+     * See [string.GetFileFromFilename](https://wiki.facepunch.com/gmod/string.GetFileFromFilename) and [string.GetPathFromFilename](https://wiki.facepunch.com/gmod/string.GetPathFromFilename) for related functions.
+     *
+     * 	**NOTE**: Make sure there are no trailing whitespaces in your `path` argument
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.GetExtensionFromFilename
+     */
+    GetExtensionFromFilename(path: string): string;
+}
+
+interface StringLib {
+    /**
+     * Returns file name and extension.
+     *
+     * See [string.GetPathFromFilename](https://wiki.facepunch.com/gmod/string.GetPathFromFilename) for the opposite function.
+     * See [string.GetExtensionFromFilename](https://wiki.facepunch.com/gmod/string.GetExtensionFromFilename) for the file extension version.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.GetFileFromFilename
+     */
+    GetFileFromFilename(path: string): string;
+}
+
+interface StringLib {
+    /**
+     * Returns the path part of a full file path.
+     *
+     * See [string.GetFileFromFilename](https://wiki.facepunch.com/gmod/string.GetFileFromFilename) for the opposite function.
+     * See [string.GetExtensionFromFilename](https://wiki.facepunch.com/gmod/string.GetExtensionFromFilename) for thefile extension version.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.GetPathFromFilename
+     */
+    GetPathFromFilename(path: string): string;
+}
+
+interface StringLib {
+    /**
+     * Joins the values of a table together to form a string.
+     *
+     * This is the reverse of [string.Explode](https://wiki.facepunch.com/gmod/string.Explode) and is functionally identical to [table.concat](https://wiki.facepunch.com/gmod/table.concat), but with less features.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.Implode
+     * @deprecated You really should just use table.concat.
+     */
+    Implode(separator?: string, pieces?: table): string;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * Converts a `"string_likeThis"` to a more human-friendly `"String like This"`.
+     *
+     * This is used internally by Faceposer and other code to transform flex and bodygroup names to a more friendly format.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.NiceName
+     */
+    NiceName(text: string): string;
+}
+
+interface StringLib {
+    /**
+     * Converts a digital filesize to human-readable text.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.NiceSize
+     */
+    NiceSize(bytes: number): string;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * Splits the string into a table of strings, separated by the second argument.
+     * An alias of string.Explode, but with flipped arguments.
+     *
+     * Literal inputs split into a precise tuple via `Split` (the tlua port of
+     * `std.Split`); a plain `string` input yields `string[]`.
+     * @realm shared
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/string.Split
+     */
+    Split<Sep extends string, Str extends string>(Inputstring: ConstTpl<Str>, Separator: ConstTpl<Sep>): Split<Sep, Str>;
+}
+
+
+interface StringLib {
+    /**
+     * 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
+     * @source https://wiki.facepunch.com/gmod/string.StartWith
+     * @deprecated Use string.StartsWith.
+     */
+    StartWith(inputStr: string, start: string): boolean;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * Removes the extension of a path.
+     *
+     * See [string.GetExtensionFromFilename](https://wiki.facepunch.com/gmod/string.GetExtensionFromFilename) for a function to retrieve the extension instead.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.StripExtension
+     */
+    StripExtension(path: string): string;
+}
+
+interface StringLib {
+    /**
+     * 		Attempts to create a Color from a string.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.ToColor
+     */
+    ToColor(colorString: string): Color;
+}
+
+interface StringLib {
+    /**
+     * Returns given time in "MM:SS" format.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.ToMinutesSeconds
+     */
+    ToMinutesSeconds(time: number): string;
+}
+
+interface StringLib {
+    /**
+     * Returns given time in "MM:SS:MS" format.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.ToMinutesSecondsMilliseconds
+     */
+    ToMinutesSecondsMilliseconds(time: number): string;
+}
+
+interface StringLib {
+    /**
+     * Splits the string into characters and creates a sequential table of characters.
+     *
+     * **WARNING**: As a result of the  encoding, non-ASCII characters will be split into more than one character in the output table. Each character value in the output table will always be 1 byte.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.ToTable
+     */
+    ToTable(str: string): table;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 		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.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.byte
+     */
+    byte(string: string, startPos?: number, endPos?: number): (...any);
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * Returns the binary bytecode of the given function.
+     *
+     * **NOTE**: This does not work with functions created in C/C++. An error will be thrown if it is
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.dump
+     */
+    dump(func: function, stripDebugInfo?: boolean): string;
+}
+
+interface StringLib {
+    /**
+     * Attempts to find the specified substring in a string.
+     *
+     * **WARNING**: This function uses [Lua Patterns](https://wiki.facepunch.com/gmod/Patterns) by default.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.find
+     */
+    find(haystack: string, needle: string, startPos?: number, noPatterns?: boolean): (number, number, string);
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 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
+     * @source https://wiki.facepunch.com/gmod/string.gfind
+     * @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;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * Replaces certain character sequences in a string using Patterns.
+     *
+     * The replacement may be a string, a table (matched sequence used as key), or a
+     * function (all matches passed as parameters; return value(s) used as replacement).
+     * @realm shared
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/string.gsub
+     */
+    gsub(string: string, pattern: string, replacement: string | table | ((...: string) => string), maxReplaces?: number): (string, number);
+}
+
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 		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.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.lower
+     */
+    lower(str: string): string;
+}
+
+interface StringLib {
+    /**
+     * 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);
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * Reverses a string.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.reverse
+     */
+    reverse(str: string): string;
+}
+
+interface StringLib {
+    /**
+     * 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;
+}
+
+interface StringLib {
+    /**
+     * 		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.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/string.upper
+     */
+    upper(str: string): string;
+}
+