@tlua/gmod 1.0.5 → 1.0.6

package/types/table.d.tlua

@@ -18,18 +18,21 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.Add
      */
     Add(target: table, source: table): table;
+
     /**
      * Changes all keys to sequential integers. This creates a new table object and does not affect the original.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.ClearKeys
      */
     ClearKeys(table: table, saveKeys?: boolean): table;
+
     /**
      * Collapses a table with keyvalue structure
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.CollapseKeyValue
      */
     CollapseKeyValue(input: table): table;
+
     /**
      * Creates and returns a deep copy of a table.
      *
@@ -40,12 +43,14 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.Copy
      */
     Copy<T extends table>(originalTable: T): T;
+
     /**
      * Empties the target table, and merges all values from the source table into it.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.CopyFromTo
      */
     CopyFromTo(source: table, target: table): void;
+
     /**
      * Counts the amount of keys in a table. This should only be used when a table is not numerically and sequentially indexed. For those tables, consider the length (**#**) operator.
      *
@@ -55,18 +60,21 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.Count
      */
     Count(tbl: table): number;
+
     /**
      * Converts a table that has been sanitised with [table.Sanitise](https://wiki.facepunch.com/gmod/table.Sanitise) back to its original form
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.DeSanitise
      */
     DeSanitise(tbl: table): table;
+
     /**
      * Removes all values from a table. If your table is not a metatable, it is almost always better to use `tab = {}` to preserve performance.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.Empty
      */
     Empty(tbl: table): void;
+
     /**
      * Returns the value positioned after the supplied value in a table. If it isn't found then the first element in the table is returned
      *
@@ -75,6 +83,7 @@ interface TableLib {
      * @deprecated Instead, iterate the table using ipairs or increment from the previous index using Global.next. Non-numerically indexed tables are not ordered.
      */
     FindNext(tbl: table, value: any): any;
+
     /**
      * Returns the value positioned before the supplied value in a table. If it isn't found then the last element in the table is returned
      *
@@ -83,6 +92,7 @@ interface TableLib {
      * @deprecated Instead, iterate your table with ipairs, storing the previous value and checking for the target. Non-numerically indexed tables are not ordered.
      */
     FindPrev(tbl: table, value: any): any;
+
     /**
      * Flips key-value pairs of each element within a table, so that each value becomes the key, and each key becomes the value.
      *
@@ -100,12 +110,14 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.Flip
      */
     Flip(input: table): table;
+
     /**
      * Inserts a value in to the given table even if the table is non-existent
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.ForceInsert
      */
     ForceInsert(tab?: table, value?: any): table;
+
     /**
      * Returns the first key found in the given table
      *
@@ -114,6 +126,7 @@ interface TableLib {
      * @deprecated Instead, expect the first key to be 1.  Non-numerically indexed tables are not ordered and do not have a first key.
      */
     GetFirstKey(tab: table): any;
+
     /**
      * Returns the first value found in the given table
      *
@@ -122,12 +135,14 @@ interface TableLib {
      * @deprecated Instead, index the table with a key of 1.  Non-numerically indexed tables are not ordered and do not have a first key.
      */
     GetFirstValue(tab: table): any;
+
     /**
      * Returns all keys of a table.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.GetKeys
      */
     GetKeys(tabl: table): table;
+
     /**
      * Returns the last key found in the given table
      *
@@ -136,6 +151,7 @@ interface TableLib {
      * @deprecated Instead, use the result of the length (#) operator, ensuring it is not zero. Non-numerically indexed tables are not ordered and do not have a last key.
      */
     GetLastKey(tab: table): any;
+
     /**
      * Returns the last value found in the given table
      *
@@ -144,12 +160,14 @@ interface TableLib {
      * @deprecated Instead, index the table with the result of the length (#) operator, ensuring it is not zero. Non-numerically indexed tables are not ordered and do not have a last key.
      */
     GetLastValue(tab: table): any;
+
     /**
      * Returns a key of the supplied table with the highest number value.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.GetWinningKey
      */
     GetWinningKey(inputTable: table): any;
+
     /**
      * Checks if a table has a value.
      * **WARNING**: This function is **very inefficient for large tables** (O(n)) and should probably not be called in things that run each frame. Instead, consider a table structure such as example 2 below. Also see: [Tables: Bad Habits](https://wiki.facepunch.com/gmod/Tables:_Bad_Habits)
@@ -161,6 +179,7 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.HasValue
      */
     HasValue(tbl: table, value: any): boolean;
+
     /**
      * Copies any missing data from `base` to `target`, and sets the `target`'s `BaseClass` member to the `base` table's pointer.
      *
@@ -175,6 +194,7 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.Inherit
      */
     Inherit(target: table, base: table): table;
+
     /**
      * Returns whether or not the given table is empty.
      *
@@ -186,30 +206,35 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.IsEmpty
      */
     IsEmpty(tab: table): boolean;
+
     /**
      * Returns whether or not the table's keys are sequential
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.IsSequential
      */
     IsSequential(tab: table): boolean;
+
     /**
      * Returns the first key found to be containing the supplied value
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.KeyFromValue
      */
     KeyFromValue(tab: table, value: any): any;
+
     /**
      * Returns a table of keys containing the supplied value
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.KeysFromValue
      */
     KeysFromValue(tab: table, value: any): table;
+
     /**
      * Returns a copy of the input table with all string keys converted to be lowercase recursively
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.LowerKeyNames
      */
     LowerKeyNames(tbl: table): table;
+
     /**
      * Returns an array of values of given with given key from each table of given table.
      *
@@ -218,6 +243,7 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.MemberValuesFromKey
      */
     MemberValuesFromKey(inputTable: table, keyName: any): table;
+
     /**
      * **NOTE**: This function can cause a stack overflow under certain circumstances.
      *
@@ -233,6 +259,7 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.Merge
      */
     Merge(destination: table, source: table, forceOverride?: boolean): table;
+
     /**
      * Packs a set of items into a table and returns the new table. It is meant as an alternative implementation of `table.pack` from newer versions of Lua.
      *
@@ -240,6 +267,7 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.Pack
      */
     Pack(...: any): (table, number);
+
     /**
      * Returns a random value from the supplied table.
      *
@@ -254,6 +282,7 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.Random
      */
     Random(haystack: table): (any, any);
+
     /**
      * Removes the first instance of a given value from the specified table with [table.remove](https://wiki.facepunch.com/gmod/table.remove), then returns the key that the value was found at.
      *
@@ -263,12 +292,14 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.RemoveByValue
      */
     RemoveByValue(tbl: table, val: any): any;
+
     /**
      * Returns a reversed copy of a sequential table. Any non-sequential and non-numeric keyvalue pairs will not be copied.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.Reverse
      */
     Reverse(tbl: table): table;
+
     /**
      * Converts [Vector](https://wiki.facepunch.com/gmod/Vector)s, [Angle](https://wiki.facepunch.com/gmod/Angle)s and [boolean](https://wiki.facepunch.com/gmod/boolean)s to be able to be converted to and from key-values via [util.TableToKeyValues](https://wiki.facepunch.com/gmod/util.TableToKeyValues).
      *
@@ -277,6 +308,7 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.Sanitise
      */
     Sanitise(tab: table): table;
+
     /**
      * Performs an inline [Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle) on the table in `O(n)` time
      *
@@ -284,6 +316,7 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.Shuffle
      */
     Shuffle(target: table): void;
+
     /**
      * Returns a list of keys sorted based on values of those keys.
      *
@@ -293,12 +326,14 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.SortByKey
      */
     SortByKey(tab: table, descending?: boolean): table;
+
     /**
      * Sorts a table by a named member.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.SortByMember
      */
     SortByMember(tab: table, memberKey: any, ascending?: boolean): void;
+
     /**
      * 		Sorts a table in reverse order from [table.sort](https://wiki.facepunch.com/gmod/table.sort).
      * **NOTE**: This function modifies the table you give to it. Like table.sort, it does not return anything.
@@ -308,18 +343,21 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.SortDesc
      */
     SortDesc(tbl: table): void;
+
     /**
      * Converts a table into a string
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.ToString
      */
     ToString(tbl: table, displayName?: string, niceFormatting?: boolean): string;
+
     /**
      * Concatenates the contents of a table to a string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.concat
      */
     concat(tbl: table, concatenator?: string, startPos?: number, endPos?: number): string;
+
     /**
      *  Iterates for each key-value pair in the table, calling the function with the key and value of the pair. If the function returns anything, the loop is broken.
      *
@@ -330,6 +368,7 @@ interface TableLib {
      * @deprecated This was deprecated in Lua 5.1 and removed in 5.2. You should use Global.pairs instead.
      */
     ForEach(tbl: table, callback: (key: any, val: any) => void): void;
+
     /**
      *  Iterates for each numeric index in the table in order.
      *
@@ -340,6 +379,7 @@ interface TableLib {
      * @deprecated This was deprecated in Lua 5.1 and removed in 5.2. You should use Global.ipairs() instead.
      */
     foreachi(table: table, func: function): void;
+
     /**
      *  Returns the length of the table.
      * @realm shared and menu
@@ -347,6 +387,7 @@ interface TableLib {
      * @deprecated This function was deprecated in Lua 5.1 and is removed in 5.2. Use the length (#) operator instead.
      */
     getn(tbl: table): number;
+
     /**
      * Inserts a value at the end of the table.
      * @realm shared
@@ -362,12 +403,14 @@ interface TableLib {
      * @realm menu
      */
     insert(tbl: table, position: number, value: any): number;
+
     /**
      * Returns the highest numerical key.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/table.maxn
      */
     maxn(tbl: table): number;
+
     /**
      * Moves elements from one part of a table to another part a given table. This is similar to assigning elements from the source table to the destination table in multiple assignments.
      *
@@ -375,6 +418,7 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.move
      */
     move(sourceTbl: table, from: number, to: number, dest: number, destTbl?: table): table;
+
     /**
      * Removes a value from a table and shifts any other values down to fill the gap.
      * **NOTE**: Does nothing if index is less than 1 or greater than `#tbl`
@@ -383,6 +427,7 @@ interface TableLib {
      * @source https://wiki.facepunch.com/gmod/table.remove
      */
     remove(tbl: table, index?: number): any;
+
     /**
      * Sorts a sequential table either ascending or by the given sort function.
      * **NOTE**: This function modifies the table you give to it and internally uses the [quick sort algorithm](http://www.lua.org/source/5.2/ltablib.c.html#sort).
@@ -393,51 +438,3 @@ interface TableLib {
      */
     sort(tbl: table, sorter?: (a: any, b: any) => boolean): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/task.d.tlua

@@ -12,36 +12,42 @@ interface Task {
      * @source https://wiki.facepunch.com/gmod/Task:Init
      */
     Init(self: Task): void;
+
     /**
      * Initialises the AI task as an engine task.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Task:InitEngine
      */
     InitEngine(self: Task, taskname: string, taskdata: number): void;
+
     /**
      * Initialises the AI task as NPC method-based.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Task:InitFunctionName
      */
     InitFunctionName(self: Task, startname: string, runname: string, taskdata: number): void;
+
     /**
      * Determines if the task is an engine task (`TYPE_ENGINE`, 1).
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Task:IsEngineType
      */
     IsEngineType(self: Task): void;
+
     /**
      * Determines if the task is an NPC method-based task (`TYPE_FNAME`, 2).
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Task:IsFNameType
      */
     IsFNameType(self: Task): void;
+
     /**
      * Runs the AI task.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Task:Run
      */
     Run(self: Task, target: NPC): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *  Runs the AI task as an NPC method. This requires the task to be of type `TYPE_FNAME`.
@@ -49,12 +55,14 @@ interface Task {
      * @source https://wiki.facepunch.com/gmod/Task:Run_FName
      */
     Run_FName(self: Task, target: NPC): void;
+
     /**
      * Starts the AI task.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/Task:Start
      */
     Start(self: Task, target: NPC): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *  Starts the AI task as an NPC method.
@@ -63,13 +71,3 @@ interface Task {
      */
     Start_FName(self: Task, target: NPC): void;
 }
-
-
-
-
-
-
-
-
-
-

package/types/team.d.tlua

@@ -13,36 +13,42 @@ interface TeamLib {
      * @source https://wiki.facepunch.com/gmod/team.AddScore
      */
     AddScore(index: number, increment: number): void;
+
     /**
      * Returns the team index of the team with the least players. Falls back to TEAM_UNASSIGNED
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.BestAutoJoinTeam
      */
     BestAutoJoinTeam(): number;
+
     /**
      * Returns the real table consisting of information on every defined team
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.GetAllTeams
      */
     GetAllTeams(): table;
+
     /**
      * Returns the selectable classes for the given team. This can be added to with [team.SetClass](https://wiki.facepunch.com/gmod/team.SetClass)
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.GetClass
      */
     GetClass(index: number): table;
+
     /**
      * Returns the team's color.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.GetColor
      */
     GetColor(teamIndex: number): Color;
+
     /**
      * Returns the name of the team.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.GetName
      */
     GetName(teamIndex: number): string;
+
     /**
      * 		Returns a table with all player of the specified team.
      * 		**NOTE**: This function returns a sequential table, meaning it should be looped with [Global.ipairs](https://wiki.facepunch.com/gmod/Global.ipairs) instead of [Global.pairs](https://wiki.facepunch.com/gmod/Global.pairs) for efficiency reasons.
@@ -52,54 +58,63 @@ interface TeamLib {
      * @source https://wiki.facepunch.com/gmod/team.GetPlayers
      */
     GetPlayers(teamIndex: number): table;
+
     /**
      * Returns the score of the team.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.GetScore
      */
     GetScore(teamIndex: number): number;
+
     /**
      * Returns a table of valid spawnpoint classes the team can use. These are set with [team.SetSpawnPoint](https://wiki.facepunch.com/gmod/team.SetSpawnPoint).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.GetSpawnPoint
      */
     GetSpawnPoint(index: number): table;
+
     /**
      * Returns a table of valid spawnpoint entities the team can use. These are set with  [team.SetSpawnPoint](https://wiki.facepunch.com/gmod/team.SetSpawnPoint).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.GetSpawnPoints
      */
     GetSpawnPoints(index: number): table;
+
     /**
      * Returns if a team is joinable or not. This is set in [team.SetUp](https://wiki.facepunch.com/gmod/team.SetUp).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.Joinable
      */
     Joinable(index: number): boolean;
+
     /**
      * Returns the amount of players in a team.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.NumPlayers
      */
     NumPlayers(teamIndex: number): number;
+
     /**
      * Sets valid classes for use by a team. Classes can be created using [player_manager.RegisterClass](https://wiki.facepunch.com/gmod/player_manager.RegisterClass)
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.SetClass
      */
     SetClass(index: number, classes: any): void;
+
     /**
      * Sets the team's color.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.SetColor
      */
     SetColor(teamIndex: number, color: Color): void;
+
     /**
      * Sets the score of the given team
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.SetScore
      */
     SetScore(index: number, score: number): void;
+
     /**
      * Sets valid spawnpoint classes for use by a team.
      *
@@ -110,24 +125,28 @@ interface TeamLib {
      * @source https://wiki.facepunch.com/gmod/team.SetSpawnPoint
      */
     SetSpawnPoint(index: number, classes: any): void;
+
     /**
      * Creates a new team. See [GM:CreateTeams](https://wiki.facepunch.com/gmod/GM:CreateTeams) for the hook to call this in.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.SetUp
      */
     SetUp(teamIndex: number, teamName: string, teamColor: Color, isJoinable?: boolean): void;
+
     /**
      * Returns the total number of deaths of all players in the team.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.TotalDeaths
      */
     TotalDeaths(index: number): number;
+
     /**
      * Get's the total frags in a team.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/team.TotalFrags
      */
     TotalFrags(entityOrNumber: Entity): number;
+
     /**
      * Returns true if the given team index is valid
      * @realm shared
@@ -135,23 +154,3 @@ interface TeamLib {
      */
     Valid(index: number): boolean;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/textentry.d.tlua

@@ -9,4 +9,3 @@
  * @source https://wiki.facepunch.com/gmod/TextEntry
  */
 interface TextEntry extends Panel {}
-

package/types/tgaimage.d.tlua

@@ -8,4 +8,3 @@
  * @deprecated DImage should be used instead (with `.png` or `.jpg` images). `TGAImage` panel has no advantages.
  */
 interface TGAImage extends Panel {}
-