@tlua/gmod 1.0.5 → 1.0.6

package/types/ents.d.tlua

@@ -18,12 +18,14 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.Create
      */
     Create(class: string): Entity;
+
     /**
      * Creates a clientside only prop with optional physics.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/ents.CreateClientProp
      */
     CreateClientProp(model?: string): Entity;
+
     /**
      * Creates a clientside only rope, similar to those used by the Dog and Fast
      * Zombie models from Half-Life 2. Created ropes are automatically cleaned up
@@ -35,6 +37,7 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.CreateClientRope
      */
     CreateClientRope(ent1: Entity, ent1attach: number | Vector, ent2: Entity, ent2attach: number | Vector, extra?: table): Entity;
+
     /**
      * Creates a clientside only scripted entity. The scripted entity must be of
      * "anim" type.
@@ -46,6 +49,7 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.CreateClientside
      */
     CreateClientside(class: string): Entity;
+
     /**
      * Returns a table of all entities along the ray. The ray does not stop on collisions, meaning it will go through walls/entities.
      *
@@ -57,6 +61,7 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.FindAlongRay
      */
     FindAlongRay(start: Vector, _end: Vector, mins?: Vector, maxs?: Vector): Entity[];
+
     /**
      * Gets all entities with the given class, supports wildcards.
      *
@@ -68,12 +73,14 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.FindByClass
      */
     FindByClass(_class: string): Entity[];
+
     /**
      * Finds all entities that are of given class and are children of given entity. This works internally by iterating over [ents.FindByClass](https://wiki.facepunch.com/gmod/ents.FindByClass).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/ents.FindByClassAndParent
      */
     FindByClassAndParent(_class: string, parent: Entity): Entity[];
+
     /**
      * Gets all entities with the given model, supports wildcards.
      *
@@ -83,6 +90,7 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.FindByModel
      */
     FindByModel(model: string): Entity[];
+
     /**
      * Gets all entities with the given hammer targetname. This works internally by iterating over [ents.GetAll](https://wiki.facepunch.com/gmod/ents.GetAll).
      *
@@ -92,6 +100,7 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.FindByName
      */
     FindByName(name: string): Entity[];
+
     /**
      * Returns all entities within the specified box.
      *
@@ -105,6 +114,7 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.FindInBox
      */
     FindInBox(boxMins: Vector, boxMaxs: Vector): Entity[];
+
     /**
      * Finds and returns all entities within the specified cone. Only entities whose [Entity:WorldSpaceCenter](https://wiki.facepunch.com/gmod/Entity:WorldSpaceCenter) is within the cone are considered to be in it.
      *
@@ -118,6 +128,7 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.FindInCone
      */
     FindInCone(origin: Vector, normal: Vector, range: number, angle_cos: number): Entity[];
+
     /**
      * Finds all entities that lie within a [PVS (Potential Visibility Set)](https://developer.valvesoftware.com/wiki/PVS "PVS - Valve Developer Community").
      *
@@ -128,6 +139,7 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.FindInPVS
      */
     FindInPVS(viewPoint: Entity | Vector): Entity[];
+
     /**
      * Gets all entities within the specified sphere.
      *
@@ -137,12 +149,14 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.FindInSphere
      */
     FindInSphere(origin: Vector, radius: number): Entity[];
+
     /**
      * Fires a use event.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/ents.FireTargets
      */
     FireTargets(target: string, activator: Entity, caller: Entity, usetype: USE, value: number): void;
+
     /**
      * 		Returns a table of all existing entities.
      *
@@ -153,12 +167,14 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.GetAll
      */
     GetAll(): Entity[];
+
     /**
      * Returns an entity by its index. Same as [Global.Entity](https://wiki.facepunch.com/gmod/Global.Entity).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/ents.GetByIndex
      */
     GetByIndex(entIdx: number): Entity;
+
     /**
      * Gives you the amount of currently existing entities.
      *
@@ -169,6 +185,7 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.GetCount
      */
     GetCount(IncludeKillMe?: boolean): number;
+
     /**
      * Returns the amount of networked entities, which is limited to 8192.
      *
@@ -180,6 +197,7 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.GetEdictCount
      */
     GetEdictCount(): number;
+
     /**
      * Returns entity that has given [Entity:MapCreationID](https://wiki.facepunch.com/gmod/Entity:MapCreationID).
      *
@@ -190,6 +208,7 @@ interface EntsLib {
      * @source https://wiki.facepunch.com/gmod/ents.GetMapCreatedEntity
      */
     GetMapCreatedEntity(id: number): Entity | nil;
+
     /**
      * Returns a Stateless Iterator for all entities, intended for use in generic
      * for-loops. Internally uses cached values stored in Lua, making it more
@@ -202,28 +221,3 @@ interface EntsLib {
      */
     Iterator(): ((tbl: any, prev?: number) => (number, Entity), Entity[], number);
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/enums.d.tlua

@@ -7079,4 +7079,3 @@ declare kRenderFxRagdoll: kRenderFx;
  * Quickly pulses the entitys transparency, from 0 to 255.
  */
 declare kRenderFxPulseFastWider: kRenderFx;
-

package/types/file.d.tlua

@@ -22,48 +22,56 @@ interface File {
      * @source https://wiki.facepunch.com/gmod/File:Close
      */
     Close(self: File): void;
+
     /**
      * Returns whether the [File](https://wiki.facepunch.com/gmod/File) object has reached the end of file or not.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:EndOfFile
      */
     EndOfFile(self: File): boolean;
+
     /**
      * Dumps the file changes to disk and saves the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:Flush
      */
     Flush(self: File): void;
+
     /**
      * Reads the specified amount of chars and returns them as a binary string.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:Read
      */
     Read(self: File, length?: number): string;
+
     /**
      * Reads one byte of the file and returns whether that byte was not 0.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:ReadBool
      */
     ReadBool(self: File): boolean;
+
     /**
      * Reads one unsigned 8-bit integer from the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:ReadByte
      */
     ReadByte(self: File): number;
+
     /**
      * Reads an 8-byte little-endian IEEE-754 floating point double from the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:ReadDouble
      */
     ReadDouble(self: File): number;
+
     /**
      * Reads an IEEE 754 little-endian 4-byte float from the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:ReadFloat
      */
     ReadFloat(self: File): number;
+
     /**
      * Returns the contents of the file from the current position up until the end of the current line.
      *
@@ -78,114 +86,133 @@ interface File {
      * @source https://wiki.facepunch.com/gmod/File:ReadLine
      */
     ReadLine(self: File): string;
+
     /**
      * Reads a signed little-endian 32-bit integer from the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:ReadLong
      */
     ReadLong(self: File): number;
+
     /**
      * Reads a signed little-endian 16-bit integer from the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:ReadShort
      */
     ReadShort(self: File): number;
+
     /**
      * Reads an unsigned 64-bit integer from the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:ReadUInt64
      */
     ReadUInt64(self: File): string;
+
     /**
      * Reads an unsigned little-endian 32-bit integer from the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:ReadULong
      */
     ReadULong(self: File): number;
+
     /**
      * Reads an unsigned little-endian 16-bit integer from the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:ReadUShort
      */
     ReadUShort(self: File): number;
+
     /**
      * Sets the file pointer to the specified position.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:Seek
      */
     Seek(self: File, pos: number): void;
+
     /**
      * Returns the size of the file in bytes.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:Size
      */
     Size(self: File): number;
+
     /**
      * Moves the file pointer by the specified amount of chars.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:Skip
      */
     Skip(self: File, amount: number): number;
+
     /**
      * Returns the current position of the file pointer.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:Tell
      */
     Tell(self: File): number;
+
     /**
      * Writes the given string into the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:Write
      */
     Write(self: File, data: string): void;
+
     /**
      * Writes a boolean value to the file as one **byte**.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:WriteBool
      */
     WriteBool(self: File, bool: boolean): void;
+
     /**
      * Write an 8-bit unsigned integer to the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:WriteByte
      */
     WriteByte(self: File, uint8: number): void;
+
     /**
      * Writes an 8-byte little-endian IEEE-754 floating point double to the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:WriteDouble
      */
     WriteDouble(self: File, double: number): void;
+
     /**
      * Writes an IEEE 754 little-endian 4-byte float to the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:WriteFloat
      */
     WriteFloat(self: File, float: number): void;
+
     /**
      * Writes a signed little-endian 32-bit integer to the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:WriteLong
      */
     WriteLong(self: File, int32: number): void;
+
     /**
      * Writes a signed little-endian 16-bit integer to the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:WriteShort
      */
     WriteShort(self: File, int16: number): void;
+
     /**
      * Writes an unsigned 64-bit integer to the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:WriteUInt64
      */
     WriteUInt64(self: File, uint64: string): void;
+
     /**
      * Writes an unsigned little-endian 32-bit integer to the file.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/File:WriteULong
      */
     WriteULong(self: File, uint32: number): void;
+
     /**
      * Writes an unsigned little-endian 16-bit integer to the file.
      * @realm shared and menu
@@ -194,33 +221,6 @@ interface File {
     WriteUShort(self: File, uint16: number): void;
 }
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 interface FileLib {
     /**
      * Appends data to a file in the `data/` folder.
@@ -228,6 +228,7 @@ interface FileLib {
      * @source https://wiki.facepunch.com/gmod/file.Append
      */
     Append(name: string, content: string): boolean;
+
     /**
      * Returns the content of a file asynchronously.
      *
@@ -237,12 +238,14 @@ interface FileLib {
      * @source https://wiki.facepunch.com/gmod/file.AsyncRead
      */
     AsyncRead(fileName: string, gamePath: string, callback: (fileName: string, gamePath: string, status: number, data: string) => void, sync?: boolean): FSASYNC;
+
     /**
      * Creates a directory that is relative to the `data` folder.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/file.CreateDir
      */
     CreateDir(name: string): void;
+
     /**
      * Deletes a file or `empty` folder that is relative to the **data** folder. You can't remove any files outside of **data** folder.
      * **NOTE**: You are able to delete **any** file in the Menu state.
@@ -252,6 +255,7 @@ interface FileLib {
      * @source https://wiki.facepunch.com/gmod/file.Delete
      */
     Delete(name: string, path?: string): boolean;
+
     /**
      * 		Returns a boolean of whether the file or directory exists or not.
      * 		If you want to check for a directory, [file.IsDir](https://wiki.facepunch.com/gmod/file.IsDir) will be faster since it won't check for files.
@@ -260,6 +264,7 @@ interface FileLib {
      * @source https://wiki.facepunch.com/gmod/file.Exists
      */
     Exists(name: string, gamePath: string): boolean;
+
     /**
      * 		Returns a list of files and directories inside a single folder.
      * 		**WARNING**: It seems that paths with capital letters (e.g. lua/MyFolder/*) don't work as expected on Linux.
@@ -269,6 +274,7 @@ interface FileLib {
      * @source https://wiki.facepunch.com/gmod/file.Find
      */
     Find(name: string, path: string, sorting?: string): (table, table);
+
     /**
      * Returns whether the given file is a directory or not.
      *
@@ -276,6 +282,7 @@ interface FileLib {
      * @source https://wiki.facepunch.com/gmod/file.IsDir
      */
     IsDir(fileName: string, gamePath: string): boolean;
+
     /**
      * Attempts to open a file with the given mode.
      * 		**WARNING**: When trying to open files with the following characteristics, it returns nil:
@@ -288,6 +295,7 @@ interface FileLib {
      * @source https://wiki.facepunch.com/gmod/file.Open
      */
     Open(fileName: string, fileMode: string, gamePath: string): file_class;
+
     /**
      * Returns the content of a file.
      *
@@ -298,6 +306,7 @@ interface FileLib {
      * @source https://wiki.facepunch.com/gmod/file.Read
      */
     Read(fileName: string, gamePath?: string): string;
+
     /**
      * Attempts to rename a file with the given name to another given name.
      *
@@ -307,18 +316,21 @@ interface FileLib {
      * @source https://wiki.facepunch.com/gmod/file.Rename
      */
     Rename(orignalFileName: string, targetFileName: string): boolean;
+
     /**
      * Returns the file's size in bytes.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/file.Size
      */
     Size(fileName: string, gamePath: string): number;
+
     /**
      * Returns when the file or folder was last modified in Unix time.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/file.Time
      */
     Time(path: string, gamePath: string): number;
+
     /**
      * Writes the given string to a file. Erases all previous data in the file. To add data without deleting previous data, use [file.Append](https://wiki.facepunch.com/gmod/file.Append).
      * @realm shared and menu
@@ -326,16 +338,3 @@ interface FileLib {
      */
     Write(fileName: string, content: string): boolean;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/file_class.d.tlua

@@ -4,4 +4,3 @@ interface File {}
 
 // The `file_class` value-side type inherits the File methods.
 interface file_class extends File {}
-

package/types/fingerposer.d.tlua

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

package/types/fingervar.d.tlua

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

package/types/frame.d.tlua

@@ -8,4 +8,3 @@
  * @deprecated You should use DFrame instead.
  */
 interface Frame extends Panel {}
-

package/types/frame_blend.d.tlua

@@ -17,6 +17,7 @@ interface Frame_blendLib {
      * @source https://wiki.facepunch.com/gmod/frame_blend.AddFrame
      */
     AddFrame(): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -27,6 +28,7 @@ interface Frame_blendLib {
      * @source https://wiki.facepunch.com/gmod/frame_blend.BlendFrame
      */
     BlendFrame(): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -37,6 +39,7 @@ interface Frame_blendLib {
      * @source https://wiki.facepunch.com/gmod/frame_blend.CompleteFrame
      */
     CompleteFrame(): void;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -47,12 +50,14 @@ interface Frame_blendLib {
      * @source https://wiki.facepunch.com/gmod/frame_blend.DrawPreview
      */
     DrawPreview(): void;
+
     /**
      * Returns whether frame blend post processing effect is enabled or not.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/frame_blend.IsActive
      */
     IsActive(): boolean;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -64,6 +69,7 @@ interface Frame_blendLib {
      * @source https://wiki.facepunch.com/gmod/frame_blend.IsLastFrame
      */
     IsLastFrame(): boolean;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -74,6 +80,7 @@ interface Frame_blendLib {
      * @source https://wiki.facepunch.com/gmod/frame_blend.RenderableFrames
      */
     RenderableFrames(): number;
+
     /**
      * Returns whether we should skip frame or not.
      * @realm client
@@ -81,11 +88,3 @@ interface Frame_blendLib {
      */
     ShouldSkipFrame(): boolean;
 }
-
-
-
-
-
-
-
-