@tlua/gmod 1.0.1

package/saverestore.d.tlua

@@ -0,0 +1,148 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The saverestore library contains functions relating to the singleplayer save system built into the game.
+ * @source https://wiki.facepunch.com/gmod/saverestore
+ */
+declare saverestore: SaverestoreLib;
+
+interface SaverestoreLib {
+    /**
+     * Adds a restore/load hook for the Half-Life 2 save system.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.AddRestoreHook
+     */
+    AddRestoreHook(identifier: string, callback: (save: IRestore) => void): void;
+}
+
+interface SaverestoreLib {
+    /**
+     * Adds a save hook for the Half-Life 2 save system. You can use this to carry data through level transitions in Half-Life 2.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.AddSaveHook
+     */
+    AddSaveHook(identifier: string, callback: (save: ISave) => void): void;
+}
+
+interface SaverestoreLib {
+    /**
+     * Loads [Entity:GetTable](https://wiki.facepunch.com/gmod/Entity:GetTable) from the save game file that is being loaded and merges it with the given entitys [Entity:GetTable](https://wiki.facepunch.com/gmod/Entity:GetTable).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.LoadEntity
+     */
+    LoadEntity(ent: Entity, save: IRestore): void;
+}
+
+interface SaverestoreLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Called by engine when a save is being loaded.
+     *
+     * This handles loading gamemode and calls all of the hooks added with [saverestore.AddRestoreHook](https://wiki.facepunch.com/gmod/saverestore.AddRestoreHook).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.LoadGlobal
+     */
+    LoadGlobal(save: IRestore): void;
+}
+
+interface SaverestoreLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Called by the engine just before [saverestore.LoadGlobal](https://wiki.facepunch.com/gmod/saverestore.LoadGlobal) is.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.PreRestore
+     */
+    PreRestore(): void;
+}
+
+interface SaverestoreLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Called by the engine just before [saverestore.SaveGlobal](https://wiki.facepunch.com/gmod/saverestore.SaveGlobal) is.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.PreSave
+     */
+    PreSave(): void;
+}
+
+interface SaverestoreLib {
+    /**
+     * Reads a table from the save game file that is being loaded.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.ReadTable
+     */
+    ReadTable(save: IRestore): table;
+}
+
+interface SaverestoreLib {
+    /**
+     * Loads a variable from the save game file that is being loaded.
+     *
+     * Variables will be read in the save order you have saved them.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.ReadVar
+     */
+    ReadVar(save: IRestore): any;
+}
+
+interface SaverestoreLib {
+    /**
+     * Saves entitys [Entity:GetTable](https://wiki.facepunch.com/gmod/Entity:GetTable) to the save game file that is being saved.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.SaveEntity
+     */
+    SaveEntity(ent: Entity, save: ISave): void;
+}
+
+interface SaverestoreLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Called by engine when a save is being saved.
+     *
+     * This handles saving gamemode and calls all of the hooks added with [saverestore.AddSaveHook](https://wiki.facepunch.com/gmod/saverestore.AddSaveHook).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.SaveGlobal
+     */
+    SaveGlobal(save: ISave): void;
+}
+
+interface SaverestoreLib {
+    /**
+     * Returns how many writable keys are in the given table.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.WritableKeysInTable
+     */
+    WritableKeysInTable(table: table): number;
+}
+
+interface SaverestoreLib {
+    /**
+     * Write a table to a save game file that is being saved.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.WriteTable
+     */
+    WriteTable(table: table, save: ISave): void;
+}
+
+interface SaverestoreLib {
+    /**
+     * Writes a variable to the save game file that is being saved.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/saverestore.WriteVar
+     */
+    WriteVar(value: any, save: ISave): void;
+}
+

package/schedule.d.tlua

@@ -0,0 +1,69 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The object returned by [ai_schedule.New](https://wiki.facepunch.com/gmod/ai_schedule.New).
+ * @source https://wiki.facepunch.com/gmod/Schedule
+ */
+interface Schedule {}
+
+interface Schedule {
+    /**
+     * Adds a task to the schedule. See also [Schedule:AddTaskEx](https://wiki.facepunch.com/gmod/Schedule:AddTaskEx) if you wish to customize task start and run function names.
+     *
+     * See also [ENTITY:StartSchedule](https://wiki.facepunch.com/gmod/ENTITY:StartSchedule), [NPC:StartEngineTask](https://wiki.facepunch.com/gmod/NPC:StartEngineTask), and [NPC:RunEngineTask](https://wiki.facepunch.com/gmod/NPC:RunEngineTask).
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Schedule:AddTask
+     */
+    AddTask(self: Schedule, taskname: string, taskdata: any): void;
+}
+
+interface Schedule {
+    /**
+     * Adds a task to the schedule with completely custom function names.
+     *
+     * See also [Schedule:AddTask](https://wiki.facepunch.com/gmod/Schedule:AddTask).
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Schedule:AddTaskEx
+     */
+    AddTaskEx(self: Schedule, start: string, run: string, data: number): void;
+}
+
+interface Schedule {
+    /**
+     * Adds an engine task to the schedule.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Schedule:EngTask
+     */
+    EngTask(self: Schedule, taskname: string, taskdata: number): void;
+}
+
+interface Schedule {
+    /**
+     * Returns the task at the given index.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Schedule:GetTask
+     */
+    GetTask(self: Schedule, num: number): void;
+}
+
+interface Schedule {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *  Initialises the Schedule. Called by [ai_schedule.New](https://wiki.facepunch.com/gmod/ai_schedule.New) when the Schedule is created.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Schedule:Init
+     */
+    Init(self: Schedule, debugName: string): void;
+}
+
+interface Schedule {
+    /**
+     * Returns the number of tasks in the schedule.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Schedule:NumTasks
+     */
+    NumTasks(self: Schedule): number;
+}
+

package/scripted_ents.d.tlua

@@ -0,0 +1,124 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The scripted_ents library allows you to access information about any scripted entities loaded into the game, as well as register your own entities.
+ * @source https://wiki.facepunch.com/gmod/scripted_ents
+ */
+declare scripted_ents: Scripted_entsLib;
+
+interface Scripted_entsLib {
+    /**
+     * Defines an alias string that can be used to refer to another classname
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/scripted_ents.Alias
+     */
+    Alias(alias: string, classname: string): void;
+}
+
+interface Scripted_entsLib {
+    /**
+     * Returns a copy of the ENT table for a class, including functions defined by
+     * the base class.
+     *
+     * INTERNAL: used internally; although you're able to use it you probably shouldn't.
+     *
+     * NOTE: the wiki maps the classname string to the concrete ENT table type via a
+     * class-string generic; tlua cannot map a string literal to a nominal type, so
+     * this degrades to `table`.
+     * @realm shared
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/scripted_ents.Get
+     */
+    Get(classname: string): table;
+}
+
+
+interface Scripted_entsLib {
+    /**
+     * Returns a copy of the list of all ENT tables registered
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/scripted_ents.GetList
+     */
+    GetList(): Table<string, table>;
+}
+
+interface Scripted_entsLib {
+    /**
+     * Retrieves a member of an entity's table.
+     *
+     * NOTE: the wiki uses `std.ConstTpl`/`std.RawGet` to resolve the member type
+     * from the class-string and key; tlua cannot express that lookup, so the name
+     * is typed as `string` and the result degrades to `any`.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/scripted_ents.GetMember
+     */
+    GetMember(classname: string, name: string): any;
+}
+
+
+interface Scripted_entsLib {
+    /**
+     * Returns a list of all ENT tables which contain ENT.Spawnable
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/scripted_ents.GetSpawnable
+     */
+    GetSpawnable(): table;
+}
+
+interface Scripted_entsLib {
+    /**
+     * Returns the actual ENT table for a class. Modifying functions/variables in this table will change newly spawned entities
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/scripted_ents.GetStored
+     */
+    GetStored(classname: string): table;
+}
+
+interface Scripted_entsLib {
+    /**
+     * Returns the 'type' of a class, this will one of the following: 'anim', 'ai', 'brush', 'point'.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/scripted_ents.GetType
+     */
+    GetType(classname: string): string;
+}
+
+interface Scripted_entsLib {
+    /**
+     * Checks if name is based on base
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/scripted_ents.IsBasedOn
+     */
+    IsBasedOn(name: string, base: string): boolean;
+}
+
+interface Scripted_entsLib {
+    /**
+     * 	**INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Called after all ENTS have been loaded and runs [baseclass.Set](https://wiki.facepunch.com/gmod/baseclass.Set) on each one.
+     *
+     * You can retrieve all the currently registered ENTS with [scripted_ents.GetList](https://wiki.facepunch.com/gmod/scripted_ents.GetList).
+     *
+     * **NOTE**: This is not called after an ENT auto refresh, and thus the inherited baseclass functions retrieved with [baseclass.Get](https://wiki.facepunch.com/gmod/baseclass.Get) will not be updated
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/scripted_ents.OnLoaded
+     */
+    OnLoaded(): void;
+}
+
+interface Scripted_entsLib {
+    /**
+     * Registers an ENT table with a classname. Reregistering an existing classname will automatically update the functions of all existing entities of that class.
+     *
+     * Sub-tables provided in the first argument will not carry over their metatable, and will receive a BaseClass key if the table was merged with the base's. Userdata references, which includes Vectors, Angles, Entities, etc. will not be copied.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/scripted_ents.Register
+     */
+    Register(ENT: ENT, classname: string): void;
+}
+

package/search.d.tlua

@@ -0,0 +1,26 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The search library
+ * @source https://wiki.facepunch.com/gmod/search
+ */
+declare search: SearchLib;
+
+interface SearchLib {
+    /**
+     * Adds a search result provider. For examples, see [gamemodes/sandbox/gamemode/cl_search_models.lua](https://github.com/Facepunch/garrysmod/blob/7c23addd2c35d3d046c80e3d0cb6052055eca3e2/garrysmod/gamemodes/sandbox/gamemode/cl_search_models.lua)
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/search.AddProvider
+     */
+    AddProvider(provider: (searchQuery: string) => table, id?: string): void;
+}
+
+interface SearchLib {
+    /**
+     * Retrieves search results.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/search.GetResults
+     */
+    GetResults(query: string, types?: string, maxResults?: number): table;
+}
+

package/serverlist.d.tlua

@@ -0,0 +1,85 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Menu state library to query the master server list.
+ * @source https://wiki.facepunch.com/gmod/serverlist
+ */
+declare serverlist: ServerlistLib;
+
+interface ServerlistLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Adds current server the player is on to their favorites.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/serverlist.AddCurrentServerToFavorites
+     */
+    AddCurrentServerToFavorites(addOrRemove: boolean): void;
+}
+
+interface ServerlistLib {
+    /**
+     * 		Adds the given server address to their favorites.
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/serverlist.AddServerToFavorites
+     */
+    AddServerToFavorites(address: string): void;
+}
+
+interface ServerlistLib {
+    /**
+     * 		Returns true if the current server address is in their favorites.
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/serverlist.IsCurrentServerFavorite
+     */
+    IsCurrentServerFavorite(): boolean;
+}
+
+interface ServerlistLib {
+    /**
+     * 		Returns true if the given server address is in their favorites.
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/serverlist.IsServerFavorite
+     */
+    IsServerFavorite(address: string): boolean;
+}
+
+interface ServerlistLib {
+    /**
+     * Queries a server for its information/ping.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/serverlist.PingServer
+     */
+    PingServer(ip: string, callback: function): void;
+}
+
+interface ServerlistLib {
+    /**
+     * Queries a server for its player list.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/serverlist.PlayerList
+     */
+    PlayerList(ip: string, callback: (data: table) => void): void;
+}
+
+interface ServerlistLib {
+    /**
+     * Queries the master server for server list.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/serverlist.Query
+     */
+    Query(data: ServerQueryData): void;
+}
+
+interface ServerlistLib {
+    /**
+     * 		Removes the given server address from their favorites.
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/serverlist.RemoveServerFromFavorites
+     */
+    RemoveServerFromFavorites(address: string): void;
+}
+

package/slidebar.d.tlua

@@ -0,0 +1,12 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		Used as scroll bar for [PanelList](https://wiki.facepunch.com/gmod/PanelList)
+ *
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/SlideBar
+ * @deprecated Used in deprecated  PanelList. Use DVScrollBar (Used in DScrollPanel).
+ */
+interface SlideBar extends Panel {}
+

package/slider.d.tlua

@@ -0,0 +1,11 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		A simple slider featuring an numeric display.
+ *
+ * @realm client and menu
+ * @source https://wiki.facepunch.com/gmod/Slider
+ * @deprecated Only exists for backwards compatibility with Panel:SetActionFunction and Panel:PostMessage. 			Use DNumSlider instead.
+ */
+interface Slider extends Panel {}
+

package/sound.d.tlua

@@ -0,0 +1,140 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Used primarily for adding new soundscript entries.
+ * @source https://wiki.facepunch.com/gmod/sound
+ */
+declare sound: SoundLib;
+
+interface SoundLib {
+    /**
+     * Creates a [sound scripts](https://developer.valvesoftware.com/wiki/Soundscripts). It can also override sounds, which seems to only work when set on the server.
+     *
+     * You can find a list of common sound scripts that are shipped with the game by default here: [Common Sounds](https://wiki.facepunch.com/gmod/Common_Sounds).
+     *
+     * A list of sound scripts can be retrieved with [sound.GetTable](https://wiki.facepunch.com/gmod/sound.GetTable).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/sound.Add
+     */
+    Add(soundData: SoundData): void;
+}
+
+interface SoundLib {
+    /**
+     * Overrides [sound scripts](https://developer.valvesoftware.com/wiki/Soundscripts) defined inside of a `.txt` file; typically used for adding map-specific sounds.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/sound.AddSoundOverrides
+     */
+    AddSoundOverrides(filepath: string): void;
+}
+
+interface SoundLib {
+    /**
+     * Emits a sound hint to the game elements to react to, for example to repel or attract antlions.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/sound.EmitHint
+     */
+    EmitHint(hint: number, pos: Vector, volume: number, duration: number, owner?: Entity): void;
+}
+
+interface SoundLib {
+    /**
+     * Creates a sound from a function.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/sound.Generate
+     */
+    Generate(identifier: string, samplerate: number, length: number, callbackOrData: (sampleIndex: number) => number | table, loopStart?: number): void;
+}
+
+interface SoundLib {
+    /**
+     * Returns the most dangerous/closest sound hint based on given location and types of sounds to sense.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/sound.GetLoudestSoundHint
+     */
+    GetLoudestSoundHint(types: number, pos: Vector): table;
+}
+
+interface SoundLib {
+    /**
+     * Returns properties of a [sound script](https://developer.valvesoftware.com/wiki/Soundscripts).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/sound.GetProperties
+     */
+    GetProperties(name: string): SoundData;
+}
+
+interface SoundLib {
+    /**
+     * Returns a list of all registered [sound scripts](https://developer.valvesoftware.com/wiki/Soundscripts).
+     *
+     * New ones can be registered using [sound.Add](https://wiki.facepunch.com/gmod/sound.Add), and detailed information about each one can be retrieved via [sound.GetProperties](https://wiki.facepunch.com/gmod/sound.GetProperties).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/sound.GetTable
+     */
+    GetTable(): string[];
+}
+
+interface SoundLib {
+    /**
+     * Plays a sound from the specified position in the world.
+     * If you want to play a sound without a position, such as a UI sound, use [surface.PlaySound](https://wiki.facepunch.com/gmod/surface.PlaySound) instead.
+     *
+     * This function is similar to [Global.EmitSound](https://wiki.facepunch.com/gmod/Global.EmitSound), but with less options.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/sound.Play
+     */
+    Play(snd: string, pos: Vector, level?: number, pitch?: number, volume?: number, dsp?: number): void;
+}
+
+interface SoundLib {
+    /**
+     * Plays a file from GMod directory. You can find a list of all error codes [here](http://www.un4seen.com/doc/#bass/BASS_ErrorGetCode.html)
+     *
+     * For external file/stream playback, see [sound.PlayURL](https://wiki.facepunch.com/gmod/sound.PlayURL).
+     *
+     * This fails for looping .wav files in 3D mode.
+     *
+     * This fails with unicode file names.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/sound.PlayFile
+     */
+    PlayFile(path: string, flags: string, callback: (channel: IGModAudioChannel, errorID: number, errorName: string) => void): void;
+}
+
+interface SoundLib {
+    /**
+     * Allows you to play external sound files, as well as online radio streams.
+     * You can find a list of all error codes [here](http://www.un4seen.com/doc/#bass/BASS_ErrorGetCode.html)
+     *
+     * For offline file playback, see [sound.PlayFile](https://wiki.facepunch.com/gmod/sound.PlayFile).
+     *
+     * Due to a bug with [BASS](http://www.un4seen.com/), AAC codec streams cannot be played in 3D mode.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/sound.PlayURL
+     */
+    PlayURL(url: string, flags: string, callback: (channel: IGModAudioChannel, errorID: number, errorName: string) => void): void;
+}
+
+interface SoundLib {
+    /**
+     * Sets the gender of a specific actor (model). This is a system from [base Half-Life 2](https://developer.valvesoftware.com/wiki/Global_actors) - `global_actors.txt`.
+     *
+     * This will affect what voice lines `npc_citizen` will use when they have the given model set.
+     *
+     * It is not limited to `npc_citizens` - any sound played on any entity with given model can have gender specific sounds playing, including soundscripts, by including `$gender` token in the sound file path.
+     *
+     * **WARNING**: Internally the gender is stored by model file name only (i.e. `models/alyx.mdl` would be stored as `alyx`), not the full path! Be aware of potential collisions.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/sound.SetActorGender
+     */
+    SetActorGender(modelPath: string, gender: string): void;
+}
+