@tlua/gmod 1.0.1

package/controlpanel.d.tlua

@@ -0,0 +1,140 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/** Used by the context menu in sandbox. */
+interface ControlPanel extends DForm {
+    /**
+     * Adds a DLabel to the ControlPanel as a helper text. Functionally
+     * equivalent to DForm:Help.
+     * @realm client
+     */
+    Label(self: ControlPanel, text: string): DLabel;
+}
+
+/**
+ * The controlpanel library.
+ * @source https://wiki.facepunch.com/gmod/controlpanel(library)
+ */
+declare controlpanel: ControlpanelLib;
+
+interface ControlPanel {
+    /**
+     * Adds a control to the control panel.
+     * @realm client
+     * @deprecated It is recommended to use DForm's members instead.
+     * @source https://wiki.facepunch.com/gmod/ControlPanel:AddControl
+     */
+    AddControl(self: ControlPanel, type: "color", controlinfo: table): CtrlColor;
+    /**
+     * Adds a control to the control panel.
+     * @realm client
+     * @deprecated It is recommended to use DForm's members instead.
+     * @source https://wiki.facepunch.com/gmod/ControlPanel:AddControl
+     */
+    AddControl(self: ControlPanel, type: string, controlinfo: table): Panel;
+}
+
+
+interface ControlPanel {
+    /**
+     * Adds an item by calling [DForm:AddItem](https://wiki.facepunch.com/gmod/DForm:AddItem).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPanel:AddPanel
+     */
+    AddPanel(self: ControlPanel, panel: Panel): void;
+}
+
+interface ControlPanel {
+    /**
+     * Alias of [Panel:Clear](https://wiki.facepunch.com/gmod/Panel:Clear).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPanel:ClearControls
+     */
+    ClearControls(self: ControlPanel): void;
+}
+
+interface ControlPanel {
+    /**
+     * Creates a [CtrlColor](https://wiki.facepunch.com/gmod/CtrlColor) (a color picker) panel and adds it as an [item](https://wiki.facepunch.com/gmod/ControlPanel:AddPanel).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPanel:ColorPicker
+     */
+    ColorPicker(self: ControlPanel, label: string, convarR: string, convarG: string, convarB: string, convarA?: string): Panel;
+}
+
+interface ControlPanel {
+    /**
+     * Sets control values of the control panel.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPanel:ControlValues
+     */
+    ControlValues(self: ControlPanel, data: table): void;
+}
+
+interface ControlPanel {
+    /**
+     * Calls the given function with this panel as the only argument. Used by the spawnmenu to populate the control panel.
+     *
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPanel:FillViaFunction
+     * @deprecated This is dumb. Just call the builder function directly.
+     */
+    FillViaFunction(self: ControlPanel, func: (panelToPopulate: ControlPanel) => void): void;
+}
+
+interface ControlPanel {
+    /**
+     * Returns this control panel.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPanel:GetEmbeddedPanel
+     */
+    GetEmbeddedPanel(self: ControlPanel): ControlPanel;
+}
+
+interface ControlPanel {
+    /**
+     * Creates a CtrlNumPad (a Sandbox key binder) panel and adds it as an [item](https://wiki.facepunch.com/gmod/ControlPanel:AddPanel).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPanel:KeyBinder
+     */
+    KeyBinder(self: ControlPanel, label1: string, convar1: string, label2?: string, convar2?: string): Panel;
+}
+
+interface ControlPanel {
+    /**
+     * Creates a [MatSelect](https://wiki.facepunch.com/gmod/MatSelect) panel and adds it as an [item](https://wiki.facepunch.com/gmod/ControlPanel:AddPanel).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPanel:MatSelect
+     */
+    MatSelect(self: ControlPanel, convar: string, options?: table, autostretch?: boolean, width?: number, height?: number): MatSelect;
+}
+
+interface ControlPanel {
+    /**
+     * Creates a [ControlPresets](https://wiki.facepunch.com/gmod/ControlPresets) panel and adds it as an [item](https://wiki.facepunch.com/gmod/ControlPanel:AddPanel).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPanel:ToolPresets
+     */
+    ToolPresets(self: ControlPanel, group: string, cvarList: table): Panel;
+}
+
+interface ControlpanelLib {
+    /**
+     * Clears ALL the control panels ( for tools ).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/controlpanel.Clear
+     */
+    Clear(): void;
+}
+
+interface ControlpanelLib {
+    /**
+     * Returns (or creates if not exists) a control panel.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/controlpanel.Get
+     */
+    Get(name: string): ControlPanel;
+}
+
+

package/controlpresets.d.tlua

@@ -0,0 +1,118 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		A preset manager, found at the top of almost every default tool's C-menu.
+ *
+ * 		This control only exists in Sandbox derived gamemodes.
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/ControlPresets
+ */
+interface ControlPresets extends Panel {}
+
+interface ControlPresets {
+    /**
+     * Adds a convar to be managed by this control.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPresets:AddConVar
+     */
+    AddConVar(self: ControlPresets, convar: string): void;
+}
+
+interface ControlPresets {
+    /**
+     * Adds option to the [DComboBox](https://wiki.facepunch.com/gmod/DComboBox) subelement with [DComboBox:AddChoice](https://wiki.facepunch.com/gmod/DComboBox:AddChoice) then adds it to the `options` subtable
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPresets:AddOption
+     */
+    AddOption(self: ControlPresets, strName: string, data: any): void;
+}
+
+interface ControlPresets {
+    /**
+     * Get a list of all Console Variables being managed by this panel.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPresets:GetConVars
+     */
+    GetConVars(self: ControlPresets): table;
+}
+
+interface ControlPresets {
+    /**
+     * Checks if Data is valid then uses [Global.pairs](https://wiki.facepunch.com/gmod/Global.pairs) to iterate over the data parameter and run each entry using [Global.RunConsoleCommand](https://wiki.facepunch.com/gmod/Global.RunConsoleCommand)
+     * Index and Value parameters appear to not be used. Further testing should be done to confirm
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPresets:OnSelect
+     */
+    OnSelect(self: ControlPresets, index: number, value: any, data: table): void;
+}
+
+interface ControlPresets {
+    /**
+     * Creates and opens [PresetEditor](https://wiki.facepunch.com/gmod/PresetEditor)
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPresets:OpenPresetEditor
+     */
+    OpenPresetEditor(self: ControlPresets): void;
+}
+
+interface ControlPresets {
+    /**
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPresets:QuickSaveInternal
+     */
+    QuickSaveInternal(self: ControlPresets, text: string): void;
+}
+
+interface ControlPresets {
+    /**
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPresets:QuickSavePreset
+     */
+    QuickSavePreset(self: ControlPresets): void;
+}
+
+interface ControlPresets {
+    /**
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPresets:ReloadPresets
+     */
+    ReloadPresets(self: ControlPresets): void;
+}
+
+interface ControlPresets {
+    /**
+     * Set the name label text.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPresets:SetLabel
+     */
+    SetLabel(self: ControlPresets, name: string): void;
+}
+
+interface ControlPresets {
+    /**
+     * Uses [table.Merge](https://wiki.facepunch.com/gmod/table.Merge) to combine the provided table into the `Options` subtable
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPresets:SetOptions
+     */
+    SetOptions(self: ControlPresets, Options: table): void;
+}
+
+interface ControlPresets {
+    /**
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPresets:SetPreset
+     */
+    SetPreset(self: ControlPresets, strName: string): void;
+}
+
+interface ControlPresets {
+    /**
+     * Alias of [ControlPresets:ReloadPresets](https://wiki.facepunch.com/gmod/ControlPresets:ReloadPresets)
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ControlPresets:Update
+     */
+    Update(self: ControlPresets): void;
+}
+

package/convar.d.tlua

@@ -0,0 +1,162 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * An object returned by [Global.CreateConVar](https://wiki.facepunch.com/gmod/Global.CreateConVar), [Global.CreateClientConVar](https://wiki.facepunch.com/gmod/Global.CreateClientConVar) (which uses [Global.CreateConVar](https://wiki.facepunch.com/gmod/Global.CreateConVar) internally), and [Global.GetConVar](https://wiki.facepunch.com/gmod/Global.GetConVar).
+ *
+ * It represents a console variable. See [this](https://wiki.facepunch.com/gmod/ConVars) page for more information.
+ * @source https://wiki.facepunch.com/gmod/ConVar
+ */
+interface ConVar {}
+
+interface ConVar {
+    /**
+     * Tries to convert the current string value of a [ConVar](https://wiki.facepunch.com/gmod/ConVar) to a boolean.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ConVar:GetBool
+     */
+    GetBool(self: ConVar): boolean;
+}
+
+interface ConVar {
+    /**
+     * 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;
+}
+
+interface ConVar {
+    /**
+     * 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;
+}
+
+interface ConVar {
+    /**
+     * 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;
+}
+
+interface ConVar {
+    /**
+     * Returns the help text assigned to that convar.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ConVar:GetHelpText
+     */
+    GetHelpText(self: ConVar): string;
+}
+
+interface ConVar {
+    /**
+     * 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;
+}
+
+interface ConVar {
+    /**
+     * 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;
+}
+
+interface ConVar {
+    /**
+     * 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;
+}
+
+interface ConVar {
+    /**
+     * 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;
+}
+
+interface ConVar {
+    /**
+     * 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;
+}
+
+interface ConVar {
+    /**
+     * 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;
+}
+
+interface ConVar {
+    /**
+     * Reverts [ConVar](https://wiki.facepunch.com/gmod/ConVar) to its default value
+     *
+     * **NOTE**: This can only be ran on ConVars created from within Lua.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ConVar:Revert
+     */
+    Revert(self: ConVar): void;
+}
+
+interface ConVar {
+    /**
+     * 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;
+}
+
+interface ConVar {
+    /**
+     * Sets a ConVar's value to the input number.
+     * 	**NOTE**: This can only be ran on ConVars created from within Lua.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ConVar:SetFloat
+     */
+    SetFloat(self: ConVar, value: number): void;
+}
+
+interface ConVar {
+    /**
+     * Sets a ConVar's value to the input number after converting it to an integer.
+     *
+     * **NOTE**: This can only be ran on ConVars created from within Lua.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ConVar:SetInt
+     */
+    SetInt(self: ConVar, value: number): void;
+}
+
+interface ConVar {
+    /**
+     * Sets a ConVar's value to the input string. This can only be ran on ConVars created from within Lua.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ConVar:SetString
+     */
+    SetString(self: ConVar, value: string): void;
+}
+

package/cookie.d.tlua

@@ -0,0 +1,60 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		Functions to persist data on a user's computer.
+ *
+ * 		The data will be read / written to / from a database
+ * 		corresponding to the realm the library was used in.
+ *
+ * 		| Realm | Database File |
+ * 		|:-----:|:-----|
+ * 		| [Server](https://wiki.facepunch.com/gmod//gmod/States#server) | `garrysmod/sv.db`
+ * 		| [Client](https://wiki.facepunch.com/gmod//gmod/States#client) | `garrysmod/cl.db`
+ * 		| [Menu](https://wiki.facepunch.com/gmod//gmod/States#menu) | `garrysmod/mn.db`
+ *
+ * @source https://wiki.facepunch.com/gmod/cookie
+ */
+declare cookie: CookieLib;
+
+interface CookieLib {
+    /**
+     * 		Removes any cookie with the given name.
+     *
+     * 		Does nothing if the cookie doesn't exist.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/cookie.Delete
+     */
+    Delete(key: string): void;
+}
+
+interface CookieLib {
+    /**
+     * 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;
+}
+
+interface CookieLib {
+    /**
+     * 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;
+}
+
+interface CookieLib {
+    /**
+     * 		Creates / updates a cookie in the [Database](https://wiki.facepunch.com/gmod/cookie).
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/cookie.Set
+     */
+    Set(key: string, value: string): void;
+}
+

package/coroutine.d.tlua

@@ -0,0 +1,90 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Coroutines are similar to threads, however they do not run simultaneously. They offer a way to split up tasks and dynamically pause & resume functions.
+ * @source https://wiki.facepunch.com/gmod/coroutine
+ */
+interface CoroutineLib {
+    /**
+     * Creates a coroutine of the given function.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/coroutine.create
+     */
+    create(func: function): thread;
+}
+
+interface CoroutineLib {
+    /**
+     * 		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.
+     * 		**NOTE**: This is only available on the x86-64 versions, because of the difference in the LuaJIT version. [See here](https://wiki.facepunch.com/gmod/jit.version)
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/coroutine.isyieldable
+     */
+    isyieldable(): boolean;
+}
+
+interface CoroutineLib {
+    /**
+     * 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);
+}
+
+interface CoroutineLib {
+    /**
+     * 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;
+}
+
+interface CoroutineLib {
+    /**
+     * 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;
+}
+
+interface CoroutineLib {
+    /**
+     * Repeatedly yields the coroutine for the given duration before continuing.
+     *
+     * Only works inside a coroutine. Only useful in nextbot coroutine think function.
+     *
+     * This function uses [Global.CurTime](https://wiki.facepunch.com/gmod/Global.CurTime) instead of [Global.RealTime](https://wiki.facepunch.com/gmod/Global.RealTime).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/coroutine.wait
+     */
+    wait(duration: number): void;
+}
+
+interface CoroutineLib {
+    /**
+     * 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.
+     *
+     * The values returned by the returned function only contain the values passed to the inner [coroutine.yield](https://wiki.facepunch.com/gmod/coroutine.yield) call and do not include the *no error* status that [coroutine.resume](https://wiki.facepunch.com/gmod/coroutine.resume) provides. In case of failure, an error is thrown instead.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/coroutine.wrap
+     */
+    wrap(coroutine: function): function;
+}
+
+interface CoroutineLib {
+    /**
+     * 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
+     * @source https://wiki.facepunch.com/gmod/coroutine.yield
+     */
+    yield(...: any): (...any);
+}
+