@tlua/gmod 1.0.1

package/matproxy.d.tlua

@@ -0,0 +1,60 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * A library that allows implementing custom [material proxies](https://developer.valvesoftware.com/wiki/Material_proxies) for materials.
+ *
+ * Material proxies allow programmatically setting specific `.vmt` shader parameters on a per-entity basis, rather being global across all instances of a material.
+ *
+ * You can find a tutorial for making colourable textures over at this [GitHub wiki](https://github.com/fgrg2801/gmod-colorable-playermodels/wiki)
+ *
+ * @source https://wiki.facepunch.com/gmod/matproxy
+ */
+declare matproxy: MatproxyLib;
+
+interface MatproxyLib {
+    /**
+     * 		Register a material proxy. See [matproxy](https://wiki.facepunch.com/gmod/matproxy) for more general explanation of what they are.
+     * 		**NOTE**: The `bind` function is required. The `init` function won't run without it set.
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/matproxy.Add
+     */
+    Add(matProxyData: MatProxyData): void;
+}
+
+interface MatproxyLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     * Called by the engine from `OnBind`. Calls [bind](https://wiki.facepunch.com/gmod/Structures/MatProxyData#bind) method of the Lua material proxy.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/matproxy.Call
+     */
+    Call(uname: string, mat: IMaterial, ent: Entity): void;
+}
+
+interface MatproxyLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     * Called by the engine from `OnBind`. Calls [init](https://wiki.facepunch.com/gmod/Structures/MatProxyData#init) method of the Lua material proxy.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/matproxy.Init
+     */
+    Init(name: string, uname: string, mat: IMaterial, values: table): void;
+}
+
+interface MatproxyLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     * Called by engine to determine if a certain material proxy is registered in Lua.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/matproxy.ShouldOverrideProxy
+     */
+    ShouldOverrideProxy(name: string): boolean;
+}
+

package/matselect.d.tlua

@@ -0,0 +1,106 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The panel used by Material & Lamp Sandbox tools for texture selection. Despite being only used in Sandbox, it is **not** exclusive to that gamemode.
+ *
+ * See also [PropSelect](https://wiki.facepunch.com/gmod/PropSelect) for the prop selecting alternative.
+ *
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/MatSelect
+ */
+interface MatSelect extends ContextBase {}
+
+interface MatSelect {
+    /**
+     * Adds a new material to the selection list.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/MatSelect:AddMaterial
+     */
+    AddMaterial(self: MatSelect, label: string, path: string): void;
+}
+
+interface MatSelect {
+    /**
+     * Adds a new material to the selection list, with some extra options.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/MatSelect:AddMaterialEx
+     */
+    AddMaterialEx(self: MatSelect, label: string, path: string, value: any, convars: table): void;
+}
+
+interface MatSelect {
+    /**
+     * Find a material and selects it, if it exists in this panel.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/MatSelect:FindAndSelectMaterial
+     */
+    FindAndSelectMaterial(self: MatSelect, mat: string): void;
+}
+
+interface MatSelect {
+    /**
+     * Find a [DImageButton](https://wiki.facepunch.com/gmod/DImageButton) panel based on the input material path.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/MatSelect:FindMaterialByValue
+     */
+    FindMaterialByValue(self: MatSelect, mat: string): DImageButton;
+}
+
+interface MatSelect {
+    /**
+     * Returns whether the panel would set its own height to fit all materials within its height.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/MatSelect:GetAutoHeight
+     */
+    GetAutoHeight(self: MatSelect): boolean;
+}
+
+interface MatSelect {
+    /**
+     * **INTERNAL**: Use [MatSelect:FindAndSelectMaterial](https://wiki.facepunch.com/gmod/MatSelect:FindAndSelectMaterial) instead.
+     *
+     *
+     * Selects a given material panel.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/MatSelect:SelectMaterial
+     */
+    SelectMaterial(self: MatSelect, mat: DImageButton): void;
+}
+
+interface MatSelect {
+    /**
+     * Sets whether the panel should set its own height to fit all materials within its height.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/MatSelect:SetAutoHeight
+     */
+    SetAutoHeight(self: MatSelect, autoSize: boolean): void;
+}
+
+interface MatSelect {
+    /**
+     * Sets the height of a single material in pixels.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/MatSelect:SetItemHeight
+     */
+    SetItemHeight(self: MatSelect, height: number): void;
+}
+
+interface MatSelect {
+    /**
+     * Sets the width of a single material in pixels.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/MatSelect:SetItemWidth
+     */
+    SetItemWidth(self: MatSelect, width: number): void;
+}
+
+interface MatSelect {
+    /**
+     * Sets the target height of the panel, in number of rows.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/MatSelect:SetNumRows
+     */
+    SetNumRows(self: MatSelect, rows: number): void;
+}
+

package/menu.d.tlua

@@ -0,0 +1,20 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The menu library.
+ * @source https://wiki.facepunch.com/gmod/Menu
+ */
+declare menu: MenuLib;
+
+interface MenuLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Used by "Demo to Video" to record the frame.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/menu.RecordFrame
+     */
+    RecordFrame(): void;
+}
+

package/menubar.d.tlua

@@ -0,0 +1,39 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The menubar library.
+ * @source https://wiki.facepunch.com/gmod/menubar
+ */
+declare menubar: MenubarLib;
+
+interface MenubarLib {
+    /**
+     * Creates the menu bar ( The bar at the top of the screen when holding C or Q in sandbox ) and docks it to the top of the screen. It will not appear.
+     *
+     *
+     * Calling this multiple times will **NOT** remove previous panel.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/menubar.Init
+     */
+    Init(): void;
+}
+
+interface MenubarLib {
+    /**
+     * Checks if the supplied panel is parent to the menubar
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/menubar.IsParent
+     */
+    IsParent(pnl: Panel): boolean;
+}
+
+interface MenubarLib {
+    /**
+     * Parents the menubar to the panel and displays the menubar.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/menubar.ParentTo
+     */
+    ParentTo(pnl: Panel): void;
+}
+

package/mesh.d.tlua

@@ -0,0 +1,183 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The mesh library allows you to create meshes. A mesh is a set of vertices that define a 3D shape, for constant meshes you should use the [IMesh](https://wiki.facepunch.com/gmod/IMesh) object instead.
+ * @source https://wiki.facepunch.com/gmod/mesh
+ */
+declare mesh: MeshLib;
+
+interface MeshLib {
+    /**
+     * Pushes the currently set vertex data (via other `mesh.*` functions) into the mesh stack. See example on [mesh.Begin](https://wiki.facepunch.com/gmod/mesh.Begin).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.AdvanceVertex
+     */
+    AdvanceVertex(): void;
+}
+
+interface MeshLib {
+    /**
+     * 		Begins creating or modifying a 3D mesh constructed from a given quantity and type of primitive 3D shapes such as triangles and quads.
+     *
+     * 		The resulting mesh can be stored in an [IMesh](https://wiki.facepunch.com/gmod/IMesh) if it is intended to be drawn multiple times or on multiple frames.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.Begin
+     */
+    Begin(mesh: IMesh, primitiveType: number, primitiveCount: number): void;
+}
+
+interface MeshLib {
+    Begin(primitiveType: number, primitiveCount: number): void;
+}
+
+interface MeshLib {
+    /**
+     * Sets the bone matrix ID and bone weight to be used for the next vertex. See [mesh.Begin](https://wiki.facepunch.com/gmod/mesh.Begin).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.BoneData
+     */
+    BoneData(index: number, matrixId: number, weight: number): void;
+}
+
+interface MeshLib {
+    /**
+     * Sets the color to be used for the next vertex. This is `COLOR0` semantic of
+     * Vertex Shader. See [mesh.Begin](https://wiki.facepunch.com/gmod/mesh.Begin).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.Color
+     */
+    Color(r: number, g: number, b: number, a: number): void;
+}
+
+interface MeshLib {
+    /**
+     * Ends the mesh (Started with [mesh.Begin](https://wiki.facepunch.com/gmod/mesh.Begin)) and renders it.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.End
+     */
+    End(): void;
+}
+
+interface MeshLib {
+    /**
+     * Sets the normal to be used for the next vertex. See [mesh.Begin](https://wiki.facepunch.com/gmod/mesh.Begin).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.Normal
+     */
+    Normal(normal: Vector): void;
+}
+
+interface MeshLib {
+    Normal(x: number, y: number, z: number): void;
+}
+
+interface MeshLib {
+    /**
+     * Sets the position to be used for the next vertex. See [mesh.Begin](https://wiki.facepunch.com/gmod/mesh.Begin).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.Position
+     */
+    Position(position: Vector): void;
+}
+
+interface MeshLib {
+    Position(x: number, y: number, z: number): void;
+}
+
+interface MeshLib {
+    /**
+     * Adds a quad (4 vertices) to the currently built mesh. See [mesh.Begin](https://wiki.facepunch.com/gmod/mesh.Begin).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.Quad
+     */
+    Quad(vertex1: Vector, vertex2: Vector, vertex3: Vector, vertex4: Vector, color: Color): void;
+}
+
+interface MeshLib {
+    /**
+     * Adds a quad (4 vertices) to the currently built mesh, by using position, normal and sizes. See [mesh.Begin](https://wiki.facepunch.com/gmod/mesh.Begin).
+     *
+     * See also [mesh.Quad](https://wiki.facepunch.com/gmod/mesh.Quad).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.QuadEasy
+     */
+    QuadEasy(position: Vector, normal: Vector, sizeX: number, sizeY: number, color: Color): void;
+}
+
+interface MeshLib {
+    /**
+     * Sets the specular map values. This is `COLOR1` semantic of Vertex Shader. Allows to blend textures of [Lightmapped_4WayBlend](https://developer.valvesoftware.com/wiki/Lightmapped_4WayBlend). Requires the `VERTEX_SPECULAR` flag to be set in the C++ code of a shader.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.Specular
+     */
+    Specular(r: number, g: number, b: number, a: number): void;
+}
+
+interface MeshLib {
+    /**
+     * Sets the `S` tangent to be used, also known as "binormal".
+     *
+     * Tangents and binormals are using in bumpmap rendering.
+     *
+     * See also [mesh.TangentT](https://wiki.facepunch.com/gmod/mesh.TangentT) and [mesh.Begin](https://wiki.facepunch.com/gmod/mesh.Begin).
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.TangentS
+     */
+    TangentS(tangentS: Vector): void;
+}
+
+interface MeshLib {
+    TangentS(x: number, y: number, z: number): void;
+}
+
+interface MeshLib {
+    /**
+     * Sets the `T` tangent to be used.
+     *
+     * Tangents and binormals are using in bumpmap rendering.
+     *
+     * See also [mesh.TangentS](https://wiki.facepunch.com/gmod/mesh.TangentS) and [mesh.Begin](https://wiki.facepunch.com/gmod/mesh.Begin).
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.TangentT
+     */
+    TangentT(tangentT: Vector): void;
+}
+
+interface MeshLib {
+    TangentT(x: number, y: number, z: number): void;
+}
+
+interface MeshLib {
+    /**
+     * Sets the texture coordinates for the next vertex for the current mesh. (See [mesh.Begin](https://wiki.facepunch.com/gmod/mesh.Begin))
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.TexCoord
+     */
+    TexCoord(set: number, s: number, t: number, u?: number, v?: number): void;
+}
+
+interface MeshLib {
+    /**
+     * 		A set of four numbers that can be used for arbitrary purposes by [Material](https://wiki.facepunch.com/gmod/Material) shaders.
+     * 		This is most commonly used to provide tangent information about each vertex to the Material's shader.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.UserData
+     */
+    UserData(tangentX: number, tangentY: number, tangentZ: number, tangentHandedness: number): void;
+}
+
+interface MeshLib {
+    /**
+     * Returns the amount of vertices that have been pushed via [mesh.AdvanceVertex](https://wiki.facepunch.com/gmod/mesh.AdvanceVertex).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/mesh.VertexCount
+     */
+    VertexCount(): number;
+}
+

package/modelimage.d.tlua

@@ -0,0 +1,12 @@
+// 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.
+ *
+ * 		Panel used to display models, used by [SpawnIcon](https://wiki.facepunch.com/gmod/SpawnIcon).
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/ModelImage
+ */
+interface ModelImage {}
+

package/motionsensor.d.tlua

@@ -0,0 +1,115 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Functions related to Kinect for Windows usage in GMod.
+ * **WARNING**: Kinect feature works only on 32-bit version of the game.
+ *
+ *
+ * @source https://wiki.facepunch.com/gmod/motionsensor
+ */
+declare motionsensor: MotionsensorLib;
+
+interface MotionsensorLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *  Called to build the skeleton. See [Using The Kinect](https://wiki.facepunch.com/gmod/Using_The_Kinect) and [Kinect developing](https://wiki.facepunch.com/gmod/Kinect_developing).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/motionsensor.BuildSkeleton
+     */
+    BuildSkeleton(translator: table, player: Player, rotation: Angle): (Vector, Angle, table);
+}
+
+interface MotionsensorLib {
+    /**
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/motionsensor.ChooseBuilderFromEntity
+     */
+    ChooseBuilderFromEntity(ent: Entity): string;
+}
+
+interface MotionsensorLib {
+    /**
+     * Returns the depth map material.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/motionsensor.GetColourMaterial
+     */
+    GetColourMaterial(): IMaterial;
+}
+
+interface MotionsensorLib {
+    /**
+     * Returns players skeletal data if they are using Kinect. See [Using The Kinect](https://wiki.facepunch.com/gmod/Using_The_Kinect) and [Kinect developing](https://wiki.facepunch.com/gmod/Kinect_developing).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/motionsensor.GetSkeleton
+     */
+    GetSkeleton(): table;
+}
+
+interface MotionsensorLib {
+    /**
+     * Return whether a kinect is connected - and active (ie - Start has been called).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/motionsensor.IsActive
+     */
+    IsActive(): boolean;
+}
+
+interface MotionsensorLib {
+    /**
+     * Returns true if we have detected that there's a kinect connected to the PC
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/motionsensor.IsAvailable
+     */
+    IsAvailable(): boolean;
+}
+
+interface MotionsensorLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *  Used internally by [motionsensor.ProcessAnglesTable](https://wiki.facepunch.com/gmod/motionsensor.ProcessAnglesTable). See [Using The Kinect](https://wiki.facepunch.com/gmod/Using_The_Kinect) and [Kinect developing](https://wiki.facepunch.com/gmod/Kinect_developing).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/motionsensor.ProcessAngle
+     */
+    ProcessAngle(translator: table, sensor: table, pos: Vector, ang: Angle, special_vectors: table, boneid: number, v: table): boolean;
+}
+
+interface MotionsensorLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *  Used internally by [motionsensor.BuildSkeleton](https://wiki.facepunch.com/gmod/motionsensor.BuildSkeleton). See [Using The Kinect](https://wiki.facepunch.com/gmod/Using_The_Kinect) and [Kinect developing](https://wiki.facepunch.com/gmod/Kinect_developing).
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/motionsensor.ProcessAnglesTable
+     */
+    ProcessAnglesTable(translator: table, sensor: table, pos: Vector, rotation: Angle): table;
+}
+
+interface MotionsensorLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *  Used internally by [motionsensor.BuildSkeleton](https://wiki.facepunch.com/gmod/motionsensor.BuildSkeleton). See [Using The Kinect](https://wiki.facepunch.com/gmod/Using_The_Kinect) and [Kinect developing](https://wiki.facepunch.com/gmod/Kinect_developing).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/motionsensor.ProcessPositionTable
+     */
+    ProcessPositionTable(translator: table, sensor: table): table;
+}
+
+interface MotionsensorLib {
+    /**
+     * This starts access to the kinect sensor. Note that this usually freezes the game for a couple of seconds.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/motionsensor.Start
+     */
+    Start(): boolean;
+}
+
+interface MotionsensorLib {
+    /**
+     * Stops the motion capture.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/motionsensor.Stop
+     */
+    Stop(): void;
+}
+