@tlua/gmod 1.0.1

package/README.md

@@ -0,0 +1,28 @@
+# @tlua/gmod
+
+Garry's Mod type declarations for the [tlua](https://github.com/) type checker,
+generated from the [GMod Wiki](https://wiki.facepunch.com/gmod/). Generated file --
+do not edit by hand.
+
+## Install
+
+```sh
+npm install @tlua/gmod
+npm install @tlua/gmod@beta   # pre-release
+```
+
+## Use
+
+List the package under `types` in your `tluaconfig.json` (tlua only loads type
+packages named in `types`; use `"*"` to opt into all installed ones):
+
+```jsonc
+{
+  "compilerOptions": {
+    "types": ["@tlua/gmod"]
+  }
+}
+```
+
+The Garry's Mod globals (`Entity`, `Vector`, `hook`, `_G` entries, …) are then
+available ambiently, with no `require`.

package/__metadata.json

@@ -0,0 +1,4 @@
+{
+  "lastUpdate": "2026-07-20T00:41:24.000Z",
+  "baseUrl": "https://wiki.facepunch.com/gmod"
+}

package/_globals.d.tlua

@@ -0,0 +1,178 @@
+// Source: https://wiki.facepunch.com/gmod/Global_Variables
+
+// ---- Global tables ----
+
+declare GAMEMODE: GM;
+
+type GPlayer = Player;
+
+/** Contains a list of all modules loaded from /modules/. */
+declare _MODULES: Table<string, any>;
+
+// ---- Global non-constants ----
+
+/** True whenever the current script is executed on the client (client and menu states). */
+declare CLIENT: boolean;
+/** True whenever the current script is executed on the client state. */
+declare CLIENT_DLL: boolean;
+/** True whenever the current script is executed on the server state. */
+declare SERVER: boolean;
+/** True whenever the current script is executed on the server state. */
+declare GAME_DLL: boolean;
+/** True when the script is being executed in the menu state. */
+declare MENU_DLL: boolean;
+/** Contains the name of the current active gamemode. */
+declare GAMEMODE_NAME: string;
+
+/** Represents a non-existent entity. It is not nil; use IsValid before calling Entity methods. */
+interface NULL extends Entity {}
+
+type EntityOrNULL = Entity | NULL;
+
+declare NULL: NULL;
+
+/** Contains the version number of GMod. Example: "201211". */
+declare VERSION: string;
+/** Contains a nicely formatted version of GMod. Example: "2020.12.11". */
+declare VERSIONSTR: string;
+/** Contains the current networking version. Menu state only. */
+declare NETVERSIONSTR: string;
+/** The branch the game is running on. "unknown" on main branch. */
+declare BRANCH: string;
+// _VERSION is provided by tlua's own global library; not re-declared here.
+/** Maximum number of bits needed to network any entity. */
+declare MAX_EDICT_BITS: number;
+/** Maximum number of bits needed to network a player. */
+declare MAX_PLAYER_BITS: number;
+
+/** The active env_skypaint entity. */
+declare g_SkyPaint: ENT;
+// Panels that are registered as globals below but have no wiki page of their own, so
+// they never get a generated interface. Stub them as base panels.
+interface VoiceNotify extends Panel {}
+interface DVerticalDividerBar extends Panel {}
+interface DHorizontalDividerBar extends Panel {}
+
+/** Base panel used for context menus. */
+declare g_ContextMenu: PANEL;
+/** Base panel for displaying incoming/outgoing voice messages. */
+declare g_VoicePanelList: PANEL;
+/** Base panel for the spawn menu. */
+declare g_SpawnMenu: PANEL;
+/** Main menu of GMod. Only available in the menu state. */
+declare pnlMainMenu: PANEL;
+
+// ---- Global constants ----
+
+/** A vector with all values set to 0. */
+declare vector_origin: Vector;
+/** A vector with the z value set to 1. */
+declare vector_up: Vector;
+/** An Angle with all values set to 0. */
+declare angle_zero: Angle;
+/** A color with all values set to 255. */
+declare color_white: Color;
+/** A color with all values set to 0 except alpha which is set to 255. */
+declare color_black: Color;
+/** A color with only the alpha value set to 0. */
+declare color_transparent: Color;
+
+// ---- Derma panel globals (defined via derma.DefineControl) ----
+
+declare DIconLayout: DIconLayout;
+declare DMenuOptionCVar: DMenuOptionCVar;
+declare DPanelList: DPanelList;
+declare DListView_Line: DListView_Line;
+declare DNumSlider: DNumSlider;
+declare DPanelOverlay: DPanelOverlay;
+declare DListView_ColumnPlain: DListView_ColumnPlain;
+declare DDragBase: DDragBase;
+declare DIconBrowser: DIconBrowser;
+declare DHTML: DHTML;
+declare DCategoryList: DCategoryList;
+declare DImage: DImage;
+declare DTextEntry: DTextEntry;
+declare DListView_DraggerBar: DListView_DraggerBar;
+declare DColorMixer: DColorMixer;
+declare DFrame: DFrame;
+declare DCheckBox: DCheckBox;
+declare DColorCombo: DColorCombo;
+declare DScrollBarGrip: DScrollBarGrip;
+declare Slider: Slider;
+declare DHorizontalDivider: DHorizontalDivider;
+declare DSlider: DSlider;
+declare DForm: DForm;
+declare DNumPad: DNumPad;
+declare DListViewLine: DListViewLine;
+declare DPanelSelect: DPanelSelect;
+declare DListView_Column: DListView_Column;
+declare DListViewHeaderLabel: DListViewHeaderLabel;
+declare DDrawer: DDrawer;
+declare DScrollPanel: DScrollPanel;
+declare DListBoxItem: DListBoxItem;
+declare DListView: DListView;
+declare DCollapsibleCategory: DCollapsibleCategory;
+declare DImageButton: DImageButton;
+declare DListLayout: DListLayout;
+declare DBinder: DBinder;
+declare DNotify: DNotify;
+declare DColorButton: DColorButton;
+declare VoiceNotify: VoiceNotify;
+declare DColorPalette: DColorPalette;
+declare DNumberScratch: DNumberScratch;
+declare DPanel: DPanel;
+declare DListViewLabel: DListViewLabel;
+declare DProperty_Int: DProperty_Int;
+declare DProperty_VectorColor: DProperty_VectorColor;
+declare DPropertySheet: DPropertySheet;
+declare DProperty_Entity: DProperty_Entity;
+declare DProperty_Float: DProperty_Float;
+declare DProperty_Combo: DProperty_Combo;
+declare DHScrollBar: DHScrollBar;
+declare DEntityProperties: DEntityProperties;
+declare DProperty_Boolean: DProperty_Boolean;
+declare DVScrollBar: DVScrollBar;
+declare DVerticalDivider: DVerticalDivider;
+declare DHTMLControls: DHTMLControls;
+declare DVerticalDividerBar: DVerticalDividerBar;
+declare DTree_Node_Button: DTree_Node_Button;
+declare DNumberWang: DNumberWang;
+declare DTree_Node: DTree_Node;
+declare DLabelEditable: DLabelEditable;
+declare DGrid: DGrid;
+declare DTooltip: DTooltip;
+declare DLabel: DLabel;
+declare DExpandButton: DExpandButton;
+declare DKillIcon: DKillIcon;
+declare DMenu: DMenu;
+declare DCategoryHeader: DCategoryHeader;
+declare DTileLayout: DTileLayout;
+declare DSprite: DSprite;
+declare DModelSelect: DModelSelect;
+declare DSizeToContents: DSizeToContents;
+declare DShape: DShape;
+declare DRGBPicker: DRGBPicker;
+declare DModelSelectMulti: DModelSelectMulti;
+declare DMenuOption: DMenuOption;
+declare DProperty_Generic: DProperty_Generic;
+declare DMenuBar: DMenuBar;
+declare DCheckBoxLabel: DCheckBoxLabel;
+declare DTab: DTab;
+declare DProperties: DProperties;
+declare DProgress: DProgress;
+declare DAlphaBar: DAlphaBar;
+declare DPanPanel: DPanPanel;
+declare DModelPanel: DModelPanel;
+declare DFileBrowser: DFileBrowser;
+declare DColorCube: DColorCube;
+declare Button: Button;
+declare DListBox: DListBox;
+declare DAdjustableModelPanel: DAdjustableModelPanel;
+declare DComboBox: DComboBox;
+declare DColumnSheet: DColumnSheet;
+declare DButton: DButton;
+declare DHorizontalDividerBar: DHorizontalDividerBar;
+declare DBubbleContainer: DBubbleContainer;
+declare DTree: DTree;
+declare DLabelURL: DLabelURL;
+declare DHorizontalScroller: DHorizontalScroller;

package/_gmod-std.d.tlua

@@ -0,0 +1,35 @@
+// gmod-std: tlua equivalents for the gmod-glua-ls addon's `std.*` utility types.
+//
+// The LuaLS addon exposes a `std` namespace of advanced meta-types. This file
+// reimplements the ones tlua's type system can express and documents the
+// deliberate degradations for the ones it cannot.
+//
+// Expressible here:
+//   - LuaType   (std.type)      union of the strings Lua's type() returns
+//   - NotNull   (std.NotNull)   drop nil from a union
+//   - ConstTpl  (std.ConstTpl)  identity that preserves a string-literal argument
+//
+// Expressible here (continued):
+//   - Split     (std.Split)     recursive tuple split of a literal string
+//
+// Degraded (see NOTES for why):
+//   - RawGet/Select/Unpack      -> native     tlua's checker already refines these
+//   - @operator (Vector/Angle)  -> methods     tlua has no ambient operator typing
+
+/** The string values returned by Lua's `type()`. */
+type LuaType = "nil" | "number" | "string" | "boolean" | "table" | "function" | "thread" | "userdata";
+
+/** Drops `nil` from a union, e.g. the non-nil result of a successful `assert`. */
+type NotNull<T> = NonNullable<T>;
+
+/** Identity that preserves a string-literal type argument through a signature. */
+type ConstTpl<T extends string> = T;
+
+/**
+ * GLua `string.Explode`/`string.Split` return a sequential table of pieces.
+ * A literal input splits into a precise tuple of literal pieces (1-based, like
+ * every tlua tuple); a plain `string` input degrades to `string[]`.
+ */
+type Split<Sep extends string, Str extends string> =
+    string extends Str ? string[] :
+    Str extends `${infer Head}${Sep}${infer Tail}` ? [Head, ...Split<Sep, Tail>] : [Str];

package/achievementicon.d.tlua

@@ -0,0 +1,12 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		Used to show an icon for any of the [Garry's Mod Steam achievements](http://steamcommunity.com/stats/GarrysMod/achievements).
+ *
+ * 		If the viewer has not unlocked the achievement on Steam, the icon will be grayed out.
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/AchievementIcon
+ */
+interface AchievementIcon extends Panel {}
+

package/achievements.d.tlua

@@ -0,0 +1,162 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * This library is used internally by Garry's Mod to help keep track of achievement progress and unlock the appropriate achievements once a certain number is reached.
+ * @source https://wiki.facepunch.com/gmod/achievements
+ */
+declare achievements: AchievementsLib;
+
+interface AchievementsLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Adds one to the count of balloons burst. Once this count reaches 1000, the 'Popper' achievement is unlocked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/achievements.BalloonPopped
+     */
+    BalloonPopped(): void;
+}
+
+interface AchievementsLib {
+    /**
+     * Returns the amount of achievements currently in Garry's Mod.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/achievements.Count
+     */
+    Count(): number;
+}
+
+interface AchievementsLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Adds one to the count of balls eaten. Once this count reaches 200, the 'Ball Eater' achievement is unlocked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/achievements.EatBall
+     */
+    EatBall(): void;
+}
+
+interface AchievementsLib {
+    /**
+     * Retrieves progress of given achievement.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/achievements.GetCount
+     */
+    GetCount(achievementID: number): number;
+}
+
+interface AchievementsLib {
+    /**
+     * Retrieves the description of the given achievement.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/achievements.GetDesc
+     */
+    GetDesc(achievementID: number): string;
+}
+
+interface AchievementsLib {
+    /**
+     * Retrieves the end progress goal of the given achievement.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/achievements.GetGoal
+     */
+    GetGoal(achievementID: number): number;
+}
+
+interface AchievementsLib {
+    /**
+     * Retrieves the name of the given achievement.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/achievements.GetName
+     */
+    GetName(achievementID: number): string;
+}
+
+interface AchievementsLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Adds one to the count of baddies killed. Once this count reaches 1000, the 'War Zone' achievement is unlocked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/achievements.IncBaddies
+     */
+    IncBaddies(): void;
+}
+
+interface AchievementsLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Adds one to the count of innocent animals killed. Once this count reaches 1000, the 'Innocent Bystander' achievement is unlocked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/achievements.IncBystander
+     */
+    IncBystander(): void;
+}
+
+interface AchievementsLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Adds one to the count of friendly NPCs killed. Once this count reaches 1000, the 'Bad Friend' achievement is unlocked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/achievements.IncGoodies
+     */
+    IncGoodies(): void;
+}
+
+interface AchievementsLib {
+    /**
+     * Returns whether the given achievement is obtained or not.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/achievements.IsAchieved
+     */
+    IsAchieved(achievementID: number): boolean;
+}
+
+interface AchievementsLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Adds one to the count of things removed. Once this count reaches 5000, the 'Destroyer' achievement is unlocked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/achievements.Remover
+     */
+    Remover(): void;
+}
+
+interface AchievementsLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Adds one to the count of how many times the spawnmenu has been opened. Once this count reaches 100,000, the 'Menu User' achievement is unlocked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/achievements.SpawnMenuOpen
+     */
+    SpawnMenuOpen(): void;
+}
+
+interface AchievementsLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Adds one to the count of NPCs spawned. Once this count reaches 1000, the 'Procreator' achievement is unlocked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/achievements.SpawnedNPC
+     */
+    SpawnedNPC(): void;
+}
+
+interface AchievementsLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Adds one to the count of props spawned. Once this count reaches 5000, the 'Creator' achievement is unlocked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/achievements.SpawnedProp
+     */
+    SpawnedProp(): void;
+}
+
+interface AchievementsLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Adds one to the count of ragdolls spawned. Once this count reaches 2000, the 'Dollhouse' achievement is unlocked.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/achievements.SpawnedRagdoll
+     */
+    SpawnedRagdoll(): void;
+}
+

package/ai.d.tlua

@@ -0,0 +1,65 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The ai library.
+ * @source https://wiki.facepunch.com/gmod/ai
+ */
+declare ai: AiLib;
+
+interface AiLib {
+    /**
+     * Returns the number of AI nodes on the map, used by the base game [NPC](https://wiki.facepunch.com/gmod/NPC)s.
+     *
+     * For [NextBot](https://wiki.facepunch.com/gmod/NextBot)s, see [navmesh](https://wiki.facepunch.com/gmod/navmesh).
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/ai.GetNodeCount
+     */
+    GetNodeCount(): number;
+}
+
+interface AiLib {
+    /**
+     * Translates a schedule name to its corresponding ID.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/ai.GetScheduleID
+     */
+    GetScheduleID(sched: string): number;
+}
+
+interface AiLib {
+    /**
+     * Returns the squad leader of the given squad.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/ai.GetSquadLeader
+     */
+    GetSquadLeader(squad: string): NPC;
+}
+
+interface AiLib {
+    /**
+     * Returns the amount of members a given squad has. See also [ai.GetSquadMembers](https://wiki.facepunch.com/gmod/ai.GetSquadMembers).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/ai.GetSquadMemberCount
+     */
+    GetSquadMemberCount(squad: string): number;
+}
+
+interface AiLib {
+    /**
+     * Returns all members of a given squad. See also [ai.GetSquadMemberCount](https://wiki.facepunch.com/gmod/ai.GetSquadMemberCount) and [NPC:GetSquad](https://wiki.facepunch.com/gmod/NPC:GetSquad).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/ai.GetSquadMembers
+     */
+    GetSquadMembers(squad: string): table;
+}
+
+interface AiLib {
+    /**
+     * Translates a task name to its corresponding ID.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/ai.GetTaskID
+     */
+    GetTaskID(task: string): number;
+}
+

package/ai_schedule.d.tlua

@@ -0,0 +1,17 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Allows you to set up a schedule for NPCs to follow. This lets you dictate their actions.
+ * @source https://wiki.facepunch.com/gmod/ai_schedule
+ */
+declare ai_schedule: Ai_scheduleLib;
+
+interface Ai_scheduleLib {
+    /**
+     * Creates a schedule for scripted NPC.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/ai_schedule.New
+     */
+    New(name: string): table;
+}
+

package/ai_task.d.tlua

@@ -0,0 +1,17 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Used to create tasks for scripted NPCs.
+ * @source https://wiki.facepunch.com/gmod/ai_task
+ */
+declare ai_task: Ai_taskLib;
+
+interface Ai_taskLib {
+    /**
+     * Create a new empty task. Used by [Schedule:AddTask](https://wiki.facepunch.com/gmod/Schedule:AddTask) and [Schedule:EngTask](https://wiki.facepunch.com/gmod/Schedule:EngTask).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/ai_task.New
+     */
+    New(): Task;
+}
+