@tlua/gmod 1.0.5 → 1.0.6

package/types/search.d.tlua

@@ -13,6 +13,7 @@ interface SearchLib {
      * @source https://wiki.facepunch.com/gmod/search.AddProvider
      */
     AddProvider(provider: (searchQuery: string) => table, id?: string): void;
+
     /**
      * Retrieves search results.
      * @realm client
@@ -20,5 +21,3 @@ interface SearchLib {
      */
     GetResults(query: string, types?: string, maxResults?: number): table;
 }
-
-

package/types/serverlist.d.tlua

@@ -14,6 +14,7 @@ interface ServerlistLib {
      * @source https://wiki.facepunch.com/gmod/serverlist.AddCurrentServerToFavorites
      */
     AddCurrentServerToFavorites(addOrRemove: boolean): void;
+
     /**
      * 		Adds the given server address to their favorites.
      *
@@ -21,6 +22,7 @@ interface ServerlistLib {
      * @source https://wiki.facepunch.com/gmod/serverlist.AddServerToFavorites
      */
     AddServerToFavorites(address: string): void;
+
     /**
      * 		Returns true if the current server address is in their favorites.
      *
@@ -28,6 +30,7 @@ interface ServerlistLib {
      * @source https://wiki.facepunch.com/gmod/serverlist.IsCurrentServerFavorite
      */
     IsCurrentServerFavorite(): boolean;
+
     /**
      * 		Returns true if the given server address is in their favorites.
      *
@@ -35,24 +38,28 @@ interface ServerlistLib {
      * @source https://wiki.facepunch.com/gmod/serverlist.IsServerFavorite
      */
     IsServerFavorite(address: string): boolean;
+
     /**
      * Queries a server for its information/ping.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/serverlist.PingServer
      */
     PingServer(ip: string, callback: function): void;
+
     /**
      * 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;
+
     /**
      * Queries the master server for server list.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/serverlist.Query
      */
     Query(data: ServerQueryData): void;
+
     /**
      * 		Removes the given server address from their favorites.
      *
@@ -61,11 +68,3 @@ interface ServerlistLib {
      */
     RemoveServerFromFavorites(address: string): void;
 }
-
-
-
-
-
-
-
-

package/types/slidebar.d.tlua

@@ -9,4 +9,3 @@
  * @deprecated Used in deprecated  PanelList. Use DVScrollBar (Used in DScrollPanel).
  */
 interface SlideBar extends Panel {}
-

package/types/slider.d.tlua

@@ -8,4 +8,3 @@
  * @deprecated Only exists for backwards compatibility with Panel:SetActionFunction and Panel:PostMessage. 			Use DNumSlider instead.
  */
 interface Slider extends Panel {}
-

package/types/sound.d.tlua

@@ -18,18 +18,21 @@ interface SoundLib {
      * @source https://wiki.facepunch.com/gmod/sound.Add
      */
     Add(soundData: SoundData): void;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * Creates a sound from a function.
      *
@@ -37,18 +40,21 @@ interface SoundLib {
      * @source https://wiki.facepunch.com/gmod/sound.Generate
      */
     Generate(identifier: string, samplerate: number, length: number, callbackOrData: (sampleIndex: number) => number | table, loopStart?: number): void;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * Returns a list of all registered [sound scripts](https://developer.valvesoftware.com/wiki/Soundscripts).
      *
@@ -57,6 +63,7 @@ interface SoundLib {
      * @source https://wiki.facepunch.com/gmod/sound.GetTable
      */
     GetTable(): string[];
+
     /**
      * 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.
@@ -67,6 +74,7 @@ interface SoundLib {
      * @source https://wiki.facepunch.com/gmod/sound.Play
      */
     Play(snd: string, pos: Vector, level?: number, pitch?: number, volume?: number, dsp?: number): void;
+
     /**
      * 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)
      *
@@ -80,6 +88,7 @@ interface SoundLib {
      * @source https://wiki.facepunch.com/gmod/sound.PlayFile
      */
     PlayFile(path: string, flags: string, callback: (channel: IGModAudioChannel, errorID: number, errorName: string) => void): void;
+
     /**
      * 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)
@@ -92,6 +101,7 @@ interface SoundLib {
      * @source https://wiki.facepunch.com/gmod/sound.PlayURL
      */
     PlayURL(url: string, flags: string, callback: (channel: IGModAudioChannel, errorID: number, errorName: string) => void): void;
+
     /**
      * 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`.
      *
@@ -107,14 +117,3 @@ interface SoundLib {
      */
     SetActorGender(modelPath: string, gender: string): void;
 }
-
-
-
-
-
-
-
-
-
-
-

package/types/spawnicon.d.tlua

@@ -18,6 +18,7 @@ interface SpawnIcon extends DButton {
      * @source https://wiki.facepunch.com/gmod/SpawnIcon:GetBodyGroup
      */
     GetBodyGroup(self: SpawnIcon): string;
+
     /**
      * Returns the currently set model name. This is set by [SpawnIcon:SetModelName](https://wiki.facepunch.com/gmod/SpawnIcon:SetModelName).
      *
@@ -25,6 +26,7 @@ interface SpawnIcon extends DButton {
      * @source https://wiki.facepunch.com/gmod/SpawnIcon:GetModelName
      */
     GetModelName(self: SpawnIcon): string;
+
     /**
      * Returns the currently set skin of the spawnicon. This is set by [SpawnIcon:SetSkinID](https://wiki.facepunch.com/gmod/SpawnIcon:SetSkinID).
      *
@@ -32,6 +34,7 @@ interface SpawnIcon extends DButton {
      * @source https://wiki.facepunch.com/gmod/SpawnIcon:GetSkinID
      */
     GetSkinID(self: SpawnIcon): number;
+
     /**
      * Called when right clicked on the SpawnIcon. It will not be called if there is a selection ([Panel:GetSelectionCanvas](https://wiki.facepunch.com/gmod/Panel:GetSelectionCanvas)), in which case [SANDBOX:SpawnlistOpenGenericMenu](https://wiki.facepunch.com/gmod/SANDBOX:SpawnlistOpenGenericMenu) is called.
      *
@@ -39,6 +42,7 @@ interface SpawnIcon extends DButton {
      * @source https://wiki.facepunch.com/gmod/SpawnIcon:OpenMenu
      */
     OpenMenu(self: SpawnIcon): void;
+
     /**
      * 		**INTERNAL**: This is done automatically by SpawnIcon. You do not need to call this. Doing so may cause unforeseen consequences.
      *
@@ -51,6 +55,7 @@ interface SpawnIcon extends DButton {
      * @source https://wiki.facepunch.com/gmod/SpawnIcon:SetBodyGroup
      */
     SetBodyGroup(self: SpawnIcon, bodyGroupId: number, activeSubModelId: number): void;
+
     /**
      * **INTERNAL**: This is done automatically by SpawnIcon. You do not need to call this. Doing so may cause unforeseen consequences.
      *
@@ -61,6 +66,7 @@ interface SpawnIcon extends DButton {
      * @source https://wiki.facepunch.com/gmod/SpawnIcon:SetModelName
      */
     SetModelName(self: SpawnIcon, mdl: string): void;
+
     /**
      * **INTERNAL**: This is done automatically by SpawnIcon. You do not need to call this. Doing so may cause unforeseen consequences.
      *
@@ -72,11 +78,3 @@ interface SpawnIcon extends DButton {
      */
     SetSkinID(self: SpawnIcon, skin: number): void;
 }
-
-
-
-
-
-
-
-

package/types/spawnmenu.d.tlua

@@ -13,18 +13,21 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.ActivateTool
      */
     ActivateTool(tool: string, menu_only?: boolean): void;
+
     /**
      * Activates tools context menu in specified tool tab.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/spawnmenu.ActivateToolPanel
      */
     ActivateToolPanel(tab: number, cp: Panel): void;
+
     /**
      * Returns currently opened control panel of a tool, post process effect or some other menu in spawnmenu.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/spawnmenu.ActiveControlPanel
      */
     ActiveControlPanel(): Panel;
+
     /**
      * Registers a new content type that is saveable into spawnlists.
      * Created/called by [spawnmenu.CreateContentIcon](https://wiki.facepunch.com/gmod/spawnmenu.CreateContentIcon).
@@ -33,6 +36,7 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.AddContentType
      */
     AddContentType(name: string, constructor: (container: Panel, data: table) => Panel): void;
+
     /**
      * Inserts a new tab into the CreationMenus table, used by the creation menu to
      * generate its tabs (Spawnlists, Weapons, Entities, etc.).
@@ -40,6 +44,7 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.AddCreationTab
      */
     AddCreationTab<T extends Panel>(name: string, _function: () => T, material?: string, order?: number, tooltip?: string): void;
+
     /**
      * Used to add addon spawnlists to the spawnmenu tree. This function should be called within [SANDBOX:PopulatePropMenu](https://wiki.facepunch.com/gmod/SANDBOX:PopulatePropMenu).
      *
@@ -52,6 +57,7 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.AddPropCategory
      */
     AddPropCategory(classname: string, name: string, contents: table, icon: string, id?: number, parentID?: number, needsApp?: string): void;
+
     /**
      * Used to create a new category in the list inside of a spawnmenu Tool Tab.
      *
@@ -64,6 +70,7 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.AddToolCategory
      */
     AddToolCategory(tabName: string, className: string, printName: string): void;
+
     /**
      * Adds an option to the right side of the spawnmenu.
      *
@@ -74,6 +81,7 @@ interface SpawnmenuLib {
      * @deprecated Legacy argument, no longer works.
      */
     AddToolMenuOption(tab: string, category: string, _class: string, name: string, cmd?: string, config?: string, cpanel?: (pnl: Panel) => void, table?: table): void;
+
     /**
      * Adds a new tool tab to the right side of the spawnmenu. (usually via the [SANDBOX:AddToolMenuTabs](https://wiki.facepunch.com/gmod/SANDBOX:AddToolMenuTabs) hook)
      *
@@ -88,6 +96,7 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.AddToolTab
      */
     AddToolTab(name: string, label?: string, icon?: string): void;
+
     /**
      * Clears all the tools from the different tool categories and the categories itself, if ran at the correct place.
      *
@@ -97,12 +106,14 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.ClearToolMenus
      */
     ClearToolMenus(): void;
+
     /**
      * Creates a new [ContentIcon](https://wiki.facepunch.com/gmod/ContentIcon) previously defined via [spawnmenu.AddContentType](https://wiki.facepunch.com/gmod/spawnmenu.AddContentType).
      * @realm client
      * @source https://wiki.facepunch.com/gmod/spawnmenu.CreateContentIcon
      */
     CreateContentIcon(type: string, parent?: Panel, data?: table): Panel;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -113,6 +124,7 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.DoSaveToTextFiles
      */
     DoSaveToTextFiles(spawnlists: table): void;
+
     /**
      * Returns the function to create an vgui element for a specified content type, previously defined by [spawnmenu.AddContentType](https://wiki.facepunch.com/gmod/spawnmenu.AddContentType).
      *
@@ -124,12 +136,14 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.GetContentType
      */
     GetContentType(contentType: string): (container: Panel, data: table) => Panel;
+
     /**
      * Returns the list of Creation tabs. Creation tabs are added via [spawnmenu.AddCreationTab](https://wiki.facepunch.com/gmod/spawnmenu.AddCreationTab).
      * @realm client
      * @source https://wiki.facepunch.com/gmod/spawnmenu.GetCreationTabs
      */
     GetCreationTabs(): table;
+
     /**
      * Similar to [spawnmenu.GetPropTable](https://wiki.facepunch.com/gmod/spawnmenu.GetPropTable), but only returns spawnlists created by addons via [spawnmenu.AddPropCategory](https://wiki.facepunch.com/gmod/spawnmenu.AddPropCategory).
      *
@@ -139,6 +153,7 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.GetCustomPropTable
      */
     GetCustomPropTable(): table;
+
     /**
      * Returns a table of all prop categories and their props in the spawnmenu.
      *
@@ -150,6 +165,7 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.GetPropTable
      */
     GetPropTable(): table;
+
     /**
      * Returns an existing tool tab by name from the right side of the spawnmenu (usually during the [SANDBOX:AddToolMenuTabs](https://wiki.facepunch.com/gmod/SANDBOX:AddToolMenuTabs) hook)
      *
@@ -158,12 +174,14 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.GetToolMenu
      */
     GetToolMenu(name: string, label?: string, icon?: string): table;
+
     /**
      * Gets a table of tools on the client.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/spawnmenu.GetTools
      */
     GetTools(): table;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -174,6 +192,7 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.PopulateFromEngineTextFiles
      */
     PopulateFromEngineTextFiles(): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -182,6 +201,7 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.PopulateFromTextFiles
      */
     PopulateFromTextFiles(callback: (strFilename: string, strName: string, tabContents: table, icon: string, id: number, parentid: number, needsapp: string) => void): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -192,6 +212,7 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.SaveToTextFiles
      */
     SaveToTextFiles(spawnlists: table): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      * Sets currently active control panel to be returned by [spawnmenu.ActiveControlPanel](https://wiki.facepunch.com/gmod/spawnmenu.ActiveControlPanel).
@@ -199,12 +220,14 @@ interface SpawnmenuLib {
      * @source https://wiki.facepunch.com/gmod/spawnmenu.SetActiveControlPanel
      */
     SetActiveControlPanel(pnl: Panel): void;
+
     /**
      * Switches the creation tab (left side of the spawnmenu) on the spawnmenu to the given tab.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/spawnmenu.SwitchCreationTab
      */
     SwitchCreationTab(id: string): void;
+
     /**
      * Opens specified tool tab in spawnmenu.
      *
@@ -213,28 +236,3 @@ interface SpawnmenuLib {
      */
     SwitchToolTab(id: number): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/spawnmenucontentpanel.d.tlua

@@ -16,6 +16,7 @@ interface SpawnmenuContentPanel extends DPanel {
      * @source https://wiki.facepunch.com/gmod/SpawnmenuContentPanel:CallPopulateHook
      */
     CallPopulateHook(self: SpawnmenuContentPanel, hookname: string): void;
+
     /**
      * Allows the modification of the ContentSidebar
      *
@@ -23,6 +24,7 @@ interface SpawnmenuContentPanel extends DPanel {
      * @source https://wiki.facepunch.com/gmod/SpawnmenuContentPanel:EnableModify
      */
     EnableModify(self: SpawnmenuContentPanel): void;
+
     /**
      * Changes the Spawnmenu category to search in
      *
@@ -30,6 +32,7 @@ interface SpawnmenuContentPanel extends DPanel {
      * @source https://wiki.facepunch.com/gmod/SpawnmenuContentPanel:EnableSearch
      */
     EnableSearch(self: SpawnmenuContentPanel, category: string, hookname: string): void;
+
     /**
      * Switches the current panel with the given panel
      *
@@ -38,8 +41,3 @@ interface SpawnmenuContentPanel extends DPanel {
      */
     SwitchPanel(self: SpawnmenuContentPanel, panel: Panel): void;
 }
-
-
-
-
-

package/types/sql.d.tlua

@@ -42,6 +42,7 @@ interface SqlLib {
      * @source https://wiki.facepunch.com/gmod/sql.Begin
      */
     Begin(): void;
+
     /**
      * Tells the engine to execute a series of queries queued for execution, must be preceded by [sql.Begin](https://wiki.facepunch.com/gmod/sql.Begin).
      *
@@ -51,18 +52,21 @@ interface SqlLib {
      * @source https://wiki.facepunch.com/gmod/sql.Commit
      */
     Commit(): void;
+
     /**
      * Returns true if the index with the specified name exists.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/sql.IndexExists
      */
     IndexExists(indexName: string): boolean;
+
     /**
      * Returns the last error from a SQLite query.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/sql.LastError
      */
     LastError(): string;
+
     /**
      * 		Performs a query on the local SQLite database, returns a table as result set, nil if result is empty and false on error.
      * 			**WARNING**: To run SQL queries with this function safely, it is crucial to ensure that the concatenated variables in the query string are safe to avoid vulnerabilities like SQL injections. For this, it is recommended to use the [sql.SQLStr](https://wiki.facepunch.com/gmod/sql.SQLStr), which allows arguments to be escaped correctly.
@@ -74,6 +78,7 @@ interface SqlLib {
      * @source https://wiki.facepunch.com/gmod/sql.Query
      */
     Query(query: string): table | boolean | nil;
+
     /**
      * Performs the [sql.Query](https://wiki.facepunch.com/gmod/sql.Query) and returns the n'th row.
      *
@@ -86,6 +91,7 @@ interface SqlLib {
      * @source https://wiki.facepunch.com/gmod/sql.QueryRow
      */
     QueryRow(query: string, row?: number): table;
+
     /**
      * 		Performs a query on the local SQLite database with proper type handling and parameter binding, returns a table as result set, empty table if no results, and false on error. Unlike [sql.Query](https://wiki.facepunch.com/gmod/sql.Query), this function properly handles SQLite data types and allows safe parameter binding to prevent SQL injection attacks.
      * 		**WARNING**: * This function only executes a single SQL statement, unlike [sql.Query](https://wiki.facepunch.com/gmod/sql.Query) which can execute multiple statements separated by semicolons.
@@ -99,12 +105,14 @@ interface SqlLib {
      * @source https://wiki.facepunch.com/gmod/sql.QueryTyped
      */
     QueryTyped(query: string, ...: any): table | boolean;
+
     /**
      * Performs the query like [sql.QueryRow](https://wiki.facepunch.com/gmod/sql.QueryRow), but returns the first value found.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/sql.QueryValue
      */
     QueryValue(query: string): string;
+
     /**
      * Escapes dangerous characters and symbols from user input used in an SQLite SQL Query.
      *
@@ -117,6 +125,7 @@ interface SqlLib {
      * @source https://wiki.facepunch.com/gmod/sql.SQLStr
      */
     SQLStr(string: string, bNoQuotes?: boolean): string;
+
     /**
      * Returns true if the table with the specified name exists.
      * @realm shared and menu
@@ -124,13 +133,3 @@ interface SqlLib {
      */
     TableExists(tableName: string): boolean;
 }
-
-
-
-
-
-
-
-
-
-

package/types/stack.d.tlua

@@ -15,24 +15,28 @@ interface Stack {
      * @source https://wiki.facepunch.com/gmod/Stack:Pop
      */
     Pop(self: Stack, amount?: number): any;
+
     /**
      * Pop an item from the stack
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Stack:PopMulti
      */
     PopMulti(self: Stack, amount?: number): table;
+
     /**
      * Push an item onto the stack
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Stack:Push
      */
     Push(self: Stack, object: any): void;
+
     /**
      * Returns the size of the stack
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/Stack:Size
      */
     Size(self: Stack): number;
+
     /**
      * Get the item at the top of the stack
      * @realm shared and menu
@@ -40,9 +44,3 @@ interface Stack {
      */
     Top(self: Stack): any;
 }
-
-
-
-
-
-