@tlua/gmod 1.0.1

package/color.d.tlua

@@ -0,0 +1,339 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+interface Color {
+    /** The red component of the color. */
+    r: number;
+    /** The green component of the color. */
+    g: number;
+    /** The blue component of the color. */
+    b: number;
+    /** The alpha component of the color. */
+    a: number;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HWB color space](https://en.wikipedia.org/wiki/HWB_color_model), adds given value to the "blackness" and converts it back into an RGB color.
+     *
+     * A slightly more efficient combination of [COLOR:GetBlackness](https://wiki.facepunch.com/gmod/COLOR:GetBlackness) & [COLOR:SetBlackness](https://wiki.facepunch.com/gmod/COLOR:SetBlackness)
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:AddBlackness
+     */
+    AddBlackness(self: Color, blackness: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSV color space](https://en.wikipedia.org/wiki/HSL_and_HSV), adds given value to the [brightness also known as "value"](https://en.wikipedia.org/wiki/Brightness) and converts it back into an RGB color.
+     *
+     * A slightly more efficient combination of [COLOR:GetBrightness](https://wiki.facepunch.com/gmod/COLOR:GetBrightness) & [COLOR:SetBrightness](https://wiki.facepunch.com/gmod/COLOR:SetBrightness)
+     *
+     * This is useful to quickly change the saturation of the color without changing hue or luminance, allowing for things like easy theming.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:AddBrightness
+     */
+    AddBrightness(self: Color, saturation: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSV color space](https://en.wikipedia.org/wiki/HSL_and_HSV), adds given value to the [hue](https://en.wikipedia.org/wiki/Hue) and converts it back into an RGB color.
+     *
+     * A slightly more efficient combination of [COLOR:GetHue](https://wiki.facepunch.com/gmod/COLOR:GetHue) & [COLOR:SetHue](https://wiki.facepunch.com/gmod/COLOR:SetHue)
+     *
+     * This is useful to quickly change the hue of the color without changing saturation or luminance, allowing for things like easy theming.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:AddHue
+     */
+    AddHue(self: Color, hue: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSL color space](https://en.wikipedia.org/wiki/HSL_and_HSV), adds given value to the ["lightness"](https://en.wikipedia.org/wiki/Lightness) and converts it back into an RGB color.
+     *
+     * A slightly more efficient combination of [COLOR:GetLightness](https://wiki.facepunch.com/gmod/COLOR:GetLightness) & [COLOR:SetLightness](https://wiki.facepunch.com/gmod/COLOR:SetLightness)
+     *
+     * This is useful to quickly change the lightness of the color without changing hue or saturation, allowing for things like easy theming.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:AddLightness
+     */
+    AddLightness(self: Color, lightness: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSV color space](https://en.wikipedia.org/wiki/HSL_and_HSV), adds given value to the [saturation](https://en.wikipedia.org/wiki/Colorfulness) and converts it back into an RGB color.
+     *
+     * A slightly more efficient combination of [COLOR:GetSaturation](https://wiki.facepunch.com/gmod/COLOR:GetSaturation) & [COLOR:SetSaturation](https://wiki.facepunch.com/gmod/COLOR:SetSaturation)
+     *
+     * This is useful to quickly change the saturation of the color without changing hue or luminance, allowing for things like easy theming.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:AddSaturation
+     */
+    AddSaturation(self: Color, saturation: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HWB color space](https://en.wikipedia.org/wiki/HWB_color_model), adds given value to the "whiteness" and converts it back into an RGB color.
+     *
+     * A slightly more efficient combination of [COLOR:GetWhiteness](https://wiki.facepunch.com/gmod/COLOR:GetWhiteness) & [COLOR:SetWhiteness](https://wiki.facepunch.com/gmod/COLOR:SetWhiteness)
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:AddWhiteness
+     */
+    AddWhiteness(self: Color, whiteness: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HWB color space](https://en.wikipedia.org/wiki/HWB_color_model) and returns the "blackness" of the color.
+     *
+     * See [COLOR:ToHWB](https://wiki.facepunch.com/gmod/COLOR:ToHWB) if you want to get all 3 components.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:GetBlackness
+     */
+    GetBlackness(self: Color): number;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSV color space](https://en.wikipedia.org/wiki/HSL_and_HSV) and returns the [brightness also known as "value"](https://en.wikipedia.org/wiki/Brightness).
+     *
+     * See [COLOR:ToHSV](https://wiki.facepunch.com/gmod/COLOR:ToHSV) if you want to get all 3 components.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:GetBrightness
+     */
+    GetBrightness(self: Color): number;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSV color space](https://en.wikipedia.org/wiki/HSL_and_HSV) and returns the [hue](https://en.wikipedia.org/wiki/Hue).
+     *
+     * See [COLOR:ToHSV](https://wiki.facepunch.com/gmod/COLOR:ToHSV) if you want to get all 3 components.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:GetHue
+     */
+    GetHue(self: Color): number;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSL color space](https://en.wikipedia.org/wiki/HSL_and_HSV) and returns the ["lightness"](https://en.wikipedia.org/wiki/Lightness) of the color.
+     *
+     * See [COLOR:ToHSL](https://wiki.facepunch.com/gmod/COLOR:ToHSL) if you want to get all 3 components.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:GetLightness
+     */
+    GetLightness(self: Color): number;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSV color space](https://en.wikipedia.org/wiki/HSL_and_HSV) and returns the [saturation](https://en.wikipedia.org/wiki/Colorfulness).
+     *
+     * See [COLOR:ToHSV](https://wiki.facepunch.com/gmod/COLOR:ToHSV) if you want to get all 3 components.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:GetSaturation
+     */
+    GetSaturation(self: Color): number;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HWB color space](https://en.wikipedia.org/wiki/HWB_color_model) and returns the "whiteness" of the color.
+     *
+     * See [COLOR:ToHWB](https://wiki.facepunch.com/gmod/COLOR:ToHWB) if you want to get all 3 components.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:GetWhiteness
+     */
+    GetWhiteness(self: Color): number;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HWB color space](https://en.wikipedia.org/wiki/HWB_color_model), sets the "blackness" and converts it back into an RGB color.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:SetBlackness
+     */
+    SetBlackness(self: Color, blackness: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSV color space](https://en.wikipedia.org/wiki/HSL_and_HSV), sets the [brightness also known as "value"](https://en.wikipedia.org/wiki/Brightness) and converts it back into an RGB color.
+     *
+     * This is useful to quickly change the brightness of the color without changing hue or saturation, allowing for things like easy theming.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:SetBrightness
+     */
+    SetBrightness(self: Color, saturation: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSV color space](https://en.wikipedia.org/wiki/HSL_and_HSV), sets the [hue](https://en.wikipedia.org/wiki/Hue) and converts it back into an RGB color.
+     *
+     * This is useful to quickly change the hue of the color without changing saturation or luminance, allowing for things like easy theming.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:SetHue
+     */
+    SetHue(self: Color, hue: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSL color space](https://en.wikipedia.org/wiki/HSL_and_HSV), sets the ["lightness"](https://en.wikipedia.org/wiki/Lightness) and converts it back into an RGB color.
+     *
+     * This is useful to quickly change the lightness of the color without changing hue or saturation, allowing for things like easy theming.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:SetLightness
+     */
+    SetLightness(self: Color, lightness: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSV color space](https://en.wikipedia.org/wiki/HSL_and_HSV), sets the [saturation](https://en.wikipedia.org/wiki/Colorfulness) and converts it back into an RGB color.
+     *
+     * This is useful to quickly change the saturation of the color without changing hue or luminance, allowing for things like easy theming.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:SetSaturation
+     */
+    SetSaturation(self: Color, saturation: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HWB color space](https://en.wikipedia.org/wiki/HWB_color_model), sets the "whiteness" and converts it back into an RGB color.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:SetWhiteness
+     */
+    SetWhiteness(self: Color, whiteness: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HWB color space](https://en.wikipedia.org/wiki/HWB_color_model). See [Global.HWBToColor](https://wiki.facepunch.com/gmod/Global.HWBToColor) for more info.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/COLOR:ToHWB
+     */
+    ToHWB(self: Color): (number, number, number);
+}
+
+interface Color {
+    /**
+     * Returns a copy of this color, usually so it can be safely modified later without affecting the original color.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Color:Copy
+     */
+    Copy(self: Color): Color;
+}
+
+interface Color {
+    /**
+     * Performs linear interpolation between this and given colors.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Color:Lerp
+     */
+    Lerp(self: Color, target: Color, fraction: number): Color;
+}
+
+interface Color {
+    /**
+     * Sets the red, green, blue, and alpha of the color.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Color:SetUnpacked
+     */
+    SetUnpacked(self: Color, r: number, g: number, b: number, a: number): void;
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) into [HSL color space](https://en.wikipedia.org/wiki/HSL_and_HSV) .
+     *
+     * This calls [Global.ColorToHSL](https://wiki.facepunch.com/gmod/Global.ColorToHSL) internally.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Color:ToHSL
+     */
+    ToHSL(self: Color): (number, number, number);
+}
+
+interface Color {
+    /**
+     * 		Encodes a RGB [Color](https://wiki.facepunch.com/gmod/Color) into the [HSV color space](https://en.wikipedia.org/wiki/HSL_and_HSV).
+     *
+     * 		This function uses [Global.ColorToHSV](https://wiki.facepunch.com/gmod/Global.ColorToHSV) internally.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Color:ToHSV
+     */
+    ToHSV(self: Color): (number, number, number);
+}
+
+interface Color {
+    /**
+     * Converts a [Color](https://wiki.facepunch.com/gmod/Color) to its hexadecimal representation.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Color:ToHex
+     */
+    ToHex(self: Color, arg0?: boolean): string;
+}
+
+interface Color {
+    /**
+     * Returns the color as a table (an array or a list) with four elements.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Color:ToTable
+     */
+    ToTable(self: Color): number[];
+}
+
+interface Color {
+    /**
+     * Translates the [Color](https://wiki.facepunch.com/gmod/Color) into a [Vector](https://wiki.facepunch.com/gmod/Vector), losing the alpha channel.
+     * This will also range the values from 0 - 255 to 0 - 1
+     *
+     * r / 255 -> x
+     * g / 255 -> y
+     * b / 255 -> z
+     *
+     * This is the opposite of [Vector:ToColor](https://wiki.facepunch.com/gmod/Vector:ToColor)
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Color:ToVector
+     */
+    ToVector(self: Color): Vector;
+}
+
+interface Color {
+    /**
+     * Returns the red, green, blue, and alpha of the color.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Color:Unpack
+     */
+    Unpack(self: Color): (number, number, number, number);
+}
+

package/concommand.d.tlua

@@ -0,0 +1,69 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The concommand library is used to create console commands which can be used to network (basic) information & events between the client and the server.
+ * @source https://wiki.facepunch.com/gmod/concommand
+ */
+declare concommand: ConcommandLib;
+
+interface ConcommandLib {
+    /**
+     * Creates a console command that runs a function in lua with optional autocompletion function and help text.
+     *
+     * **WARNING**: Clients can still run commands created only on the server. Always check permissions in the callback.
+     *
+     * This will fail if the concommand was previously removed with [concommand.Remove](https://wiki.facepunch.com/gmod/concommand.Remove) in a different realm (creating a command on the client that was removed from the server and vice-versa).
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/concommand.Add
+     */
+    Add(name: string, callback: (ply: Player, cmd: string, args: table, argStr: string) => void, autoComplete?: (cmd: string, argStr: string, args: table) => table, helpText?: string, flags?: FCVAR | number[]): void;
+}
+
+interface ConcommandLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *  Used by the engine to call the autocomplete function for a console command, and retrieve returned options.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/concommand.AutoComplete
+     */
+    AutoComplete(command: string, arguments: string): table;
+}
+
+interface ConcommandLib {
+    /**
+     * Returns the tables of all console command callbacks, and autocomplete functions, that were added to the game with [concommand.Add](https://wiki.facepunch.com/gmod/concommand.Add).
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/concommand.GetTable
+     */
+    GetTable(): (Table<string, function>, Table<string, function>);
+}
+
+interface ConcommandLib {
+    /**
+     * Removes a console command.
+     *
+     * [concommand.Add](https://wiki.facepunch.com/gmod/concommand.Add) will fail if the concommand was previously removed with this function in a different realm (creating a command on the client that was removed from the server and vice-versa).
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/concommand.Remove
+     */
+    Remove(name: string): void;
+}
+
+interface ConcommandLib {
+    /**
+     * **INTERNAL**: You might be looking for [Global.RunConsoleCommand](https://wiki.facepunch.com/gmod/Global.RunConsoleCommand) or [Player:ConCommand](https://wiki.facepunch.com/gmod/Player:ConCommand).
+     *
+     *
+     * Used by the engine to run a console command's callback function. This will only be called for commands that were added with [Global.AddConsoleCommand](https://wiki.facepunch.com/gmod/Global.AddConsoleCommand), which [concommand.Add](https://wiki.facepunch.com/gmod/concommand.Add) calls internally. An error is sent to the player's console if no callback is found.
+     *
+     * This will still be called for concommands removed with [concommand.Remove](https://wiki.facepunch.com/gmod/concommand.Remove) but will return false. This will not be called for concommands added by the engine, only those made from Lua.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/concommand.Run
+     */
+    Run(ply: Player, cmd: string, args: any, argumentString: string): boolean;
+}
+