@tlua/gmod 1.0.1

package/dmenu.d.tlua

@@ -0,0 +1,266 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * A simple menu with sub menu, icon and convar support.
+ * @realm client and menu
+ * @source https://wiki.facepunch.com/gmod/DMenu
+ */
+interface DMenu extends DScrollPanel {}
+
+interface DMenu {
+    /**
+     * Creates a [DMenuOptionCVar](https://wiki.facepunch.com/gmod/DMenuOptionCVar) and adds it as an option into the menu. Checking and unchecking the option will alter the given console variable's value.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:AddCVar
+     */
+    AddCVar(self: DMenu, strText: string, convar: string, on: string, off: string, funcFunction?: (pnl: Panel) => void): Panel;
+}
+
+interface DMenu {
+    /**
+     * Add an option to the DMenu.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:AddOption
+     */
+    AddOption(self: DMenu, name: string, func?: function): DMenuOption;
+}
+
+
+interface DMenu {
+    /**
+     * Adds a panel to the DMenu as if it were an option. This invokes
+     * DScrollPanel:AddItem and will not create a new panel if a class name is
+     * passed, unlike Panel:Add.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:AddPanel
+     */
+    AddPanel<T extends Panel>(self: DMenu, pnl: T): void;
+}
+
+
+interface DMenu {
+    /**
+     * Adds a horizontal line spacer.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:AddSpacer
+     */
+    AddSpacer(self: DMenu): void;
+}
+
+interface DMenu {
+    /**
+     * Add a sub menu to the DMenu.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:AddSubMenu
+     */
+    AddSubMenu(self: DMenu, Name: string, func?: function): (DMenu, DMenuOption);
+}
+
+
+interface DMenu {
+    /**
+     * Clears all highlights made by [DMenu:HighlightItem](https://wiki.facepunch.com/gmod/DMenu:HighlightItem).
+     *
+     * Doesn't appear to be used or do anything.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:ClearHighlights
+     */
+    ClearHighlights(self: DMenu): void;
+}
+
+interface DMenu {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Used internally by [DMenu:OpenSubMenu](https://wiki.facepunch.com/gmod/DMenu:OpenSubMenu).
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:CloseSubMenu
+     */
+    CloseSubMenu(self: DMenu, menu: Panel): void;
+}
+
+interface DMenu {
+    /**
+     * Set by [DMenu:SetDeleteSelf](https://wiki.facepunch.com/gmod/DMenu:SetDeleteSelf)
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:GetDeleteSelf
+     */
+    GetDeleteSelf(self: DMenu): boolean;
+}
+
+interface DMenu {
+    /**
+     * Returns the value set by [DMenu:SetDrawBorder](https://wiki.facepunch.com/gmod/DMenu:SetDrawBorder).
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:GetDrawBorder
+     */
+    GetDrawBorder(self: DMenu): boolean;
+}
+
+interface DMenu {
+    /**
+     * Returns whether the [DMenu](https://wiki.facepunch.com/gmod/DMenu) should draw the icon column with a different color or not.
+     *
+     * See [DMenu:SetDrawColumn](https://wiki.facepunch.com/gmod/DMenu:SetDrawColumn)
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:GetDrawColumn
+     */
+    GetDrawColumn(self: DMenu): boolean;
+}
+
+interface DMenu {
+    /**
+     * Returns the maximum height of the [DMenu](https://wiki.facepunch.com/gmod/DMenu).
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:GetMaxHeight
+     */
+    GetMaxHeight(self: DMenu): number;
+}
+
+interface DMenu {
+    /**
+     * Returns the minimum width of the [DMenu](https://wiki.facepunch.com/gmod/DMenu) in pixels
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:GetMinimumWidth
+     */
+    GetMinimumWidth(self: DMenu): number;
+}
+
+interface DMenu {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Returns the currently opened submenu.
+     *
+     * Used internally to store the open submenu by [DMenu:Hide](https://wiki.facepunch.com/gmod/DMenu:Hide), [DMenu:OpenSubMenu](https://wiki.facepunch.com/gmod/DMenu:OpenSubMenu).
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:GetOpenSubMenu
+     */
+    GetOpenSubMenu(self: DMenu): Panel;
+}
+
+interface DMenu {
+    /**
+     * Highlights selected item in the [DMenu](https://wiki.facepunch.com/gmod/DMenu) by setting the item's key "Highlight" to true.
+     *
+     * Doesn't appear to be working or used.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:HighlightItem
+     */
+    HighlightItem(self: DMenu, item: Panel): void;
+}
+
+interface DMenu {
+    /**
+     * Opens the [DMenu](https://wiki.facepunch.com/gmod/DMenu) at given position.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:Open
+     */
+    Open(self: DMenu, x?: number, y?: number, skipanimation?: any, ownerpanel?: Panel): void;
+}
+
+interface DMenu {
+    /**
+     * Closes any active sub menus, and opens a new one.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:OpenSubMenu
+     */
+    OpenSubMenu(self: DMenu, item: Panel, menu?: Panel): void;
+}
+
+interface DMenu {
+    /**
+     * Called when a option has been selected
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:OptionSelected
+     */
+    OptionSelected(self: DMenu, option: Panel, optionText: string): void;
+}
+
+interface DMenu {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Called by [DMenuOption](https://wiki.facepunch.com/gmod/DMenuOption). Calls [DMenu:OptionSelected](https://wiki.facepunch.com/gmod/DMenu:OptionSelected).
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:OptionSelectedInternal
+     */
+    OptionSelectedInternal(self: DMenu, option: Panel): void;
+}
+
+interface DMenu {
+    /**
+     * Set to true by default. IF set to true, the menu will be deleted when it is closed, not simply hidden.
+     *
+     * This is used by [DMenuBar](https://wiki.facepunch.com/gmod/DMenuBar)
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:SetDeleteSelf
+     */
+    SetDeleteSelf(self: DMenu, newState: boolean): void;
+}
+
+interface DMenu {
+    /**
+     * Does nothing.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:SetDrawBorder
+     */
+    SetDrawBorder(self: DMenu, bool: boolean): void;
+}
+
+interface DMenu {
+    /**
+     * Sets whether the [DMenu](https://wiki.facepunch.com/gmod/DMenu) should draw the icon column with a different color.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:SetDrawColumn
+     */
+    SetDrawColumn(self: DMenu, draw: boolean): void;
+}
+
+interface DMenu {
+    /**
+     * Sets the maximum height the [DMenu](https://wiki.facepunch.com/gmod/DMenu) can have. If the height of all menu items exceed this value, a scroll bar will be automatically added.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:SetMaxHeight
+     */
+    SetMaxHeight(self: DMenu, maxHeight: number): void;
+}
+
+interface DMenu {
+    /**
+     * Sets the minimum width of the [DMenu](https://wiki.facepunch.com/gmod/DMenu). The menu will be stretched to match the given value.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:SetMinimumWidth
+     */
+    SetMinimumWidth(self: DMenu, minWidth: number): void;
+}
+
+interface DMenu {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Used internally to store the open submenu by [DMenu:Hide](https://wiki.facepunch.com/gmod/DMenu:Hide), [DMenu:OpenSubMenu](https://wiki.facepunch.com/gmod/DMenu:OpenSubMenu), [DMenu:CloseSubMenu](https://wiki.facepunch.com/gmod/DMenu:CloseSubMenu)
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenu:SetOpenSubMenu
+     */
+    SetOpenSubMenu(self: DMenu, item: Panel): void;
+}
+

package/dmenubar.d.tlua

@@ -0,0 +1,42 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * A simple menu bar.
+ * @realm client and menu
+ * @source https://wiki.facepunch.com/gmod/DMenuBar
+ */
+interface DMenuBar extends DPanel {}
+
+interface DMenuBar {
+    /**
+     * Creates a new menu panel on the menu bar.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/DMenuBar:AddMenu
+     */
+    AddMenu(self: DMenuBar, label: string): DMenu;
+}
+
+
+interface DMenuBar {
+    /**
+     * Retrieves or creates a menu panel on the menu bar.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/DMenuBar:AddOrGetMenu
+     */
+    AddOrGetMenu(self: DMenuBar, label: string): DMenu;
+}
+
+
+interface DMenuBar {
+    /**
+     * Returns the currently opened menu, if any.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/DMenuBar:GetOpenMenu
+     */
+    GetOpenMenu(self: DMenuBar): DMenu | nil;
+}
+
+

package/dmenuoption.d.tlua

@@ -0,0 +1,135 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		**INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+ *
+ *
+ * 		Internal subpanel that represents an option used by [DMenu](https://wiki.facepunch.com/gmod/DMenu).
+ *
+ * @realm client and menu
+ * @source https://wiki.facepunch.com/gmod/DMenuOption
+ */
+interface DMenuOption extends DButton {}
+
+interface DMenuOption {
+    /**
+     * Creates a sub [DMenu](https://wiki.facepunch.com/gmod/DMenu) and returns it. Has no duplicate call protection.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenuOption:AddSubMenu
+     */
+    AddSubMenu(self: DMenuOption): Panel;
+}
+
+interface DMenuOption {
+    /**
+     * Returns the checked state of [DMenuOption](https://wiki.facepunch.com/gmod/DMenuOption).
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenuOption:GetChecked
+     */
+    GetChecked(self: DMenuOption): boolean;
+}
+
+interface DMenuOption {
+    /**
+     * Returns whether the [DMenuOption](https://wiki.facepunch.com/gmod/DMenuOption) is a checkbox option or a normal button option.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenuOption:GetIsCheckable
+     */
+    GetIsCheckable(self: DMenuOption): boolean;
+}
+
+interface DMenuOption {
+    /**
+     * Returns which [DMenu](https://wiki.facepunch.com/gmod/DMenu) this option belongs.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenuOption:GetMenu
+     */
+    GetMenu(self: DMenuOption): Panel;
+}
+
+interface DMenuOption {
+    /**
+     * Returns whether this [DMenuOption](https://wiki.facepunch.com/gmod/DMenuOption) should act like a radio button, set by [DMenuOption:SetRadio](https://wiki.facepunch.com/gmod/DMenuOption:SetRadio).
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenuOption:GetRadio
+     */
+    GetRadio(self: DMenuOption): boolean;
+}
+
+interface DMenuOption {
+    /**
+     * Called whenever the [DMenuOption](https://wiki.facepunch.com/gmod/DMenuOption)'s checked state changes.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenuOption:OnChecked
+     */
+    OnChecked(self: DMenuOption, checked: boolean): void;
+}
+
+interface DMenuOption {
+    /**
+     * Sets the checked state of the [DMenuOption](https://wiki.facepunch.com/gmod/DMenuOption).
+     *
+     * Invokes [DMenuOption:OnChecked](https://wiki.facepunch.com/gmod/DMenuOption:OnChecked).
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenuOption:SetChecked
+     */
+    SetChecked(self: DMenuOption, checked: boolean): void;
+}
+
+interface DMenuOption {
+    /**
+     * Sets whether the [DMenuOption](https://wiki.facepunch.com/gmod/DMenuOption) is a checkbox option or a normal button option.
+     *
+     * Enables automatic [DMenuOption:GetChecked](https://wiki.facepunch.com/gmod/DMenuOption:GetChecked) toggling with left/right clicks.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenuOption:SetIsCheckable
+     */
+    SetIsCheckable(self: DMenuOption, checkable: boolean): void;
+}
+
+interface DMenuOption {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Used to set the [DMenu](https://wiki.facepunch.com/gmod/DMenu) for this option.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenuOption:SetMenu
+     */
+    SetMenu(self: DMenuOption, pnl: Panel): void;
+}
+
+interface DMenuOption {
+    /**
+     * Sets whether this [DMenuOption](https://wiki.facepunch.com/gmod/DMenuOption) should act like a radio button.
+     *
+     * Checking a radio button automatically unchecks all adjacent radio buttons.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenuOption:SetRadio
+     */
+    SetRadio(self: DMenuOption, checked: boolean): void;
+}
+
+interface DMenuOption {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Used internally by [DMenuOption:AddSubMenu](https://wiki.facepunch.com/gmod/DMenuOption:AddSubMenu) to create the submenu arrow and assign the created submenu to be opened when this option is hovered.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenuOption:SetSubMenu
+     */
+    SetSubMenu(self: DMenuOption, menu: Panel): void;
+}
+
+interface DMenuOption {
+    /**
+     * Toggles the checked state of [DMenuOption](https://wiki.facepunch.com/gmod/DMenuOption). Does not respect [DMenuOption:GetIsCheckable](https://wiki.facepunch.com/gmod/DMenuOption:GetIsCheckable).
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DMenuOption:ToggleCheck
+     */
+    ToggleCheck(self: DMenuOption): void;
+}
+

package/dmenuoptioncvar.d.tlua

@@ -0,0 +1,64 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		**INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+ *
+ *
+ * 		An internal panel used by [DMenu](https://wiki.facepunch.com/gmod/DMenu).
+ * 		It acts as a menu option that can be checked.
+ * 		It automatically sets and reads the given console variable.
+ *
+ * 		It can be right clicked to toggle without closing the [DMenu](https://wiki.facepunch.com/gmod/DMenu).
+ *
+ * 		Use [DMenu:AddCVar](https://wiki.facepunch.com/gmod/DMenu:AddCVar) instead.
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/DMenuOptionCVar
+ */
+interface DMenuOptionCVar extends DMenuOption {}
+
+interface DMenuOptionCVar {
+    /**
+     * Returns the [console variable](https://wiki.facepunch.com/gmod/ConVars) used by the [DMenuOptionCVar](https://wiki.facepunch.com/gmod/DMenuOptionCVar).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/DMenuOptionCVar:GetConVar
+     */
+    GetConVar(self: DMenuOptionCVar): string;
+}
+
+interface DMenuOptionCVar {
+    /**
+     * Returns the value of the [console variable](https://wiki.facepunch.com/gmod/ConVars) when the [DMenuOptionCVar](https://wiki.facepunch.com/gmod/DMenuOptionCVar) is not checked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/DMenuOptionCVar:GetValueOff
+     */
+    GetValueOff(self: DMenuOptionCVar): string;
+}
+
+interface DMenuOptionCVar {
+    /**
+     * Return the value of the [console variable](https://wiki.facepunch.com/gmod/ConVars) when the [DMenuOptionCVar](https://wiki.facepunch.com/gmod/DMenuOptionCVar) is checked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/DMenuOptionCVar:GetValueOn
+     */
+    GetValueOn(self: DMenuOptionCVar): string;
+}
+
+interface DMenuOptionCVar {
+    /**
+     * Sets the value of the [console variable](https://wiki.facepunch.com/gmod/ConVars) when the [DMenuOptionCVar](https://wiki.facepunch.com/gmod/DMenuOptionCVar) is not checked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/DMenuOptionCVar:SetValueOff
+     */
+    SetValueOff(self: DMenuOptionCVar, value: string): void;
+}
+
+interface DMenuOptionCVar {
+    /**
+     * Sets the value of the [console variable](https://wiki.facepunch.com/gmod/ConVars) when the [DMenuOptionCVar](https://wiki.facepunch.com/gmod/DMenuOptionCVar) is checked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/DMenuOptionCVar:SetValueOn
+     */
+    SetValueOn(self: DMenuOptionCVar, value: string): void;
+}
+