@tlua/gmod 1.0.1

package/tool.d.tlua

@@ -0,0 +1,466 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * A list of functions available inside a Sandbox Toolgun tool.
+ *
+ * You can find the hooks [here](https://wiki.facepunch.com/gmod/TOOL_Hooks), and members [here](https://wiki.facepunch.com/gmod/Structures/TOOL).
+ * @source https://wiki.facepunch.com/gmod/Tool
+ */
+interface Tool {}
+interface TOOL extends Tool {}
+
+interface Tool {
+    /**
+     * Called when [WEAPON:Deploy](https://wiki.facepunch.com/gmod/WEAPON:Deploy) of the toolgun is called.
+     *
+     * This is also called when switching from another tool on the server.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/TOOL:Deploy
+     */
+    Deploy(self: Tool): boolean;
+}
+
+interface Tool {
+    /**
+     * Called when [WEAPON:DrawHUD](https://wiki.facepunch.com/gmod/WEAPON:DrawHUD) of the toolgun is called, only when the user has this tool selected.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/TOOL:DrawHUD
+     */
+    DrawHUD(self: Tool): void;
+}
+
+interface Tool {
+    /**
+     * Called after the default tool screen has been drawn from [WEAPON:RenderScreen](https://wiki.facepunch.com/gmod/WEAPON:RenderScreen).
+     *
+     * **NOTE**: If this method exists on the TOOL object table, the default scrolling text will not be drawn
+     *
+     * **NOTE**: Materials rendered in this hook require $ignorez parameter to draw properly.
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/TOOL:DrawToolScreen
+     */
+    DrawToolScreen(self: Tool, width: number, height: number): void;
+}
+
+interface Tool {
+    /**
+     * Called when [WEAPON:Think](https://wiki.facepunch.com/gmod/WEAPON:Think) of the toolgun is called, only when the user has this tool selected.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/TOOL:FreezeMovement
+     */
+    FreezeMovement(self: Tool): boolean;
+}
+
+interface Tool {
+    /**
+     * Called when [WEAPON:Holster](https://wiki.facepunch.com/gmod/WEAPON:Holster) of the toolgun is called, when switching between different toolguns.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/TOOL:Holster
+     */
+    Holster(self: Tool): void;
+}
+
+interface Tool {
+    /**
+     * Called when the user left clicks with the tool.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/TOOL:LeftClick
+     */
+    LeftClick(self: Tool, tr: TraceResult): boolean;
+}
+
+interface Tool {
+    /**
+     * Called when the user presses the reload key with the tool out.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/TOOL:Reload
+     */
+    Reload(self: Tool, tr: TraceResult): boolean;
+}
+
+interface Tool {
+    /**
+     * Called when the user right clicks with the tool.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/TOOL:RightClick
+     */
+    RightClick(self: Tool, tr: TraceResult): boolean;
+}
+
+interface Tool {
+    /**
+     * Called when [WEAPON:Think](https://wiki.facepunch.com/gmod/WEAPON:Think) of the toolgun is called. This only happens when the tool gun is currently equipped/selected by the player and the selected tool is this tool.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/TOOL:Think
+     */
+    Think(self: Tool): void;
+}
+
+interface Tool {
+    /**
+     * Called when the tool's control panel needs to be rebuilt.
+     *
+     * NOTE: this is a dot-defined function, not a colon method - it does NOT
+     * receive a `self` argument (see the Tool.BuildCPanel field).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/TOOL.BuildCPanel
+     */
+    BuildCPanel(panel: ControlPanel): void;
+}
+
+
+interface Tool {
+    /**
+     * Returns whether the tool is allowed to be used or not. This function ignores the [SANDBOX:CanTool](https://wiki.facepunch.com/gmod/SANDBOX:CanTool) hook.
+     *
+     * By default this will always return true clientside and uses `TOOL.AllowedCVar`which is a [ConVar](https://wiki.facepunch.com/gmod/ConVar) object pointing to  `toolmode_allow_*toolname*` convar on the server.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:Allowed
+     */
+    Allowed(self: Tool): boolean;
+}
+
+interface Tool {
+    /**
+     * Builds a list of all ConVars set via the ClientConVar variable on the [Structures/TOOL](https://wiki.facepunch.com/gmod/Structures/TOOL) and their default values. This is used for the preset system.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:BuildConVarList
+     */
+    BuildConVarList(self: Tool): table;
+}
+
+interface Tool {
+    /**
+     * **INTERNAL**: This is called automatically for most toolgun actions so you shouldn't need to use it.
+     *
+     *
+     * Checks all added objects to see if they're still valid, if not, clears the list of objects.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:CheckObjects
+     */
+    CheckObjects(self: Tool): void;
+}
+
+interface Tool {
+    /**
+     * Clears all objects previously set with [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:ClearObjects
+     */
+    ClearObjects(self: Tool): void;
+}
+
+interface Tool {
+    /**
+     * **INTERNAL**: This is called automatically for all tools.
+     *
+     * Initializes the tool object
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:Create
+     */
+    Create(self: Tool): Tool;
+}
+
+interface Tool {
+    /**
+     * **INTERNAL**: This is called automatically for all tools.
+     *
+     *
+     * Creates clientside ConVars based on the ClientConVar table specified in the tool structure. Also creates the 'toolmode_allow_X' ConVar.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:CreateConVars
+     */
+    CreateConVars(self: Tool): void;
+}
+
+interface Tool {
+    /**
+     * Retrieves a physics bone number previously stored using [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetBone
+     */
+    GetBone(self: Tool, id: number): number;
+}
+
+interface Tool {
+    /**
+     * Attempts to grab a clientside tool [ConVar](https://wiki.facepunch.com/gmod/ConVar) value as a [boolean](https://wiki.facepunch.com/gmod/boolean).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetClientBool
+     */
+    GetClientBool(self: Tool, name: string, _default?: boolean): number;
+}
+
+interface Tool {
+    /**
+     * Attempts to grab a clientside tool [ConVar](https://wiki.facepunch.com/gmod/ConVar) as a [string](https://wiki.facepunch.com/gmod/string).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetClientInfo
+     */
+    GetClientInfo(self: Tool, name: string): string;
+}
+
+interface Tool {
+    /**
+     * Attempts to grab a clientside tool [ConVar](https://wiki.facepunch.com/gmod/ConVar)'s value as a [number](https://wiki.facepunch.com/gmod/number).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetClientNumber
+     */
+    GetClientNumber(self: Tool, name: string, _default?: number): number;
+}
+
+interface Tool {
+    /**
+     * Retrieves an Entity previously stored using [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetEnt
+     */
+    GetEnt(self: Tool, id: number): Entity;
+}
+
+interface Tool {
+    /**
+     * Returns a language key based on this tool's name and the current stage it is on.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetHelpText
+     */
+    GetHelpText(self: Tool): string;
+}
+
+interface Tool {
+    /**
+     * Retrieves an local vector previously stored using [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
+     * See also [Tool:GetPos](https://wiki.facepunch.com/gmod/Tool:GetPos).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetLocalPos
+     */
+    GetLocalPos(self: Tool, id: number): Vector;
+}
+
+interface Tool {
+    /**
+     * Returns the name of the current tool mode.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetMode
+     */
+    GetMode(self: Tool): string;
+}
+
+interface Tool {
+    /**
+     * Retrieves an normal vector previously stored using [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetNormal
+     */
+    GetNormal(self: Tool, id: number): Vector;
+}
+
+interface Tool {
+    /**
+     * Returns the current operation of the tool set by [Tool:SetOperation](https://wiki.facepunch.com/gmod/Tool:SetOperation).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetOperation
+     */
+    GetOperation(self: Tool): number;
+}
+
+interface Tool {
+    /**
+     * Returns the owner of this tool.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetOwner
+     */
+    GetOwner(self: Tool): Player;
+}
+
+interface Tool {
+    /**
+     * Retrieves an [PhysObj](https://wiki.facepunch.com/gmod/PhysObj) previously stored using [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
+     * See also [Tool:GetEnt](https://wiki.facepunch.com/gmod/Tool:GetEnt).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetPhys
+     */
+    GetPhys(self: Tool, id: number): PhysObj;
+}
+
+interface Tool {
+    /**
+     * Retrieves a vector previously stored using Tool:SetObject. See also
+     * Tool:GetLocalPos.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetPos
+     */
+    GetPos(self: Tool, id?: number): Vector;
+}
+
+
+interface Tool {
+    /**
+     * Returns the Tool Gun (`gmod_tool`) Scripted [Weapon](https://wiki.facepunch.com/gmod/Weapon).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetSWEP
+     * @deprecated Use Tool:GetWeapon instead.
+     */
+    GetSWEP(self: Tool): Weapon;
+}
+
+interface Tool {
+    /**
+     * Attempts to grab a serverside tool [ConVar](https://wiki.facepunch.com/gmod/ConVar).
+     * This will not do anything on client, despite the function being defined shared.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetServerInfo
+     */
+    GetServerInfo(self: Tool, name: string): string;
+}
+
+interface Tool {
+    /**
+     * Returns the current stage of the tool set by [Tool:SetStage](https://wiki.facepunch.com/gmod/Tool:SetStage).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetStage
+     */
+    GetStage(self: Tool): number;
+}
+
+interface Tool {
+    /**
+     * Returns the Tool Gun (`gmod_tool`) Scripted [Weapon](https://wiki.facepunch.com/gmod/Weapon).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:GetWeapon
+     */
+    GetWeapon(self: Tool): Weapon;
+}
+
+interface Tool {
+    /**
+     * Initializes the ghost entity with the given model. Removes any old ghost entity if called multiple times.
+     *
+     * The ghost is a regular prop_physics entity in singleplayer games, and a clientside prop in multiplayer games.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:MakeGhostEntity
+     */
+    MakeGhostEntity(self: Tool, model: string, pos: Vector, angle: Angle): void;
+}
+
+interface Tool {
+    /**
+     * Returns the amount of stored objects ( [Entity](https://wiki.facepunch.com/gmod/Entity)s ) the tool has.
+     * Are TOOLs limited to 4 entities?
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:NumObjects
+     */
+    NumObjects(self: Tool): number;
+}
+
+interface Tool {
+    /**
+     * Automatically forces the tool's control panel to be rebuilt.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/Tool:RebuildControlPanel
+     */
+    RebuildControlPanel(self: Tool, ...: any): void;
+}
+
+interface Tool {
+    /**
+     * Removes any ghost entity created for this tool.
+     *
+     * This is called automatically at various points, including when changing tools, holstering the toolgun, therefore it is a very good idea to implement this callback in your custom tool to cleanup any custom ghost entities.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:ReleaseGhostEntity
+     */
+    ReleaseGhostEntity(self: Tool): void;
+}
+
+interface Tool {
+    /**
+     * Stores an [Entity](https://wiki.facepunch.com/gmod/Entity) for later use in the tool.
+     *
+     * The stored values can be retrieved by [Tool:GetEnt](https://wiki.facepunch.com/gmod/Tool:GetEnt), [Tool:GetPos](https://wiki.facepunch.com/gmod/Tool:GetPos), [Tool:GetLocalPos](https://wiki.facepunch.com/gmod/Tool:GetLocalPos), [Tool:GetPhys](https://wiki.facepunch.com/gmod/Tool:GetPhys), [Tool:GetBone](https://wiki.facepunch.com/gmod/Tool:GetBone) and [Tool:GetNormal](https://wiki.facepunch.com/gmod/Tool:GetNormal)
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:SetObject
+     */
+    SetObject(self: Tool, id: number, ent: Entity, pos: Vector, phys: PhysObj, bone: number, normal: Vector): void;
+}
+
+interface Tool {
+    /**
+     * Sets the current operation of the tool. Does nothing clientside. See also [Tool:SetStage](https://wiki.facepunch.com/gmod/Tool:SetStage).
+     *
+     * Operations and stages work as follows:
+     * * Operation 1
+     * * * Stage 1
+     * * * Stage 2
+     * * * Stage 3
+     * * Operation 2
+     * * * Stage 1
+     * * * Stage 2
+     * * * Stage ...
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:SetOperation
+     */
+    SetOperation(self: Tool, operation: number): void;
+}
+
+interface Tool {
+    /**
+     * Sets the current stage of the tool. Does nothing clientside.
+     *
+     * See also [Tool:SetOperation](https://wiki.facepunch.com/gmod/Tool:SetOperation).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:SetStage
+     */
+    SetStage(self: Tool, stage: number): void;
+}
+
+interface Tool {
+    /**
+     * Initializes the ghost entity based on the supplied entity.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:StartGhostEntity
+     */
+    StartGhostEntity(self: Tool, ent: Entity): void;
+}
+
+interface Tool {
+    /**
+     * **INTERNAL**: Called on deploy automatically
+     *
+     *
+     * Sets the tool's stage to how many stored objects the tool has.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:UpdateData
+     */
+    UpdateData(self: Tool): void;
+}
+
+interface Tool {
+    /**
+     * Updates the position and orientation of the ghost entity based on where the toolgun owner is looking along with data from object with id 1 set by [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
+     *
+     * This should be called in the tool's [TOOL:Think](https://wiki.facepunch.com/gmod/TOOL:Think) hook.
+     *
+     * This command is only used for tools that move props, such as easy weld, axis and motor. If you want to update a ghost like the thruster tool does it for example, check its [source code](https://github.com/Facepunch/garrysmod/blob/master/garrysmod/gamemodes/sandbox/entities/weapons/gmod_tool/stools/thruster.lua#L179).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Tool:UpdateGhostEntity
+     */
+    UpdateGhostEntity(self: Tool): void;
+}
+

package/ugcpublishwindow.d.tlua

@@ -0,0 +1,83 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		A window that is used to publish dupes and saves
+ *
+ *
+ * @realm menu
+ * @source https://wiki.facepunch.com/gmod/UGCPublishWindow
+ */
+interface UGCPublishWindow extends DFrame {}
+
+interface UGCPublishWindow {
+    /**
+     * Checks if the Tags and Title are valid and if so it enables the publish button.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:CheckInput
+     */
+    CheckInput(self: UGCPublishWindow): void;
+}
+
+interface UGCPublishWindow {
+    /**
+     * Displays the given error message.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:DisplayError
+     */
+    DisplayError(self: UGCPublishWindow, err: string): void;
+}
+
+interface UGCPublishWindow {
+    /**
+     * Publishes the Item or throws an error if the Title or Tags are invalid
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:DoPublish
+     */
+    DoPublish(self: UGCPublishWindow, wsid: string, err: string): void;
+}
+
+interface UGCPublishWindow {
+    /**
+     * Rezises the panel to nicely fit all children
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:FitContents
+     */
+    FitContents(self: UGCPublishWindow): void;
+}
+
+interface UGCPublishWindow {
+    /**
+     * Returns the name of the current selected tag.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:GetChosenTag
+     */
+    GetChosenTag(self: UGCPublishWindow): string;
+}
+
+interface UGCPublishWindow {
+    /**
+     * Called when the Item was published or if any error occurred while publishing
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:OnPublishFinished
+     */
+    OnPublishFinished(self: UGCPublishWindow, wsid: string, err: string): void;
+}
+
+interface UGCPublishWindow {
+    /**
+     * updated the Workshop items list.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:Setup
+     */
+    Setup(self: UGCPublishWindow, ugcType: string, file: string, imageFile: string, handler: WorkshopFileBase): void;
+}
+
+interface UGCPublishWindow {
+    /**
+     * updated the Workshop items list.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:UpdateWorkshopItems
+     */
+    UpdateWorkshopItems(self: UGCPublishWindow): void;
+}
+

package/umsg.d.tlua

@@ -0,0 +1,147 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The umsg (user message) library was previously the most common way of sending information from the server to the client.
+ *
+ * **WARNING**: Usermessages have a limit of only 256 bytes!
+ *
+ * @source https://wiki.facepunch.com/gmod/umsg
+ * @deprecated You should be using the net library instead
+ */
+declare umsg: UmsgLib;
+
+interface UmsgLib {
+    /**
+     * Writes an angle to the usermessage.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.Angle
+     * @deprecated You should be using the net instead
+     */
+    Angle(angle: Angle): void;
+}
+
+interface UmsgLib {
+    /**
+     * Writes a bool to the usermessage.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.Bool
+     * @deprecated You should be using the net instead
+     */
+    Bool(bool: boolean): void;
+}
+
+interface UmsgLib {
+    /**
+     * Writes a signed char to the usermessage.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.Char
+     * @deprecated You should be using the net instead
+     */
+    Char(char: number): void;
+}
+
+interface UmsgLib {
+    /**
+     * Dispatches the usermessage to the client(s).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.End
+     * @deprecated You should be using the net instead
+     */
+    End(): void;
+}
+
+interface UmsgLib {
+    /**
+     * Writes an entity object to the usermessage. (As an entity handle, which means the entity index + its serial number)
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.Entity
+     * @deprecated You should be using the net instead
+     */
+    Entity(entity: Entity): void;
+}
+
+interface UmsgLib {
+    /**
+     * Writes a float to the usermessage.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.Float
+     * @deprecated You should be using the net instead
+     */
+    Float(float: number): void;
+}
+
+interface UmsgLib {
+    /**
+     * Writes a signed int (32 bit) to the usermessage.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.Long
+     * @deprecated You should be using the net instead
+     */
+    Long(int: number): void;
+}
+
+interface UmsgLib {
+    /**
+     * The string specified will be networked to the client and receive a identifying number, which will be sent instead of the string to optimize networking.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.PoolString
+     * @deprecated Inferior version of util.AddNetworkString
+     */
+    PoolString(string: string): void;
+}
+
+interface UmsgLib {
+    /**
+     * Writes a signed short (16 bit) to the usermessage.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.Short
+     * @deprecated You should be using the net instead
+     */
+    Short(short: number): void;
+}
+
+interface UmsgLib {
+    /**
+     * Starts a new usermessage.
+     *
+     * **WARNING**: Usermessages have a limit of only 256 bytes!
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.Start
+     * @deprecated You should be using net instead
+     */
+    Start(name: string, filter?: Player): void;
+}
+
+interface UmsgLib {
+    /**
+     * Writes a null terminated string to the usermessage.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.String
+     * @deprecated You should be using the net instead
+     */
+    String(string: string): void;
+}
+
+interface UmsgLib {
+    /**
+     * Writes a Vector to the usermessage.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.Vector
+     * @deprecated You should be using the net instead
+     */
+    Vector(vector: Vector): void;
+}
+
+interface UmsgLib {
+    /**
+     * Writes a vector normal to the usermessage.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/umsg.VectorNormal
+     * @deprecated You should be using the net instead
+     */
+    VectorNormal(normal: Vector): void;
+}
+