@tlua/gmod 1.0.1

package/draw.d.tlua

@@ -0,0 +1,162 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The draw library's purpose is to simplify the usage of the [surface](https://wiki.facepunch.com/gmod/surface) library.
+ * @source https://wiki.facepunch.com/gmod/draw
+ */
+declare draw: DrawLib;
+
+interface DrawLib {
+    /**
+     * Simple draw text at position, but this will expand newlines and tabs.
+     *
+     *
+     *
+     * See also [MarkupObject](https://wiki.facepunch.com/gmod/MarkupObject) for limited width and markup support.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/draw.DrawText
+     */
+    DrawText(text: string, font?: string, x?: number, y?: number, color?: Color, xAlign?: number): void;
+}
+
+interface DrawLib {
+    /**
+     * Returns the height of the specified font in pixels. This is equivalent to the height of the character `W`. See [surface.GetTextSize](https://wiki.facepunch.com/gmod/surface.GetTextSize).
+     *
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/draw.GetFontHeight
+     */
+    GetFontHeight(font: string): number;
+}
+
+interface DrawLib {
+    /**
+     * Sets drawing texture to a default white texture (vgui/white) via [surface.SetMaterial](https://wiki.facepunch.com/gmod/surface.SetMaterial). Useful for resetting the drawing texture.
+     *
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/draw.NoTexture
+     */
+    NoTexture(): void;
+}
+
+interface DrawLib {
+    /**
+     * Draws a rounded rectangle.
+     *
+     * **NOTE**: This function actually draws rectangles with 'gui/cornerX' textures applied to it's rounded corners. It means that this function will fail (or will be drawn not as expected) with any vertex operations, such as model matrices like [cam.Start3D2D](https://wiki.facepunch.com/gmod/cam.Start3D2D) (corners would be pixelated) or stencil operations. Consider using [surface.DrawPoly](https://wiki.facepunch.com/gmod/surface.DrawPoly) or [mesh](https://wiki.facepunch.com/gmod/mesh) library
+     *
+     *
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/draw.RoundedBox
+     */
+    RoundedBox(cornerRadius: number, x: number, y: number, width: number, height: number, color: Color): void;
+}
+
+interface DrawLib {
+    /**
+     * Draws a rounded rectangle. This function also lets you specify which corners are drawn rounded.
+     *
+     *
+     * **NOTE**: This function actually draws rectangles with 'gui/cornerX' textures applied to it's rounded corners. It means that this function will fail (or will be drawn not as expected) with any vertex operations, such as model matrices like [cam.Start3D2D](https://wiki.facepunch.com/gmod/cam.Start3D2D) (corners would be pixelated) or stencil operations. Consider using [surface.DrawPoly](https://wiki.facepunch.com/gmod/surface.DrawPoly) or [mesh](https://wiki.facepunch.com/gmod/mesh) library
+     *
+     *
+     *
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/draw.RoundedBoxEx
+     */
+    RoundedBoxEx(cornerRadius: number, x: number, y: number, width: number, height: number, color: Color, roundTopLeft?: boolean, roundTopRight?: boolean, roundBottomLeft?: boolean, roundBottomRight?: boolean): void;
+}
+
+interface DrawLib {
+    /**
+     * Draws text on the screen.
+     *
+     * NOTE: This function does not handle newlines properly. See draw.DrawText
+     * for a function that does.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/draw.SimpleText
+     */
+    SimpleText(text: any, font?: string, x?: number, y?: number, color?: table, xAlign?: number, yAlign?: number): (number, number);
+    /**
+     * Creates a simple line of text that is outlined.
+     *
+     * NOTE: `outlinewidth` is required by the wiki but is typed as optional here
+     * because a required parameter cannot follow optional parameters.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/draw.SimpleTextOutlined
+     */
+    SimpleTextOutlined(Text: any, font?: string, x?: number, y?: number, color?: table, xAlign?: number, yAlign?: number, outlinewidth?: number, outlinecolor?: table): (number, number);
+}
+
+
+interface DrawLib {
+    /**
+     * Creates a simple line of text that is outlined.
+     *
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/draw.SimpleTextOutlined
+     */
+    SimpleTextOutlined(Text: string, font?: string, x?: number, y?: number, color?: Color, xAlign?: number, yAlign?: number, outlinewidth?: number, outlinecolor?: Color): (number, number);
+}
+
+interface DrawLib {
+    /**
+     * Works like [draw.SimpleText](https://wiki.facepunch.com/gmod/draw.SimpleText) but uses a table structure instead.
+     *
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/draw.Text
+     */
+    Text(textdata: TextData): (number, number);
+}
+
+interface DrawLib {
+    /**
+     * Works like [draw.Text](https://wiki.facepunch.com/gmod/draw.Text), but draws the text with a shadow.
+     *
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/draw.TextShadow
+     */
+    TextShadow(textdata: TextData, distance: number, alpha?: number): (number, number);
+}
+
+interface DrawLib {
+    /**
+     * Draws a texture with a table structure.
+     *
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/draw.TexturedQuad
+     */
+    TexturedQuad(texturedata: TextureData): void;
+}
+
+interface DrawLib {
+    /**
+     * Draws a rounded box with text in it.
+     *
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/draw.WordBox
+     */
+    WordBox(bordersize: number, x: number, y: number, text: string, font: string, boxcolor: Color, textcolor: Color, xalign?: number, yalign?: number): (number, number);
+}
+

package/drgbpicker.d.tlua

@@ -0,0 +1,49 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * DRGBPicker is an interactive panel which can be used to select a color hue.
+ *
+ * See [DColorCube](https://wiki.facepunch.com/gmod/DColorCube) for a color picker which controls brightness and saturation.
+ *
+ * See [DColorMixer](https://wiki.facepunch.com/gmod/DColorMixer) for a color picker that allows control over hue, saturation, and brightness at once.
+ *
+ * @realm client and menu
+ * @source https://wiki.facepunch.com/gmod/DRGBPicker
+ */
+interface DRGBPicker extends DPanel {}
+
+interface DRGBPicker {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Returns the color at given position on the internal texture.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DRGBPicker:GetPosColor
+     */
+    GetPosColor(self: DRGBPicker, x: number, y: number): (Color, number, number);
+}
+
+interface DRGBPicker {
+    /**
+     * Returns the color currently set on the color picker.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DRGBPicker:GetRGB
+     */
+    GetRGB(self: DRGBPicker): Color;
+}
+
+interface DRGBPicker {
+    /**
+     * Sets the color stored in the color picker.
+     *
+     * **NOTE**: This function is meant to be called internally and will not update the position of the color picker line or call [DRGBPicker:OnChange](https://wiki.facepunch.com/gmod/DRGBPicker:OnChange)
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DRGBPicker:SetRGB
+     */
+    SetRGB(self: DRGBPicker, color: Color): void;
+}
+

package/drive.d.tlua

@@ -0,0 +1,159 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Represents a drive mode or "method" to be registered with [drive.Register](https://wiki.facepunch.com/gmod/drive.Register).
+ *
+ * This page lists all possible fields and hooks a drive mode can have.
+ *
+ * @source https://wiki.facepunch.com/gmod/DRIVE_Hooks
+ */
+interface DRIVE {}
+
+/**
+ * The drive library is for adding custom control modes to the new "remote control" entity piloting system in Garry's Mod 13. See [Entity Driving](https://wiki.facepunch.com/gmod/Entity_Driving).
+ * @source https://wiki.facepunch.com/gmod/drive
+ */
+declare drive: DriveLib;
+
+interface DRIVE {
+    /**
+     * Optionally alter the player's view if they are using this [drive](https://wiki.facepunch.com/gmod/drive) mode.
+     *
+     * This hook is called from the default implementation of [GM:CalcView](https://wiki.facepunch.com/gmod/GM:CalcView) which is [here](https://github.com/Facepunch/garrysmod/blob/master/garrysmod/gamemodes/base/gamemode/cl_init.lua#L387-L395). Therefore, it will not be called if any other hook added to `CalcView` returns any value, or if the current gamemode overrides the default hook and does not call [drive.CalcView](https://wiki.facepunch.com/gmod/drive.CalcView).
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/DRIVE:CalcView
+     */
+    CalcView(self: DRIVE, view_in: CamData): void;
+}
+
+interface DriveLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Used internally to make [DRIVE:CalcView](https://wiki.facepunch.com/gmod/DRIVE:CalcView) work, called by default from `base` gamemode's [GM:CalcView](https://wiki.facepunch.com/gmod/GM:CalcView) hook.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/drive.CalcView
+     */
+    CalcView(ply: Player, view: ViewData): boolean;
+}
+
+interface DriveLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     * Clientside, the client creates the cmd (usercommand) from their input device (mouse, keyboard) and then it's sent to the server. Restrict view angles here.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/drive.CreateMove
+     */
+    CreateMove(cmd: CUserCmd): boolean;
+}
+
+interface DriveLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     * Destroys players current driving method.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/drive.DestroyMethod
+     */
+    DestroyMethod(ply: Player): void;
+}
+
+interface DriveLib {
+    /**
+     * Player has stopped driving the entity.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/drive.End
+     */
+    End(ply: Player, ent: Entity): void;
+}
+
+interface DriveLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     * The move is finished. Copy mv back into the target.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/drive.FinishMove
+     */
+    FinishMove(ply: Player, mv: CMoveData): boolean;
+}
+
+interface DriveLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     * Returns ( or creates if inexistent ) a driving method.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/drive.GetMethod
+     */
+    GetMethod(ply: Player): table;
+}
+
+interface DriveLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     * The move is executed here.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/drive.Move
+     */
+    Move(ply: Player, mv: CMoveData): boolean;
+}
+
+interface DriveLib {
+    /**
+     * Starts driving for the player.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/drive.PlayerStartDriving
+     */
+    PlayerStartDriving(ply: Player, ent: Entity, mode: string): void;
+}
+
+interface DriveLib {
+    /**
+     * Stops the player from driving anything. ( For example a prop in sandbox )
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/drive.PlayerStopDriving
+     */
+    PlayerStopDriving(ply: Player): void;
+}
+
+interface DriveLib {
+    /**
+     * Registers a new entity drive mode/method.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/drive.Register
+     */
+    Register(name: string, data: table, base?: string): void;
+}
+
+interface DriveLib {
+    /**
+     * Called when the player first starts driving this entity.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/drive.Start
+     */
+    Start(ply: Player, ent: Entity): void;
+}
+
+interface DriveLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     * The user command is received by the server and then converted into a move. This is also run clientside when in multiplayer, for prediction to work.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/drive.StartMove
+     */
+    StartMove(ply: Player, mv: CMoveData, cmd: CUserCmd): boolean;
+}
+

package/dscrollbargrip.d.tlua

@@ -0,0 +1,13 @@
+// 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 [DVScrollBar](https://wiki.facepunch.com/gmod/DVScrollBar) as the grip (middle) part of the scrollbar.
+ *
+ * @realm client and menu
+ * @source https://wiki.facepunch.com/gmod/DScrollBarGrip
+ */
+interface DScrollBarGrip extends DPanel {}
+

package/dscrollpanel.d.tlua

@@ -0,0 +1,110 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+interface DScrollPanel extends DPanel {
+    /** The canvas panel that contains all child elements. Accessible via DScrollPanel:GetCanvas. */
+    pnlCanvas: Panel;
+    /** The vertical scroll bar. */
+    VBar: DVScrollBar;
+}
+
+interface DScrollPanel {
+    /**
+     * Parents the passed panel to the DScrollPanel's canvas.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DScrollPanel:AddItem
+     */
+    AddItem(self: DScrollPanel, pnl: Panel): void;
+}
+
+interface DScrollPanel {
+    /**
+     * Returns the canvas ( The panel all child panels are parented to ) of the DScrollPanel.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DScrollPanel:GetCanvas
+     */
+    GetCanvas(self: DScrollPanel): Panel;
+}
+
+interface DScrollPanel {
+    /**
+     * Gets the [DScrollPanel](https://wiki.facepunch.com/gmod/DScrollPanel)s padding, set by [DScrollPanel:SetPadding](https://wiki.facepunch.com/gmod/DScrollPanel:SetPadding).
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DScrollPanel:GetPadding
+     */
+    GetPadding(self: DScrollPanel): number;
+}
+
+interface DScrollPanel {
+    /**
+     * Returns the vertical scroll bar of the panel.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DScrollPanel:GetVBar
+     */
+    GetVBar(self: DScrollPanel): DVScrollBar;
+}
+
+interface DScrollPanel {
+    /**
+     * Return the width of the DScrollPanel's canvas.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DScrollPanel:InnerWidth
+     */
+    InnerWidth(self: DScrollPanel): number;
+}
+
+interface DScrollPanel {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Used internally to rebuild the panel's children positioning. You should use [Panel:InvalidateLayout](https://wiki.facepunch.com/gmod/Panel:InvalidateLayout) instead.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DScrollPanel:PerformLayoutInternal
+     */
+    PerformLayoutInternal(self: DScrollPanel): void;
+}
+
+interface DScrollPanel {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Used internally to rebuild the panel's children positioning. You should use [Panel:InvalidateLayout](https://wiki.facepunch.com/gmod/Panel:InvalidateLayout) instead.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DScrollPanel:Rebuild
+     */
+    Rebuild(self: DScrollPanel): void;
+}
+
+interface DScrollPanel {
+    /**
+     * Scrolls to the given child
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DScrollPanel:ScrollToChild
+     */
+    ScrollToChild(self: DScrollPanel, panel: Panel): void;
+}
+
+interface DScrollPanel {
+    /**
+     * 		**INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     * 		Sets the canvas of the DScrollPanel.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DScrollPanel:SetCanvas
+     */
+    SetCanvas(self: DScrollPanel, canvas: Panel): void;
+}
+
+interface DScrollPanel {
+    /**
+     * Sets the DScrollPanel's padding. This function appears to be unused.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DScrollPanel:SetPadding
+     */
+    SetPadding(self: DScrollPanel, padding: number): void;
+}
+

package/dshape.d.tlua

@@ -0,0 +1,72 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Draw a shape on a derma panel. Only one kind of shape, a rectangle, is available for use.
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/DShape
+ */
+interface DShape extends DPanel {}
+
+interface DShape {
+    /**
+     * Returns the current type of shape this panel is set to display.
+     *
+     * See [DShape:SetBorderColor](https://wiki.facepunch.com/gmod/DShape:SetBorderColor).
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/DShape:GetBorderColor
+     */
+    GetBorderColor(self: DShape): Color;
+}
+
+interface DShape {
+    /**
+     * Returns the color set to display the shape with.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/DShape:GetColor
+     */
+    GetColor(self: DShape): Color;
+}
+
+interface DShape {
+    /**
+     * Returns the current type of shape this panel is set to display.
+     *
+     * See [DShape:SetType](https://wiki.facepunch.com/gmod/DShape:SetType).
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/DShape:GetType
+     */
+    GetType(self: DShape): string;
+}
+
+interface DShape {
+    /**
+     * Sets the border color of the shape.
+     *
+     * Currently does nothing.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/DShape:SetBorderColor
+     */
+    SetBorderColor(self: DShape, clr: Color): void;
+}
+
+interface DShape {
+    /**
+     * Sets the color to display the shape with.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/DShape:SetColor
+     */
+    SetColor(self: DShape, clr: Color): void;
+}
+
+interface DShape {
+    /**
+     * Sets the shape to be drawn.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/DShape:SetType
+     */
+    SetType(self: DShape, type: string): void;
+}
+

package/dsizetocontents.d.tlua

@@ -0,0 +1,46 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		A helper panel that will automatically resize itself to fit all its children using [Panel:SizeToChildren](https://wiki.facepunch.com/gmod/Panel:SizeToChildren).
+ *
+ * @realm client and menu
+ * @source https://wiki.facepunch.com/gmod/DSizeToContents
+ */
+interface DSizeToContents extends Panel {}
+
+interface DSizeToContents {
+    /**
+     * Returns whether the [DSizeToContents](https://wiki.facepunch.com/gmod/DSizeToContents) panel should size to contents horizontally.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DSizeToContents:GetSizeX
+     */
+    GetSizeX(self: DSizeToContents): boolean;
+}
+
+interface DSizeToContents {
+    /**
+     * Returns whether the [DSizeToContents](https://wiki.facepunch.com/gmod/DSizeToContents) panel should size to contents vertically.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DSizeToContents:GetSizeY
+     */
+    GetSizeY(self: DSizeToContents): boolean;
+}
+
+interface DSizeToContents {
+    /**
+     * Sets whether the [DSizeToContents](https://wiki.facepunch.com/gmod/DSizeToContents) panel should size to contents horizontally. This is `true` by default.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DSizeToContents:SetSizeX
+     */
+    SetSizeX(self: DSizeToContents, sizeX: boolean): void;
+}
+
+interface DSizeToContents {
+    /**
+     * Sets whether the [DSizeToContents](https://wiki.facepunch.com/gmod/DSizeToContents) panel should size to contents vertically. This is `true` by default.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/DSizeToContents:SetSizeY
+     */
+    SetSizeY(self: DSizeToContents, sizeY: boolean): void;
+}
+