@tlua/gmod 1.0.1

package/gmod.d.tlua

@@ -0,0 +1,20 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Similar purpose to the [game](https://wiki.facepunch.com/gmod/game) and [engine](https://wiki.facepunch.com/gmod/engine), allows access to various features of the game's engine.
+ * @source https://wiki.facepunch.com/gmod/gmod
+ */
+declare gmod: GmodLib;
+
+interface GmodLib {
+    /**
+     * Returns the [GAMEMODE](https://wiki.facepunch.com/gmod/GAMEMODE) table.
+     *
+     * You will want to wait until [GM:OnGamemodeLoaded](https://wiki.facepunch.com/gmod/GM:OnGamemodeLoaded) for it to return a valid value.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/gmod.GetGamemode
+     */
+    GetGamemode(): GM;
+}
+

package/gmsave.d.tlua

@@ -0,0 +1,53 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The gmsave library provides functions relating to the singleplayer save system in Garry's Mod.
+ * @source https://wiki.facepunch.com/gmod/gmsave
+ */
+declare gmsave: GmsaveLib;
+
+interface GmsaveLib {
+    /**
+     * Loads a saved map.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/gmsave.LoadMap
+     */
+    LoadMap(mapData: string, ply?: Player, callback?: function): void;
+}
+
+interface GmsaveLib {
+    /**
+     * Sets player position and angles from supplied table.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/gmsave.PlayerLoad
+     */
+    PlayerLoad(ply: Player, data: table): void;
+}
+
+interface GmsaveLib {
+    /**
+     * Returns a table containing player position and angles. Used by [gmsave.SaveMap](https://wiki.facepunch.com/gmod/gmsave.SaveMap).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/gmsave.PlayerSave
+     */
+    PlayerSave(ply: Player): table;
+}
+
+interface GmsaveLib {
+    /**
+     * Saves the map.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/gmsave.SaveMap
+     */
+    SaveMap(ply: Player): string;
+}
+
+interface GmsaveLib {
+    /**
+     * Returns if we should save this entity in a duplication or a map save or not.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/gmsave.ShouldSaveEntity
+     */
+    ShouldSaveEntity(ent: Entity, t: table): boolean;
+}
+

package/gui.d.tlua

@@ -0,0 +1,232 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The gui library is similar to the [input](https://wiki.facepunch.com/gmod/input) but features functions that are more focused on the mouse's interaction with GUI panels.
+ * @source https://wiki.facepunch.com/gmod/gui
+ */
+declare gui: GuiLib;
+
+interface GuiLib {
+    /**
+     * Opens the game main menu as if the player pressed their Escape key.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.ActivateGameUI
+     */
+    ActivateGameUI(): void;
+}
+
+interface GuiLib {
+    /**
+     * Pushes text to the closed caption box.
+     * **WARNING**: The function will not work, if the console command variable `closecaption` is set to 0.
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/gui.AddCaption
+     */
+    AddCaption(captionStream: string, duration: number, fromPlayer?: boolean): void;
+}
+
+interface GuiLib {
+    /**
+     * Enables the mouse cursor without restricting player movement, like using Sandbox's context menu. See [vgui.CursorVisible](https://wiki.facepunch.com/gmod/vgui.CursorVisible) for a function to see if the cursor is visible or not.
+     *
+     * **NOTE**: Some [CUserCmd](https://wiki.facepunch.com/gmod/CUserCmd) functions will return incorrect values when this function is active because [the user input is getting overtaken by the vgui system](https://github.com/Facepunch/garrysmod-issues/issues/982#issuecomment-505671531).
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/gui.EnableScreenClicker
+     */
+    EnableScreenClicker(enabled: boolean): void;
+}
+
+interface GuiLib {
+    /**
+     * Hides the game main menu if it is currently open.
+     *
+     * This can only be ran a certain amount of times per second to prevent main menu being completely inaccessible by the player.
+     *
+     * Use [GM:OnPauseMenuShow](https://wiki.facepunch.com/gmod/GM:OnPauseMenuShow) to prevent opening the main menu without a one frame flash.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.HideGameUI
+     */
+    HideGameUI(): void;
+}
+
+interface GuiLib {
+    /**
+     * Simulates a mouse move with the given deltas.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.InternalCursorMoved
+     */
+    InternalCursorMoved(deltaX: number, deltaY: number): void;
+}
+
+interface GuiLib {
+    /**
+     * Simulates a key press for the given key.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.InternalKeyCodePressed
+     */
+    InternalKeyCodePressed(key: number): void;
+}
+
+interface GuiLib {
+    /**
+     * Simulates a key release for the given key.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.InternalKeyCodeReleased
+     */
+    InternalKeyCodeReleased(key: number): void;
+}
+
+interface GuiLib {
+    /**
+     * Simulates a key type typing to the specified key.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.InternalKeyCodeTyped
+     */
+    InternalKeyCodeTyped(key: number): void;
+}
+
+interface GuiLib {
+    /**
+     * Simulates an ASCII symbol writing.
+     * Use to write text in the chat or in VGUI.
+     * Doesn't work while the main menu is open!
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.InternalKeyTyped
+     */
+    InternalKeyTyped(code: number): void;
+}
+
+interface GuiLib {
+    /**
+     * Simulates a double mouse key press for the given mouse key.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.InternalMouseDoublePressed
+     */
+    InternalMouseDoublePressed(key: number): void;
+}
+
+interface GuiLib {
+    /**
+     * Simulates a mouse key press for the given mouse key.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.InternalMousePressed
+     */
+    InternalMousePressed(key: number): void;
+}
+
+interface GuiLib {
+    /**
+     * Simulates a mouse key release for the given mouse key.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.InternalMouseReleased
+     */
+    InternalMouseReleased(key: number): void;
+}
+
+interface GuiLib {
+    /**
+     * Simulates a mouse wheel scroll with the given delta.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.InternalMouseWheeled
+     */
+    InternalMouseWheeled(delta: number): void;
+}
+
+interface GuiLib {
+    /**
+     * Returns whether the console is visible or not.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.IsConsoleVisible
+     */
+    IsConsoleVisible(): boolean;
+}
+
+interface GuiLib {
+    /**
+     * Returns whether the game menu overlay ( main menu ) is open or not.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.IsGameUIVisible
+     */
+    IsGameUIVisible(): boolean;
+}
+
+interface GuiLib {
+    /**
+     * Returns the cursor's position on the screen, or 0, 0 if cursor is not visible.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.MousePos
+     * @deprecated Use input.GetCursorPos instead.
+     */
+    MousePos(): (number, number);
+}
+
+interface GuiLib {
+    /**
+     * Returns x component of the mouse position.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.MouseX
+     */
+    MouseX(): number;
+}
+
+interface GuiLib {
+    /**
+     * Returns y component of the mouse position.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.MouseY
+     */
+    MouseY(): number;
+}
+
+interface GuiLib {
+    /**
+     * Opens specified URL in the steam overlay browser.
+     *
+     * **NOTE**: When called clientside, user will be asked for confirmation before the website will open.
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.OpenURL
+     */
+    OpenURL(url: string): void;
+}
+
+interface GuiLib {
+    /**
+     * Converts the specified screen position to a **direction** vector local to the player's view. A related function is [Vector:ToScreen](https://wiki.facepunch.com/gmod/Vector:ToScreen), which translates a 3D position to a screen coordinate.
+     *
+     * [util.AimVector](https://wiki.facepunch.com/gmod/util.AimVector) is a more generic version of this, using a custom view instead of the player's current view.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/gui.ScreenToVector
+     */
+    ScreenToVector(x: number, y: number): Vector;
+}
+
+interface GuiLib {
+    /**
+     * Sets the cursor's position on the screen, relative to the topleft corner of the window
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/gui.SetMousePos
+     * @deprecated Use input.SetCursorPos instead.
+     */
+    SetMousePos(mouseX: number, mouseY: number): void;
+}
+
+interface GuiLib {
+    /**
+     * Shows console in the game UI.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/gui.ShowConsole
+     */
+    ShowConsole(): void;
+}
+

package/gwen.d.tlua

@@ -0,0 +1,55 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * GWEN is a system that allows you to load a spritesheet and generate a skin out of it.
+ * @source https://wiki.facepunch.com/gmod/GWEN
+ */
+declare GWEN: GWENLib;
+
+interface GWENLib {
+    /**
+     * This is a utility function that generates a specialized drawing function to render scalable textured borders. This is done with [9-slice scaling](https://en.wikipedia.org/wiki/9-slice_scaling). This is used in derma skins to create a bordered rectangle drawing function from an image.
+     *
+     * The texture is taken from `SKIN.GwenTexture` when the `material` argument is not supplied.
+     *
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/GWEN.CreateTextureBorder
+     */
+    CreateTextureBorder(x: number, y: number, w: number, h: number, left: number, top: number, right: number, bottom: number, material?: IMaterial): (x: number, y: number, w: number, h: number, clr?: Color) => void;
+}
+
+interface GWENLib {
+    /**
+     * Used in derma skins to create a fixed scale rectangle drawing function from an image. it will be drawn in the center of the box.
+     *
+     * The texture is taken from `SKIN.GwenTexture` when the `material` is not supplied.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/GWEN.CreateTextureCentered
+     */
+    CreateTextureCentered(x: number, y: number, w: number, h: number, material?: IMaterial): (x: number, y: number, w: number, h: number, clr?: Color) => void;
+}
+
+interface GWENLib {
+    /**
+     * Helper function that returns a specialized drawing function for rendering a texture that scales freely to fit the given area.
+     *
+     *
+     *
+     * The texture is taken from `SKIN.GwenTexture` when the `material` is not supplied.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/GWEN.CreateTextureNormal
+     */
+    CreateTextureNormal(x: number, y: number, w: number, h: number, material?: IMaterial): (x: number, y: number, w: number, h: number, clr?: Color) => void;
+}
+
+interface GWENLib {
+    /**
+     * Retrieves the color from a materials texture at the provided UV coordinates
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/GWEN.TextureColor
+     */
+    TextureColor(x: number, y: number): Color;
+}
+

package/halo.d.tlua

@@ -0,0 +1,42 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The halo library is used to draw glowing outlines around entities, an example of this can be seen by picking up props with the physgun in Garry's Mod 13.
+ * @source https://wiki.facepunch.com/gmod/halo
+ */
+declare halo: HaloLib;
+
+interface HaloLib {
+    /**
+     * Applies a [halo](https://wiki.facepunch.com/gmod/halo) glow effect to one or multiple entities. It is preferable to add them in [GM:PreDrawHalos](https://wiki.facepunch.com/gmod/GM:PreDrawHalos), but they can be added at any time.
+     * **NOTE**: The ignoreZ parameter will cause the halos to draw over the player's viewmodel. You can work around this using [render.DepthRange](https://wiki.facepunch.com/gmod/render.DepthRange) in the [GM:PreDrawViewModel](https://wiki.facepunch.com/gmod/GM:PreDrawViewModel), [GM:PostDrawViewModel](https://wiki.facepunch.com/gmod/GM:PostDrawViewModel), [GM:PreDrawPlayerHands](https://wiki.facepunch.com/gmod/GM:PreDrawPlayerHands) and [GM:PostDrawPlayerHands](https://wiki.facepunch.com/gmod/GM:PostDrawPlayerHands) hooks.
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/halo.Add
+     */
+    Add(entities: table, color: Color, blurX?: number, blurY?: number, passes?: number, additive?: boolean, ignoreZ?: boolean): void;
+}
+
+interface HaloLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Renders a halo according to the specified table, only used internally, called from a [GM:PostDrawEffects](https://wiki.facepunch.com/gmod/GM:PostDrawEffects) hook added by the halo library.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/halo.Render
+     */
+    Render(entry: table): void;
+}
+
+interface HaloLib {
+    /**
+     * Returns the entity the halo library is currently rendering the halo for.
+     *
+     * The main purpose of this function is to be used in [ENTITY:Draw](https://wiki.facepunch.com/gmod/ENTITY:Draw) in order not to draw certain parts of the entity when the halo is being rendered, so there's no halo around unwanted entity parts, such as lasers, 3D2D displays, etc.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/halo.RenderedEntity
+     */
+    RenderedEntity(): Entity;
+}
+

package/hammer.d.tlua

@@ -0,0 +1,17 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The hammer library.
+ * @source https://wiki.facepunch.com/gmod/hammer
+ */
+declare hammer: HammerLib;
+
+interface HammerLib {
+    /**
+     * Sends command to Hammer, if Hammer is running with the current map loaded.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/hammer.SendCommand
+     */
+    SendCommand(cmd: string): string;
+}
+

package/hook.d.tlua

@@ -0,0 +1,64 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The hook library allows you to add hooks called by the game engine, allowing multiple scripts to modify game function.
+ * @source https://wiki.facepunch.com/gmod/hook
+ */
+declare hook: HookLib;
+
+interface HookLib {
+    /**
+     * Registers a function (or "callback") with the Hook system so that it will
+     * be called automatically whenever a specific event (or "hook") occurs.
+     * @realm shared
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/hook.Add
+     */
+    Add(eventName: string, identifier: any, func: function): void;
+}
+
+
+interface HookLib {
+    /**
+     * Calls all hooks associated with the given event until one returns something other than `nil`, and then returns that data.
+     *
+     * In almost all cases, you should use [hook.Run](https://wiki.facepunch.com/gmod/hook.Run) instead - it calls hook.Call internally but supplies the gamemode table by itself, making your code neater.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/hook.Call
+     */
+    Call(eventName: string, gamemodeTable?: table, ...: any): (...any);
+}
+
+interface HookLib {
+    /**
+     * Returns a list of all the hooks registered with [hook.Add](https://wiki.facepunch.com/gmod/hook.Add).
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/hook.GetTable
+     */
+    GetTable(): table;
+}
+
+interface HookLib {
+    /**
+     * Removes the hook with the supplied identifier from the given event.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/hook.Remove
+     */
+    Remove(eventName: string, identifier: any): void;
+}
+
+interface HookLib {
+    /**
+     * Calls all hooks associated with the given event **until** one returns something other than `nil` and then returns that data. If no hook returns any data, it will try to call the `GAMEMODE:` alternative, if one exists.
+     *
+     * This function internally calls [hook.Call](https://wiki.facepunch.com/gmod/hook.Call).
+     *
+     * See also: [gamemode.Call](https://wiki.facepunch.com/gmod/gamemode.Call) - same as this, but does not call hooks if the gamemode hasn't defined the function.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/hook.Run
+     */
+    Run(eventName: string, ...: any): (...any);
+}
+

package/html.d.tlua

@@ -0,0 +1,22 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The HTML control can be used to display web pages just like an internet browser.
+ *
+ * [DHTML](https://wiki.facepunch.com/gmod/DHTML) has additional functionality for interfacing with the page, such as sending and receiving data.
+ *
+ * ## Blocked URL Extentions
+ *
+ * This means your url cannot end in any of these extensions, e.g.: (http://yourdomain.com/garry.exe)
+ * * .exe
+ * * .bat
+ * * .dll
+ * * .zip
+ * * .mp3
+ * * .swf
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/HTML
+ */
+interface HTML extends Panel {}
+

package/http.d.tlua

@@ -0,0 +1,72 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The http library allows either the server or client to communicate with external websites via HTTP, both `GET` ([http.Fetch](https://wiki.facepunch.com/gmod/http.Fetch)) and `POST` ([http.Post](https://wiki.facepunch.com/gmod/http.Post)) are supported. A more powerful & advanced method can be used via the global [Global.HTTP](https://wiki.facepunch.com/gmod/Global.HTTP) function.
+ *
+ * @source https://wiki.facepunch.com/gmod/http
+ */
+declare http: HttpLib;
+
+interface HttpLib {
+    /**
+     * Launches an asynchronous **GET** request to an HTTP server. Internally calls [Global.HTTP](https://wiki.facepunch.com/gmod/Global.HTTP).
+     *
+     * HTTP requests returning a status code >= `400` are still considered a success and will call the [onSuccess](https://wiki.facepunch.com/gmod/Structures/HTTPRequest) callback.
+     *
+     * The [onFailure](https://wiki.facepunch.com/gmod/Structures/HTTPRequest) callback is usually only called on DNS or TCP errors (e.g. the website is unavailable or the domain does not exist).
+     *
+     * A rough overview of possible [onFailure](https://wiki.facepunch.com/gmod/Structures/HTTPRequest) messages:
+     * * `invalid url` - Invalid/empty url. ( no request was attempted )
+     * * `invalid request` - Steam HTTP lib failed to create a HTTP request.
+     * * `error` - OnComplete callback's second argument, `bError`, is `true`.
+     * * `unsuccessful` - OnComplete's first argument, `pResult->m_bRequestSuccessful`, returned `false`.
+     *
+     * This cannot send or receive multiple headers with the same name.
+     * **NOTE**: HTTP-requests that respond with a large body may return an `unsuccessful` error. Try using the [Range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range) header to download the file in chunks.
+     *
+     * **NOTE**: HTTP-requests to destinations on private networks (such as `192.168.0.1`, or `127.0.0.1`) won't work.
+     *
+     * 	To enable HTTP-requests to destinations on private networks use [Command Line Parameters](https://wiki.facepunch.com/gmod/Command_Line_Parameters) `-allowlocalhttp`. (Dedicated servers only)
+     *
+     *
+     * **Not all headers are allowed in the client realm, here is a list of known blacklisted headers inside the client realm:**
+     * ```
+     * host
+     * expect
+     * content-length
+     * proxy-authenticate
+     * accept-charset
+     * connection
+     * accept-encoding
+     * origin
+     * date
+     * ```
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/http.Fetch
+     */
+    Fetch(url: string, onSuccess?: (body: string, size: number, headers: table, code: number) => void, onFailure?: (error: string) => void, headers?: table): void;
+}
+
+interface HttpLib {
+    /**
+     * Sends an asynchronous **POST** request to an HTTP server. Internally calls [Global.HTTP](https://wiki.facepunch.com/gmod/Global.HTTP).
+     *
+     * HTTP requests returning a status code >= `400` are still considered a success and will call the [onSuccess](https://wiki.facepunch.com/gmod/Structures/HTTPRequest) callback.
+     *
+     * The [onFailure](https://wiki.facepunch.com/gmod/Structures/HTTPRequest) callback is usually only called on DNS or TCP errors (e.g. the website is unavailable or the domain does not exist).
+     *
+     * This cannot send or receive multiple headers with the same name.
+     * **NOTE**: HTTP-requests that respond with a large body may return an `unsuccessful` error. Try using the [Range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range) header to download the file in chunks.
+     *
+     * **NOTE**: HTTP-requests to destinations on private networks (such as `192.168.0.1`, or `127.0.0.1`) won't work.
+     *
+     * 	To enable HTTP-requests to destinations on private networks use [Command Line Parameters](https://wiki.facepunch.com/gmod/Command_Line_Parameters) `-allowlocalhttp`. (Dedicated servers only)
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/http.Post
+     */
+    Post(url: string, parameters: table, onSuccess?: (body: string, size: string, headers: table, code: number) => void, onFailure?: (error: string) => void, headers?: table): void;
+}
+