@tlua/gmod 1.0.1

package/jit.d.tlua

@@ -0,0 +1,243 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Library to work with the [LuaJIT](http://luajit.org/) functionality of gmod.
+ * @source https://wiki.facepunch.com/gmod/jit
+ */
+interface JitLib {
+    /**
+     * You can attach callbacks to a number of compiler events with jit.attach. The callback can be called:
+     *
+     * * when a function has been compiled to bytecode (`"bc"`);
+     * * when trace recording starts or stops (`"trace"`);
+     * * as a trace is being recorded (`"record"`);
+     * * or when a trace exits through a side exit (`"texit"`).
+     *
+     * Set a callback with `jit.attach(callback, "event")` and clear the same callback with `jit.attach(callback)`.
+     * Only one callback can be active per event.
+     *
+     * **WARNING**: This function isn't officially documented on LuaJIT wiki, use it at your own risk.
+     *
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.attach
+     * @deprecated This function was disabled due to security concerns.
+     */
+    attach(callback: function, event: string): void;
+}
+
+interface JitLib {
+    /**
+     * Flushes the whole cache of compiled code.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.flush
+     */
+    flush(): void;
+}
+
+interface JitLib {
+    /**
+     * Disables LuaJIT Lua compilation.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.off
+     */
+    off(): void;
+}
+
+interface JitLib {
+    /**
+     * Enables LuaJIT Lua compilation.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.on
+     */
+    on(): void;
+}
+
+interface JitLib {
+    opt: JitoptLib;
+}
+
+interface JitoptLib {
+    /**
+     * JIT compiler optimization control. The opt sub-module provides the backend for the -O command line LuaJIT option.
+     * You can also use it programmatically, e.g.:
+     *
+     * ```
+     * jit.opt.start(2) -- same as -O2
+     * jit.opt.start("-dce")
+     * jit.opt.start("hotloop=10", "hotexit=2")
+     * ```
+     *
+     * 	A list of LuaJIT -O command line options can be found here(a table of various optimization levels are displayed towards the bottom of the page along with exactly which optimization options are enabled for each level): http://luajit.org/running.html
+     *
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.opt.start
+     */
+    start(...: any): void;
+}
+
+interface JitLib {
+    /**
+     * Returns the status of the JIT compiler and the current optimizations enabled.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.status
+     */
+    status(): (boolean, any);
+}
+
+interface JitLib {
+    util: JitutilLib;
+}
+
+interface JitutilLib {
+    /**
+     * Returns bytecode of a function at a position.
+     * 		**NOTE**: This function only works for Lua defined functions.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.util.funcbc
+     */
+    funcbc(func: function, pos: number): (number, number);
+}
+
+interface JitutilLib {
+    /**
+     * Retrieves LuaJIT information about a given function, similarly to [debug.getinfo](https://wiki.facepunch.com/gmod/debug.getinfo). Possible table fields:
+     * * linedefined: as for [debug.getinfo](https://wiki.facepunch.com/gmod/debug.getinfo)
+     * * lastlinedefined: as for [debug.getinfo](https://wiki.facepunch.com/gmod/debug.getinfo)
+     * * params: the number of parameters the function takes
+     * * stackslots: the number of stack slots the function's local variable use
+     * * upvalues: the number of upvalues the function uses
+     * * bytecodes: the number of bytecodes it the compiled function
+     * * gcconsts: the number of garbage collectable constants
+     * * nconsts: the number of lua_Number (double) constants
+     * * children: Boolean representing whether the function creates closures
+     * * currentline: as for [debug.getinfo](https://wiki.facepunch.com/gmod/debug.getinfo)
+     * * isvararg: if the function is a vararg function
+     * * source: as for [debug.getinfo](https://wiki.facepunch.com/gmod/debug.getinfo)
+     * * loc: a string describing the source and currentline, like "<source>:<line>"
+     * * ffid: the fast function id of the function (if it is one). In this case only upvalues above and addr below are valid
+     * * addr: the address of the function (if it is not a Lua function). If it's a C function rather than a fast function, only upvalues above is valid*
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.util.funcinfo
+     */
+    funcinfo(func: function, pos?: number): table;
+}
+
+interface JitutilLib {
+    /**
+     * Gets a constant at a certain index in a function.
+     *
+     *
+     * **WARNING**: This function isn't officially documented on LuaJIT wiki, use it at your own risk.
+     *
+     * **NOTE**: Numbers constants goes from 0 (included) to n-1, n being the value of nconsts in [jit.util.funcinfo](https://wiki.facepunch.com/gmod/jit.util.funcinfo) in other words, the consts goes from (nconsts-1) to -n
+     *
+     * **NOTE**: This function only works for Lua defined functions.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.util.funck
+     * @deprecated This function was disabled due to security concerns.
+     */
+    funck(func: function, index: number): any;
+}
+
+interface JitutilLib {
+    /**
+     * Does the exact same thing as [debug.getupvalue](https://wiki.facepunch.com/gmod/debug.getupvalue) except it only returns the name, not the name and the object. The upvalue indexes also start at 0 rather than 1, so doing `jit.util.funcuvname(func, 0)` will get you the same name as `debug.getupvalue(func, 1)`
+     * **WARNING**: This function isn't officially documented on LuaJIT wiki, use it at your own risk.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.util.funcuvname
+     * @deprecated This function was disabled due to security concerns.
+     */
+    funcuvname(func: function, index: number): string;
+}
+
+interface JitutilLib {
+    /**
+     * 	Previously got the address of a function from a set list of functions, but now always returns `0` as it is deprecated.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.util.ircalladdr
+     * @deprecated This function was disabled due to security concerns.
+     */
+    ircalladdr(index: number): number;
+}
+
+interface JitutilLib {
+    /**
+     * 		Grabs the address of a function based on it's trace exit number. Grabbed via [jit.attach](https://wiki.facepunch.com/gmod/jit.attach) (with the texit event).
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.util.traceexitstub
+     * @deprecated This function was disabled due to security concerns. It will always return 0.
+     */
+    traceexitstub(exitno: number): number;
+}
+
+interface JitutilLib {
+    /**
+     * Return table fields:
+     * * link (number): the linked trace (0 for link types: none, return, interpreter)
+     * * nk (number): the lowest IR constant (???)
+     * * nins (number): the next IR instruction (???)
+     * * linktype (string): the link type (none, root, loop, tail-recursion, up-recursion, down-recursion, interpreter, return)
+     * * nexit (number): number of snapshots (for use with [jit.util.tracesnap](https://wiki.facepunch.com/gmod/jit.util.tracesnap))
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.util.traceinfo
+     * @deprecated This function was disabled due to security concerns.
+     */
+    traceinfo(trace: number): table;
+}
+
+interface JitutilLib {
+    /**
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.util.traceir
+     * @deprecated This function was disabled due to security concerns.
+     */
+    traceir(tr: number, index: number): (number, number, number, number, number);
+}
+
+interface JitutilLib {
+    /**
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.util.tracek
+     * @deprecated This function was disabled due to security concerns.
+     */
+    tracek(tr: number, index: number): (any, number, number);
+}
+
+interface JitutilLib {
+    /**
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.util.tracemc
+     * @deprecated This function was disabled due to security concerns. It will always return 3 `0`s.
+     */
+    tracemc(tr: number): (string, number, number);
+}
+
+interface JitutilLib {
+    /**
+     * Return table fields:
+     * * 0 (ref) (number): first IR ref for the snapshot
+     * * 1 (nslots) (number): the number of valid slots
+     * * all indexes except first 2 and last (there might not be any of these): the snapshot map
+     * * last index in table (number): -16777216 (255 << 24)
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/jit.util.tracesnap
+     * @deprecated This function was disabled due to security concerns.
+     */
+    tracesnap(tr: number, sn: number): table;
+}
+

package/killicon.d.tlua

@@ -0,0 +1,84 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The killicon library is used to add to and control the icons that appear in the top right of your screen when a player is killed.
+ * @source https://wiki.facepunch.com/gmod/killicon
+ */
+declare killicon: KilliconLib;
+
+interface KilliconLib {
+    /**
+     * Creates new kill icon using a texture.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/killicon.Add
+     */
+    Add(_class: string, texture: string, color: Color): void;
+}
+
+interface KilliconLib {
+    /**
+     * Creates kill icon from existing one.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/killicon.AddAlias
+     */
+    AddAlias(new_class: string, existing_class: string): void;
+}
+
+interface KilliconLib {
+    /**
+     * Adds kill icon for given weapon/entity class using special font.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/killicon.AddFont
+     */
+    AddFont(_class: string, font: string, symbol: string, color: Color, heightScale?: number): void;
+}
+
+interface KilliconLib {
+    /**
+     * Creates new kill icon using a sub-rectangle of a texture.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/killicon.AddTexCoord
+     */
+    AddTexCoord(_class: string, texture: string, color: Color, x: number, y: number, w: number, h: number): void;
+}
+
+interface KilliconLib {
+    /**
+     * Draws a kill icon.
+     *
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/killicon.Draw
+     * @deprecated This function applies unpredictable vertical offsets, you should use killicon.Render instead, which does not suffer from this issue.
+     */
+    Draw(x: number, y: number, name: string, alpha?: number): void;
+}
+
+interface KilliconLib {
+    /**
+     * Checks if kill icon exists for given class.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/killicon.Exists
+     */
+    Exists(_class: string): boolean;
+}
+
+interface KilliconLib {
+    /**
+     * Returns the size of a kill icon.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/killicon.GetSize
+     */
+    GetSize(name: string, dontEqualizeHeight?: boolean): (number, number);
+}
+
+interface KilliconLib {
+    /**
+     * Renders a kill icon.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/killicon.Render
+     */
+    Render(x: number, y: number, name: string, alpha?: number, dontEqualizeHeight?: number): void;
+}
+

package/label.d.tlua

@@ -0,0 +1,20 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+interface Label extends Panel {
+    /**
+     * Sets the font used to draw the label text.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/Panel:SetFontInternal
+     */
+    SetFont(self: Label, fontName: string): void;
+
+    /**
+     * Sets the label text color.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/DLabel:SetTextColor
+     */
+    SetTextColor(self: Label, color: Color): void;
+}
+

package/language.d.tlua

@@ -0,0 +1,26 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The language library is used for translation.
+ * @source https://wiki.facepunch.com/gmod/language
+ */
+declare language: LanguageLib;
+
+interface LanguageLib {
+    /**
+     * Adds a language item. Language placeholders preceded with "#" are replaced with full text in Garry's Mod once registered with this function.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/language.Add
+     */
+    Add(placeholder: string, fulltext: string): void;
+}
+
+interface LanguageLib {
+    /**
+     * Retrieves the translated version of inputted string. Useful for concentrating multiple translated strings.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/language.GetPhrase
+     */
+    GetPhrase(phrase: string): string;
+}
+

package/list.d.tlua

@@ -0,0 +1,112 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The list library allows you add and retrieve values to and from lists. The list library is basically a fancy wrapper for a table, but with much more limited functionality.
+ *
+ * It is used extensively in the built-in Sandbox gamemode for addon-extensible lists of things (list of wheel models, list of thruster effects, etc) , without using global tables for this task.
+ *
+ * See [Default Lists](https://wiki.facepunch.com/gmod/Default_Lists) for a page of default Sandbox lists.
+ * @source https://wiki.facepunch.com/gmod/list
+ */
+declare list: ListLib;
+
+interface ListLib {
+    /**
+     * Adds an item to a named list.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/list.Add
+     */
+    Add(identifier: string, item: any): number;
+}
+
+interface ListLib {
+    /**
+     * Returns true if the list contains the value. (as a value - not a key)
+     *
+     * For a function that looks for a key and not a value see [list.HasEntry](https://wiki.facepunch.com/gmod/list.HasEntry).
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/list.Contains
+     */
+    Contains(list: string, value: any): boolean;
+}
+
+interface ListLib {
+    /**
+     * Returns a copy of the list stored at identifier.
+     * 	**WARNING**: This function uses [table.Copy](https://wiki.facepunch.com/gmod/table.Copy) which can be very slow for larger lists. You should avoid calling it repeatedly or in performance sensitive hooks such as [GM:Think](https://wiki.facepunch.com/gmod/GM:Think).
+     *
+     * 	Where possible you should use the much faster helper functions:
+     * 	  [list.Contains](https://wiki.facepunch.com/gmod/list.Contains),
+     * 	  [list.HasEntry](https://wiki.facepunch.com/gmod/list.HasEntry), or
+     * 	  [list.GetEntry](https://wiki.facepunch.com/gmod/list.GetEntry).
+     *
+     * 	There is also the more dangerous option of calling [list.GetForEdit](https://wiki.facepunch.com/gmod/list.GetForEdit) to get the unprotected list if you absolutely must iterate through it in a think hook.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/list.Get
+     */
+    Get(identifier: string): table;
+}
+
+interface ListLib {
+    /**
+     * Returns a copy of the entry in the list `list` with key `key`.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/list.GetEntry
+     */
+    GetEntry(list: string, key: string): any | nil;
+}
+
+interface ListLib {
+    /**
+     * Returns the actual table of the list stored at identifier. Modifying this will affect the stored list.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/list.GetForEdit
+     */
+    GetForEdit(identifier: string, dontCreate?: boolean): table;
+}
+
+interface ListLib {
+    /**
+     * Returns a list of all lists currently in use.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/list.GetTable
+     */
+    GetTable(): table;
+}
+
+interface ListLib {
+    /**
+     * Returns true if the list contains the given key.
+     *
+     * For a function that looks for values and not keys see [list.Contains](https://wiki.facepunch.com/gmod/list.Contains).
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/list.HasEntry
+     */
+    HasEntry(list: string, key: any): boolean;
+}
+
+interface ListLib {
+    /**
+     * Removes a single entry from the list `list` with key `key`.
+     *
+     * This is equivalent to `list.Set( myList, myKey, nil )`.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/list.RemoveEntry
+     */
+    RemoveEntry(list: string, key: string): void;
+}
+
+interface ListLib {
+    /**
+     * Sets a specific position in the named list to a value.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/list.Set
+     */
+    Set(identifier: string, key: any, item: any): void;
+}
+

package/makeballoon.d.tlua

@@ -0,0 +1,15 @@
+// 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.
+ *
+ * 	This function makes a balloon appear, similar to the one from the Toolgun.
+ *
+ * 	**WARNING**: This function doesn't make the rope attached to the balloon appear.
+ *
+ *
+ * @realm server
+ * @source https://wiki.facepunch.com/gmod/MakeBalloon
+ */
+declare function MakeBalloon(ply: Player, r?: number, g?: number, b?: number, force?: number, data?: BalloonData): Entity;
+

package/markup.d.tlua

@@ -0,0 +1,38 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The markup library only contains a single function to create a [MarkupObject](https://wiki.facepunch.com/gmod/MarkupObject).
+ * @source https://wiki.facepunch.com/gmod/markup
+ */
+declare markup: MarkupLib;
+
+interface MarkupLib {
+    /**
+     * A convenience function that converts a [Color](https://wiki.facepunch.com/gmod/Color) into its markup ready string representation.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/markup.Color
+     */
+    Color(col: Color): string;
+}
+
+interface MarkupLib {
+    /**
+     * Converts a string to its escaped, markup-safe equivalent.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/markup.Escape
+     */
+    Escape(text: string): string;
+}
+
+interface MarkupLib {
+    /**
+     * Parses markup into a [MarkupObject](https://wiki.facepunch.com/gmod/MarkupObject). Currently, this only supports fonts and colors as demonstrated in the example.
+     * 	**WARNING**: This function is very slow! Always cache its result.
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/markup.Parse
+     */
+    Parse(markup: string, maxWidth?: number): MarkupObject;
+}
+

package/markupobject.d.tlua

@@ -0,0 +1,53 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Object containing parsed markup for later rendering. Created by [markup.Parse](https://wiki.facepunch.com/gmod/markup.Parse).
+ * @source https://wiki.facepunch.com/gmod/MarkupObject
+ */
+interface MarkupObject {}
+
+interface MarkupObject {
+    /**
+     * Draws the computed markupobject to the screen. See [markup.Parse](https://wiki.facepunch.com/gmod/markup.Parse).
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/MarkupObject:Draw
+     */
+    Draw(self: MarkupObject, xOffset: number, yOffset: number, xAlign?: number, yAlign?: number, alphaoverride?: number, textAlign?: number): void;
+}
+
+interface MarkupObject {
+    /**
+     * Gets computed the height of the markupobject.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/MarkupObject:GetHeight
+     */
+    GetHeight(self: MarkupObject): number;
+}
+
+interface MarkupObject {
+    /**
+     * Gets maximum width for this markup object as defined in [markup.Parse](https://wiki.facepunch.com/gmod/markup.Parse).
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/MarkupObject:GetMaxWidth
+     */
+    GetMaxWidth(self: MarkupObject): number;
+}
+
+interface MarkupObject {
+    /**
+     * Gets computed the width of the markupobject.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/MarkupObject:GetWidth
+     */
+    GetWidth(self: MarkupObject): number;
+}
+
+interface MarkupObject {
+    /**
+     * Gets computed the width and height of the markupobject.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/MarkupObject:Size
+     */
+    Size(self: MarkupObject): (number, number);
+}
+

package/material.d.tlua

@@ -0,0 +1,9 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Material is a VGUI element that renders a VMT material.
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/Material
+ */
+interface Material extends Button {}
+