@tlua/gmod 1.0.5 → 1.0.6

package/types/util.d.tlua

@@ -12,6 +12,7 @@ declare util: UtilLib;
  */
 interface UtilLib {
     worldpicker: UtilworldpickerLib;
+
     /**
      * Adds the specified string to a string table, which will cache it and network it to all clients automatically.
      * Whenever you want to create a net message with [net.Start](https://wiki.facepunch.com/gmod/net.Start), you must add the name of that message as a networked string via this function.
@@ -32,6 +33,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.AddNetworkString
      */
     AddNetworkString(str: string): number;
+
     /**
      * Function used to calculate aim vector from 2D screen position. It is used in SuperDOF calculate Distance.
      *
@@ -41,12 +43,14 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.AimVector
      */
     AimVector(ViewAngles: Angle, ViewFOV: number, x: number, y: number, scrWidth: number, scrHeight: number): Vector;
+
     /**
      * Decodes the specified string from base64.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/util.Base64Decode
      */
     Base64Decode(str: string): string;
+
     /**
      * Encodes the specified string to base64.
      *
@@ -57,18 +61,21 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.Base64Encode
      */
     Base64Encode(str: string, inline?: boolean): string;
+
     /**
      * Applies explosion damage to all entities in the specified radius. Performs block checking.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/util.BlastDamage
      */
     BlastDamage(inflictor: Entity, attacker: Entity, damageOrigin: Vector, damageRadius: number, damage: number): void;
+
     /**
      * Applies spherical damage based on damage info to all entities in the specified radius.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/util.BlastDamageInfo
      */
     BlastDamageInfo(dmg: CTakeDamageInfo, damageOrigin: Vector, damageRadius: number): void;
+
     /**
      * 		Generates the [CRC Checksum](https://en.wikipedia.org/wiki/Cyclic_redundancy_check) of the specified string.
      *
@@ -79,6 +86,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.CRC
      */
     CRC(stringToChecksum: string): string;
+
     /**
      * Compresses the given string using the [LZMA](https://en.wikipedia.org/wiki/LZMA) algorithm.
      *
@@ -93,18 +101,21 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.Compress
      */
     Compress(str: string): string;
+
     /**
      * Returns the current date formatted like '2012-10-31 18-00-00'
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/util.DateStamp
      */
     DateStamp(): string;
+
     /**
      * Performs a trace and paints a decal to the surface hit.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.Decal
      */
     Decal(name: string, start: Vector, _end: Vector, filter?: Entity | Entity[]): void;
+
     /**
      * Performs a trace and paints a decal to the surface hit.
      *
@@ -115,6 +126,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.DecalEx
      */
     DecalEx(material: IMaterial, ent: Entity, position: Vector, normal: Vector, color: Color, w: number, h: number): void;
+
     /**
      * Gets the full material path by the decal name. Used with [util.DecalEx](https://wiki.facepunch.com/gmod/util.DecalEx).
      *
@@ -123,6 +135,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.DecalMaterial
      */
     DecalMaterial(decalName: string): string;
+
     /**
      * Decompresses the given string using [LZMA](https://en.wikipedia.org/wiki/LZMA) algorithm. Used to decompress strings previously compressed with [util.Compress](https://wiki.facepunch.com/gmod/util.Compress).
      *
@@ -139,12 +152,14 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.Decompress
      */
     Decompress(compressedString: string, maxSize?: number): string | nil;
+
     /**
      * Gets the distance between a line and a point in 3d space.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.DistanceToLine
      */
     DistanceToLine(lineStart: Vector, lineEnd: Vector, pointPos: Vector): (number, Vector, number);
+
     /**
      * Creates an effect with the specified data.
      *
@@ -159,6 +174,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.Effect
      */
     Effect(effectName: string, effectData: CEffectData, allowOverride?: boolean, ignorePredictionOrRecipientFilter?: boolean | CRecipientFilter): void;
+
     /**
      * Filters given text using Steam's filtering system. The function will obey local client's Steam settings for chat filtering:
      *
@@ -171,6 +187,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.FilterText
      */
     FilterText(str: string, context?: number, player?: Player): string;
+
     /**
      * 		Converts the full path of the given file to a relative path.
      * 		You can use [util.RelativePathToFull_Menu](https://wiki.facepunch.com/gmod/util.RelativePathToFull_Menu) to convert the relative path back to the full path.
@@ -179,6 +196,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.FullPathToRelative_Menu
      */
     FullPathToRelative_Menu(fullPath: string, fsPath?: string): string;
+
     /**
      * Returns the ID of a custom model activity. This is useful for models that define custom ones.
      *
@@ -188,6 +206,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.GetActivityIDByName
      */
     GetActivityIDByName(arg0: string): number;
+
     /**
      * Returns a name for given activity ID. This is useful for models that define custom activities.
      *
@@ -197,6 +216,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.GetActivityNameByID
      */
     GetActivityNameByID(id: number): string;
+
     /**
      * Returns the ID of a custom model animation event. This is useful for models that define custom animation events.
      *
@@ -206,6 +226,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.GetAnimEventIDByName
      */
     GetAnimEventIDByName(arg0: string): number;
+
     /**
      * Returns a name for given automatically generated numerical animation event ID. This is useful for models that define custom animation events.
      *
@@ -215,6 +236,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.GetAnimEventNameByID
      */
     GetAnimEventNameByID(id: number): string;
+
     /**
      * Returns a table containing the info about the model. The model will be loaded and cached if it was not previously.
      *
@@ -238,6 +260,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.GetModelInfo
      */
     GetModelInfo(mdl: string): ModelInfo;
+
     /**
      * 		Retrieves vertex, triangle, and bone data for the visual meshes of a given model.
      *
@@ -248,6 +271,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.GetModelMeshes
      */
     GetModelMeshes(model: string, lod?: number, bodygroupMask?: string | number, skin?: number): (ModelMeshData[], BoneBindPose[]);
+
     /**
      * Gets persistent data of an offline player using their SteamID.
      *
@@ -260,12 +284,14 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.GetPData
      */
     GetPData(steamID: string, name: string, _default: any): string;
+
     /**
      * Creates a new PixVis handle. See [util.PixelVisible](https://wiki.facepunch.com/gmod/util.PixelVisible).
      * @realm client
      * @source https://wiki.facepunch.com/gmod/util.GetPixelVisibleHandle
      */
     GetPixelVisibleHandle(): pixelvis_handle_t;
+
     /**
      * Utility function to quickly generate a trace table that starts at the players view position, and ends `32768` units along a specified direction.
      *
@@ -274,18 +300,21 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.GetPlayerTrace
      */
     GetPlayerTrace(ply: Player, dir?: Vector): Trace;
+
     /**
      * Gets information about the sun position and obstruction or nil if there is no sun.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/util.GetSunInfo
      */
     GetSunInfo(): table;
+
     /**
      * Returns data of a [surface property](https://developer.valvesoftware.com/wiki/Material_surface_properties) at given ID. New surface properties can be added via [physenv.AddSurfaceData](https://wiki.facepunch.com/gmod/physenv.AddSurfaceData).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.GetSurfaceData
      */
     GetSurfaceData(id: number): SurfacePropertyData;
+
     /**
      * Returns the matching surface property index for the given surface property name.
      *
@@ -295,6 +324,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.GetSurfaceIndex
      */
     GetSurfaceIndex(surfaceName: string): number;
+
     /**
      * Returns the name of a surface property at given ID.
      *
@@ -304,6 +334,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.GetSurfacePropName
      */
     GetSurfacePropName(id: number): string;
+
     /**
      * Returns a table of all SteamIDs that have a usergroup.
      *
@@ -319,72 +350,84 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.GetUserGroups
      */
     GetUserGroups(): table;
+
     /**
      * Performs a Ray-OBB (Orientated Bounding Box) intersection and returns position, normal and the fraction if there was an intersection.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IntersectRayWithOBB
      */
     IntersectRayWithOBB(rayStart: Vector, rayDelta: Vector, boxOrigin: Vector, boxAngles: Angle, boxMins: Vector, boxMaxs: Vector): (Vector, Vector, number);
+
     /**
      * Performs a [ray-plane intersection](https://en.wikipedia.org/wiki/Line%E2%80%93plane_intersection) and returns the hit position or nil.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IntersectRayWithPlane
      */
     IntersectRayWithPlane(rayOrigin: Vector, rayDirection: Vector, planePosition: Vector, planeNormal: Vector): Vector;
+
     /**
      * Performs a ray-sphere intersection and returns the intersection positions or nil.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IntersectRayWithSphere
      */
     IntersectRayWithSphere(rayOrigin: Vector, rayDelta: Vector, spherePosition: Vector, sphereRadius: number): (number, number);
+
     /**
      * Returns whether a binary module is installed and is resolvable by [Global.require](https://wiki.facepunch.com/gmod/Global.require).
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/util.IsBinaryModuleInstalled
      */
     IsBinaryModuleInstalled(name: string): boolean;
+
     /**
      * Performs a box-box intersection and returns whether there was an intersection or not.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IsBoxIntersectingBox
      */
     IsBoxIntersectingBox(boxMin: Vector, boxMax: Vector, box2Min: Vector, box2Max: Vector): boolean;
+
     /**
      * Performs a box-sphere intersection and returns whether there was an intersection or not.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IsBoxIntersectingSphere
      */
     IsBoxIntersectingSphere(boxMin: Vector, boxMax: Vector, shpere2Position: Vector, sphere2Radius: number): boolean;
+
     /**
      * Checks if a certain position is within the world bounds.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/util.IsInWorld
      */
     IsInWorld(position: Vector): boolean;
+
     /**
      * Checks if the model is loaded in the game.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IsModelLoaded
      */
     IsModelLoaded(modelName: string): boolean;
+
     /**
      * Performs OBB on OBB intersection test.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IsOBBIntersectingOBB
      */
     IsOBBIntersectingOBB(box1Origin: Vector, box1Angles: Angle, box1Mins: Vector, box1Maxs: Vector, box2Origin: Vector, box2Angles: Angle, box2Mins: Vector, box2Maxs: Vector, tolerance: number): boolean;
+
     /**
      * Returns whether a point is within a cone or not.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IsPointInCone
      */
     IsPointInCone(point: Vector, coneOrigin: Vector, coneAxis: Vector, coneSine: number, coneLength: number): boolean;
+
     /**
      * Performs a ray-ray intersection and returns whether there was an intersection or not.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IsRayIntersectingRay
      */
     IsRayIntersectingRay(ray1Start: Vector, ray1End: Vector, ray2Start: Vector, ray2End: Vector): (boolean, number, number);
+
     /**
      * Check whether the skybox is visible from the point specified.
      *
@@ -395,18 +438,21 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.IsSkyboxVisibleFromPoint
      */
     IsSkyboxVisibleFromPoint(position: Vector): boolean;
+
     /**
      * Returns whether a sphere is intersecting a cone or not.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IsSphereIntersectingCone
      */
     IsSphereIntersectingCone(sphereCenter: Vector, sphereRadius: number, coneOrigin: Vector, coneAxis: Vector, coneSine: number, coneCosine: number): boolean;
+
     /**
      * Performs a sphere-sphere intersection and returns whether there was an intersection or not.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IsSphereIntersectingSphere
      */
     IsSphereIntersectingSphere(sphere1Position: Vector, sphere1Radius: number, sphere2Position: Vector, sphere2Radius: number): boolean;
+
     /**
      * Checks if the specified model is valid.
      *
@@ -436,24 +482,28 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.IsValidModel
      */
     IsValidModel(modelName: string): boolean;
+
     /**
      * Checks whether the given numbered physics object of the given entity is valid or not. Most useful for ragdolls.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IsValidPhysicsObject
      */
     IsValidPhysicsObject(ent: Entity, physobj: number): boolean;
+
     /**
      * Checks if the specified prop is valid (has valid physics object).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IsValidProp
      */
     IsValidProp(modelName: string): boolean;
+
     /**
      * Checks if the specified model name points to a valid ragdoll.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.IsValidRagdoll
      */
     IsValidRagdoll(ragdollName: string): boolean;
+
     /**
      * Converts a JSON string to a Lua table. It supports comments and trailing commas.
      *
@@ -465,6 +515,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.JSONToTable
      */
     JSONToTable(json: string, ignoreLimits?: boolean, ignoreConversions?: boolean): table | nil;
+
     /**
      * Converts a Valve KeyValue string (typically from [util.TableToKeyValues](https://wiki.facepunch.com/gmod/util.TableToKeyValues)) to a Lua table.
      *
@@ -475,12 +526,14 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.KeyValuesToTable
      */
     KeyValuesToTable(keyValues: string, usesEscapeSequences?: boolean, preserveKeyCase?: boolean): table;
+
     /**
      * Similar to [util.KeyValuesToTable](https://wiki.facepunch.com/gmod/util.KeyValuesToTable), but it also preserves order of keys (since Lua dictionary-style tables do not guarantee a specific order), and allows handling of repeated keys. (since each key can only appear once in a dictionary data structure)
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/util.KeyValuesToTablePreserveOrder
      */
     KeyValuesToTablePreserveOrder(keyValues: string, usesEscapeSequences?: boolean, preserveKeyCase?: boolean): table;
+
     /**
      * A convenience function around LocalToWorld-related functions.
      *
@@ -491,6 +544,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.LocalToWorld
      */
     LocalToWorld(ent: Entity, lpos: Vector, bone?: number): Vector;
+
     /**
      * 		Generates the [MD5 hash](https://en.wikipedia.org/wiki/MD5) of the specified string.
      * 		**WARNING**: MD5 is considered cryptographically broken and is known to be vulnerable to a variety of attacks including duplicate return values. If security or duplicate returns is a concern, use [util.SHA256](https://wiki.facepunch.com/gmod/util.SHA256).
@@ -500,24 +554,28 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.MD5
      */
     MD5(stringToHash: string): string;
+
     /**
      * Returns the networked string associated with the given ID from the string table.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.NetworkIDToString
      */
     NetworkIDToString(stringTableID: number): string;
+
     /**
      * Returns the networked ID associated with the given string from the string table.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.NetworkStringToID
      */
     NetworkStringToID(networkString: string): number;
+
     /**
      * Formats a float by stripping off extra `0's` and `.'s`.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/util.NiceFloat
      */
     NiceFloat(float: number): string;
+
     /**
      * Creates an orange box (.pcf) tracer effect with the given parameters. See [util.ParticleTracerEx](https://wiki.facepunch.com/gmod/util.ParticleTracerEx) for version with additional arguments.
      *
@@ -529,12 +587,14 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.ParticleTracer
      */
     ParticleTracer(name: string, startPos: Vector, endPos: Vector, doWhiz: boolean): void;
+
     /**
      * Creates a tracer effect with the given parameters. Expanded version of [util.ParticleTracer](https://wiki.facepunch.com/gmod/util.ParticleTracer).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.ParticleTracerEx
      */
     ParticleTracerEx(name: string, startPos: Vector, endPos: Vector, doWhiz: boolean, entityIndex: number, attachmentIndex: number): void;
+
     /**
      * Returns the visibility of a square that is always pointed at the camera in the world-space.
      *
@@ -544,6 +604,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.PixelVisible
      */
     PixelVisible(position: Vector, size: number, PixVis: pixelvis_handle_t): number;
+
     /**
      * 		Returns the contents of the position specified.
      * 		**NOTE**: This function will sample only the world environments. It can be used to check if [Entity:GetPos](https://wiki.facepunch.com/gmod/Entity:GetPos) is underwater for example unlike [Entity:WaterLevel](https://wiki.facepunch.com/gmod/Entity:WaterLevel) which works for players only.
@@ -553,6 +614,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.PointContents
      */
     PointContents(position: Vector): CONTENTS;
+
     /**
      * 	Precaches a model for later use. Model is cached after being loaded once.
      * 		**WARNING**: Modelprecache is limited to 8192 unique models. When it reaches the limit the game will crash.
@@ -565,6 +627,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.PrecacheModel
      */
     PrecacheModel(modelName: string): void;
+
     /**
      * Precaches a sound for later use. Sound is cached after being loaded once.
      * **NOTE**: Soundcache is limited to 16384 unique sounds on the server. Due to this fact this function is disabled on purpose, as exceeding the limit causes the server to shutdown.
@@ -576,6 +639,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.PrecacheSound
      */
     PrecacheSound(soundName: string): void;
+
     /**
      * Performs a trace with the given origin, direction, and filter.
      * **NOTE**: This function will throw an error in the menu realm because it internally uses util.TraceLine which doesn't exist in the menu realm and thus error.
@@ -585,6 +649,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.QuickTrace
      */
     QuickTrace(origin: Vector, dir: Vector, filter?: Entity | Entity[] | string[] | function): TraceResult;
+
     /**
      * 		Converts the relative path of a given file to the full path on disk.
      * 		You can use [util.FullPathToRelative_Menu](https://wiki.facepunch.com/gmod/util.FullPathToRelative_Menu) to convert the full path back to the relative path.
@@ -593,6 +658,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.RelativePathToFull_Menu
      */
     RelativePathToFull_Menu(filePath: string, mountPath?: string): string;
+
     /**
      * 		Returns which Workshop addon the given file belongs to.
      *
@@ -600,6 +666,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.RelativePathToGMA_Menu
      */
     RelativePathToGMA_Menu(filePath: string): table;
+
     /**
      * Removes world decals at given position, in given radius. Does not remove decals on models!
      *
@@ -607,6 +674,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.RemoveDecalsAt
      */
     RemoveDecalsAt(pos: Vector, distance: number, limit?: number, permanent?: boolean): number;
+
     /**
      * Removes persistent data of an offline player using their SteamID.
      *
@@ -619,6 +687,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.RemovePData
      */
     RemovePData(steamID: string, name: string): void;
+
     /**
      * 		Generates the [SHA-1 hash](https://en.wikipedia.org/wiki/SHA-1) of the specified string.
      * 		**WARNING**: SHA-1 is considered cryptographically broken and is known to be vulnerable to a variety of attacks. If security is a concern, use [util.SHA256](https://wiki.facepunch.com/gmod/util.SHA256).
@@ -628,12 +697,14 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.SHA1
      */
     SHA1(stringToHash: string): string;
+
     /**
      * Generates the [SHA-256 hash](https://en.wikipedia.org/wiki/SHA-2) of the specified string. This is mostly unique and is astronomically unlikely to return the same hash for a different string unlike [util.CRC](https://wiki.facepunch.com/gmod/util.CRC) or [util.MD5](https://wiki.facepunch.com/gmod/util.MD5) which are both much more vulnerable to duplicate returns.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.SHA256
      */
     SHA256(stringToHash: string): string;
+
     /**
      * Makes the screen shake.
      *
@@ -643,6 +714,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.ScreenShake
      */
     ScreenShake(pos: Vector, amplitude: number, frequency: number, duration: number, radius: number, airshake?: boolean, filter?: CRecipientFilter): void;
+
     /**
      * Sets persistent data for offline player using their SteamID.
      *
@@ -655,6 +727,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.SetPData
      */
     SetPData(steamID: string, name: string, value: any): void;
+
     /**
      * Generates a random float value that should be the same on client and server.
      *
@@ -667,18 +740,21 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.SharedRandom
      */
     SharedRandom(uniqueName: string, min: number, max: number, additionalSeed?: number): number;
+
     /**
      * Adds a trail to the specified entity.
      * @realm server
      * @source https://wiki.facepunch.com/gmod/util.SpriteTrail
      */
     SpriteTrail(ent: Entity, attachmentID: number, color: Color, additive: boolean, startWidth: number, endWidth: number, lifetime: number, textureRes: number, texture: string): Entity;
+
     /**
      * Returns a new [Stack](https://wiki.facepunch.com/gmod/Stack) object.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/util.Stack
      */
     Stack(): Stack;
+
     /**
      * Given a [64bit SteamID](https://wiki.facepunch.com/gmod/Player:SteamID64) will return a [STEAM_0:0:0](https://wiki.facepunch.com/gmod/Player:SteamID) style Steam ID.
      *
@@ -689,12 +765,14 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.SteamIDFrom64
      */
     SteamIDFrom64(id: string): string;
+
     /**
      * Converts a [STEAM_0:0:0](https://wiki.facepunch.com/gmod/Player:SteamID) style SteamID to a [64bit SteamID](https://wiki.facepunch.com/gmod/Player:SteamID64).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/util.SteamIDTo64
      */
     SteamIDTo64(id: string): string;
+
     /**
      * Converts a string to the specified type.
      *
@@ -704,6 +782,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.StringToType
      */
     StringToType(str: string, typename: string): any;
+
     /**
      * Converts a table to a JSON string. Keep in mind that not every data type can be stored in the JSON format, notably any entity will not be written, as if it wasn't in the table. Same goes for materials and textures, etc.
      *
@@ -717,6 +796,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.TableToJSON
      */
     TableToJSON(table: table, prettyPrint?: boolean): string;
+
     /**
      * Converts the given table into a Valve keyValue formatted string.
      *
@@ -728,18 +808,21 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.TableToKeyValues
      */
     TableToKeyValues(table: table, rootKey?: string): string;
+
     /**
      * Creates a timer object. The returned timer will be already started with given duration.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/util.Timer
      */
     Timer(duration?: number): table;
+
     /**
      * Returns the time since this function has been last called
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/util.TimerCycle
      */
     TimerCycle(): number;
+
     /**
      * Runs a trace using the entity's collision model between two points. Does not
      * take the entity's angles into account (traces the unrotated collision model).
@@ -747,6 +830,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.TraceEntity
      */
     TraceEntity(tracedata: Trace, ent: Entity): TraceResult;
+
     /**
      * Identical to util.TraceHull but uses an entity's Axis-Aligned Bounding Box
      * (AABB) for `mins`/`maxs` inputs (those two keys are ignored in the table).
@@ -754,6 +838,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.TraceEntityHull
      */
     TraceEntityHull(tracedata: HullTrace, ent: Entity): TraceResult;
+
     /**
      * Performs an AABB hull (axis-aligned bounding box, not rotated) trace with the
      * given trace data. This trace type cannot hit hitboxes. See util.TraceLine for
@@ -762,6 +847,7 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.TraceHull
      */
     TraceHull(TraceData: HullTrace): TraceResult;
+
     /**
      * Performs an infinitely thin, invisible ray trace in a line and returns a
      * table with information about what, if anything, the trace hit or intersected.
@@ -770,12 +856,14 @@ interface UtilLib {
      * @source https://wiki.facepunch.com/gmod/util.TraceLine
      */
     TraceLine(traceConfig: Trace): TraceResult;
+
     /**
      * Converts a type to a (nice, but still parsable) string
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/util.TypeToString
      */
     TypeToString(input: any): string;
+
     /**
      * Converts string or a number to a bool, if possible. Alias of [Global.tobool](https://wiki.facepunch.com/gmod/Global.tobool).
      *
@@ -786,98 +874,6 @@ interface UtilLib {
     tobool(input: any): boolean;
 }
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 interface UtilworldpickerLib {
     /**
      * Returns if the user is currently picking an entity.
@@ -885,6 +881,7 @@ interface UtilworldpickerLib {
      * @source https://wiki.facepunch.com/gmod/util.worldpicker.Active
      */
     Active(): boolean;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -895,6 +892,7 @@ interface UtilworldpickerLib {
      * @source https://wiki.facepunch.com/gmod/util.worldpicker.Finish
      */
     Finish(tr: TraceResult): void;
+
     /**
      * Starts picking an entity in the world. This will suppress the next mouse click, and instead use it as a direction in the trace sent to the callback.
      * @realm client
@@ -902,6 +900,3 @@ interface UtilworldpickerLib {
      */
     Start(callback: (tr: table) => void): void;
 }
-
-
-