@tlua/gmod 1.0.1

package/util.d.tlua

@@ -0,0 +1,1087 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * This is the list of utility functions.
+ * @source https://wiki.facepunch.com/gmod/util
+ */
+declare util: UtilLib;
+
+/**
+ * `util.worldpicker` is for picking an entity in the world while [GUI](https://wiki.facepunch.com/gmod/gui) is open.
+ * @source https://wiki.facepunch.com/gmod/util.worldpicker
+ */
+interface UtilLib {
+    worldpicker: UtilworldpickerLib;
+}
+
+interface UtilLib {
+    /**
+     * 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.
+     *
+     * If the passed string already exists, nothing will happen and the ID of the existing item will be returned.
+     *
+     * **NOTE**: Each unique network name needs to be pooled once - do not put this function call into any other functions if you're using a constant string. Preferable place for this function is in a serverside lua file, or in a shared file with the [net.Receive](https://wiki.facepunch.com/gmod/net.Receive) function.
+     *
+     * The string table used for this function does not interfere with the engine string tables and has 4095 slots.
+     * This limit is shared among all entities, SetNW* and SetGlobal* functions. If you exceed the limit, you cannot create new variables, and you will get the following warning:
+     * ```lua
+     * Warning:  Table networkstring is full, can't add [key]
+     * ```
+     * **WARNING**: Existing variables will still get updated without the warning. You can check the limit by counting up until [util.NetworkIDToString](https://wiki.facepunch.com/gmod/util.NetworkIDToString) returns nil
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/util.AddNetworkString
+     */
+    AddNetworkString(str: string): number;
+}
+
+interface UtilLib {
+    /**
+     * Function used to calculate aim vector from 2D screen position. It is used in SuperDOF calculate Distance.
+     *
+     * Essentially a generic version of [gui.ScreenToVector](https://wiki.facepunch.com/gmod/gui.ScreenToVector).
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.AimVector
+     */
+    AimVector(ViewAngles: Angle, ViewFOV: number, x: number, y: number, scrWidth: number, scrHeight: number): Vector;
+}
+
+interface UtilLib {
+    /**
+     * Decodes the specified string from base64.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.Base64Decode
+     */
+    Base64Decode(str: string): string;
+}
+
+interface UtilLib {
+    /**
+     * Encodes the specified string to base64.
+     *
+     * **NOTE**: Unless disabled with the `inline` argument, the Base64 returned is compliant to the RFC 2045 standard. **This means it will have a line break after every 76th character.**
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.Base64Encode
+     */
+    Base64Encode(str: string, inline?: boolean): string;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 		Generates the [CRC Checksum](https://en.wikipedia.org/wiki/Cyclic_redundancy_check) of the specified string.
+     *
+     * 		**WARNING**: This is NOT a hashing function. It is a checksum, typically used for error detection/data corruption detection. It is possible for this function to generate "collisions", where two different strings will produce the same CRC. If you need a hashing function, use [util.SHA256](https://wiki.facepunch.com/gmod/util.SHA256).
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.CRC
+     */
+    CRC(stringToChecksum: string): string;
+}
+
+interface UtilLib {
+    /**
+     * Compresses the given string using the [LZMA](https://en.wikipedia.org/wiki/LZMA) algorithm.
+     *
+     * Use with [net.WriteData](https://wiki.facepunch.com/gmod/net.WriteData) and [net.ReadData](https://wiki.facepunch.com/gmod/net.ReadData) for networking and  [util.Decompress](https://wiki.facepunch.com/gmod/util.Decompress) to decompress the data.
+     *
+     * **NOTE**: The output of this function will have the uncompressed size of the data prepended to it as an 8-byte little-endian integer. [Source](https://github.com/garrynewman/bootil/blob/beb4cec8ad29533965491b767b177dc549e62d23/src/Bootil/Utility/CompressionLZMA.cpp#L56-L63)
+     *
+     * You may therefore experience issues using the output of this function **_outside of Garry's Mod_**. If you need to do this, you will need to manually strip the first 8 bytes from the compressed output, or use third-party tools such as [gmod-lzma](https://github.com/WilliamVenner/gmod-lzma-rs) to decompress the output instead.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.Compress
+     */
+    Compress(str: string): string;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * Performs a trace and paints a decal to the surface hit.
+     *
+     * **NOTE**: This function has trouble spanning across multiple brushes on the map.
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/util.DecalEx
+     */
+    DecalEx(material: IMaterial, ent: Entity, position: Vector, normal: Vector, color: Color, w: number, h: number): void;
+}
+
+interface UtilLib {
+    /**
+     * Gets the full material path by the decal name. Used with [util.DecalEx](https://wiki.facepunch.com/gmod/util.DecalEx).
+     *
+     * If decal specifies multiple materials, a random one will be chosen.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.DecalMaterial
+     */
+    DecalMaterial(decalName: string): string;
+}
+
+interface UtilLib {
+    /**
+     * 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).
+     *
+     * **WARNING**: When reading user data, always try to specify `maxSize` argument, otherwise the server can be [decompression bombed](https://en.wikipedia.org/wiki/Zip_bomb) with bad data that will fill up all Lua memory
+     *
+     * **NOTE**: This function expects the compressed input data to have the uncompressed size of the data prepended to it as an 8-byte little-endian integer. [Source](https://github.com/garrynewman/bootil/blob/beb4cec8ad29533965491b767b177dc549e62d23/src/Bootil/Utility/CompressionLZMA.cpp#L101)
+     *
+     * If your compressed input data was compressed by [util.Compress](https://wiki.facepunch.com/gmod/util.Compress), you don't need to worry about this - the uncompressed size of the data is already prepended to its output.
+     *
+     * However, if your compressed data was produced using standard tools **_outside of Garry's Mod_**, you will need to manually prepend the length of the uncompressed data to its compressed form as an 8-byte little endian integer.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.Decompress
+     */
+    Decompress(compressedString: string, maxSize?: number): string | nil;
+}
+
+interface UtilLib {
+    /**
+     * 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);
+}
+
+interface UtilLib {
+    /**
+     * Creates an effect with the specified data.
+     *
+     * For Orange Box `.pcf` particles, see [Global.ParticleEffect](https://wiki.facepunch.com/gmod/Global.ParticleEffect), [Global.ParticleEffectAttach](https://wiki.facepunch.com/gmod/Global.ParticleEffectAttach) and  [Global.CreateParticleSystem](https://wiki.facepunch.com/gmod/Global.CreateParticleSystem).
+     *
+     * 	**NOTE**: When dispatching an effect from the server, some values may be clamped for networking optimizations. Visit the Set accessors on [CEffectData](https://wiki.facepunch.com/gmod/CEffectData) to see which ones are affected.
+     *
+     * You will need to couple this function with [Global.IsFirstTimePredicted](https://wiki.facepunch.com/gmod/Global.IsFirstTimePredicted) if you want to use it in a [predicted hook](https://wiki.facepunch.com/gmod/Prediction).
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.Effect
+     */
+    Effect(effectName: string, effectData: CEffectData, allowOverride?: boolean, ignorePredictionOrRecipientFilter?: boolean | CRecipientFilter): void;
+}
+
+interface UtilLib {
+    /**
+     * Filters given text using Steam's filtering system. The function will obey local client's Steam settings for chat filtering:
+     *
+     *
+     *
+     * **NOTE**: In some cases, especially in a chatbox, messages from some players may return an empty string if the context argument used for filtering is `TEXT_FILTER_CHAT` and [if the local player has blocked the sender of the message on Steam](https://github.com/Facepunch/garrysmod-issues/issues/5161#issuecomment-1035153941).
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/util.FilterText
+     */
+    FilterText(str: string, context?: number, player?: Player): string;
+}
+
+interface UtilLib {
+    /**
+     * 		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.
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/util.FullPathToRelative_Menu
+     */
+    FullPathToRelative_Menu(fullPath: string, fsPath?: string): string;
+}
+
+interface UtilLib {
+    /**
+     * Returns the ID of a custom model activity. This is useful for models that define custom ones.
+     *
+     * See [util.GetActivityNameByID](https://wiki.facepunch.com/gmod/util.GetActivityNameByID) for a function that does the opposite.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.GetActivityIDByName
+     */
+    GetActivityIDByName(arg0: string): number;
+}
+
+interface UtilLib {
+    /**
+     * Returns a name for given activity ID. This is useful for models that define custom activities.
+     *
+     * See [util.GetActivityIDByName](https://wiki.facepunch.com/gmod/util.GetActivityIDByName) for a function that does the opposite.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.GetActivityNameByID
+     */
+    GetActivityNameByID(id: number): string;
+}
+
+interface UtilLib {
+    /**
+     * Returns the ID of a custom model animation event. This is useful for models that define custom animation events.
+     *
+     * See [util.GetAnimEventNameByID](https://wiki.facepunch.com/gmod/util.GetAnimEventNameByID) for a function that does the opposite.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.GetAnimEventIDByName
+     */
+    GetAnimEventIDByName(arg0: string): number;
+}
+
+interface UtilLib {
+    /**
+     * Returns a name for given automatically generated numerical animation event ID. This is useful for models that define custom animation events.
+     *
+     * See [util.GetAnimEventIDByName](https://wiki.facepunch.com/gmod/util.GetAnimEventIDByName) for a function that does the opposite.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.GetAnimEventNameByID
+     */
+    GetAnimEventNameByID(id: number): string;
+}
+
+interface UtilLib {
+    /**
+     * Returns a table containing the info about the model. The model will be loaded and cached if it was not previously.
+     *
+     * See also [util.GetModelMeshes](https://wiki.facepunch.com/gmod/util.GetModelMeshes)
+     *
+     * **NOTE**: This function will silently fail if used on models with following strings in them:
+     * * _shared
+     * * _anims
+     * * _gestures
+     * * _anim
+     * * _postures
+     * * _gst
+     * * _pst
+     * * _shd
+     * * _ss
+     * * _anm
+     * * _include
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.GetModelInfo
+     */
+    GetModelInfo(mdl: string): ModelInfo;
+}
+
+interface UtilLib {
+    /**
+     * 		Retrieves vertex, triangle, and bone data for the visual meshes of a given model.
+     *
+     * 		**NOTE**: This does not work on brush models (Models with names in the format `*number`)
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.GetModelMeshes
+     */
+    GetModelMeshes(model: string, lod?: number, bodygroupMask?: string | number, skin?: number): (ModelMeshData[], BoneBindPose[]);
+}
+
+interface UtilLib {
+    /**
+     * Gets persistent data of an offline player using their SteamID.
+     *
+     * See also [Player:GetPData](https://wiki.facepunch.com/gmod/Player:GetPData) for a more convenient version of this function for online players, [util.RemovePData](https://wiki.facepunch.com/gmod/util.RemovePData) and
+     *  [util.SetPData](https://wiki.facepunch.com/gmod/util.SetPData) for the other accompanying functions.
+     *
+     * **NOTE**: This function internally uses [util.SteamIDTo64](https://wiki.facepunch.com/gmod/util.SteamIDTo64), it previously utilized [Player:UniqueID](https://wiki.facepunch.com/gmod/Player:UniqueID) which can cause collisions (two or more players sharing the same PData entry). This function now only uses the old method as a fallback if the name isn't found.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.GetPData
+     */
+    GetPData(steamID: string, name: string, _default: any): string;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * Utility function to quickly generate a trace table that starts at the players view position, and ends `32768` units along a specified direction.
+     *
+     * For usage with [util.TraceLine](https://wiki.facepunch.com/gmod/util.TraceLine) and similar functions.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.GetPlayerTrace
+     */
+    GetPlayerTrace(ply: Player, dir?: Vector): Trace;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * Returns the matching surface property index for the given surface property name.
+     *
+     * See also [util.GetSurfaceData](https://wiki.facepunch.com/gmod/util.GetSurfaceData) and [util.GetSurfacePropName](https://wiki.facepunch.com/gmod/util.GetSurfacePropName) for opposite function.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.GetSurfaceIndex
+     */
+    GetSurfaceIndex(surfaceName: string): number;
+}
+
+interface UtilLib {
+    /**
+     * Returns the name of a surface property at given ID.
+     *
+     * See also [util.GetSurfaceData](https://wiki.facepunch.com/gmod/util.GetSurfaceData) and [util.GetSurfaceIndex](https://wiki.facepunch.com/gmod/util.GetSurfaceIndex) for opposite function.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.GetSurfacePropName
+     */
+    GetSurfacePropName(id: number): string;
+}
+
+interface UtilLib {
+    /**
+     * Returns a table of all SteamIDs that have a usergroup.
+     *
+     * **NOTE**: This returns the original usergroups table, changes done to this table are not retroactive and will only affect newly connected users
+     *
+     *
+     * **NOTE**: This returns only groups that are registered in the **settings/users.txt** file of your server.
+     *
+     * In order to get the usergroup of a connected player, please use [Player:GetUserGroup](https://wiki.facepunch.com/gmod/Player:GetUserGroup) instead.
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/util.GetUserGroups
+     */
+    GetUserGroups(): table;
+}
+
+interface UtilLib {
+    /**
+     * 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);
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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);
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * Checks if a certain position is within the world bounds.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/util.IsInWorld
+     */
+    IsInWorld(position: Vector): boolean;
+}
+
+interface UtilLib {
+    /**
+     * Checks if the model is loaded in the game.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.IsModelLoaded
+     */
+    IsModelLoaded(modelName: string): boolean;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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);
+}
+
+interface UtilLib {
+    /**
+     * Check whether the skybox is visible from the point specified.
+     *
+     * **NOTE**: This will always return true in fullbright maps.
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/util.IsSkyboxVisibleFromPoint
+     */
+    IsSkyboxVisibleFromPoint(position: Vector): boolean;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * Checks if the specified model is valid.
+     *
+     *
+     * A model is considered invalid in following cases:
+     * * Starts with a space or **maps**
+     * * Doesn't start with **models**
+     * * Contains any of the following:
+     *   * `_gestures`
+     *   * `_animations`
+     *   * `_postures`
+     *   * `_gst`
+     *   * `_pst`
+     *   * `_shd`
+     *   * `_ss`
+     *   * `_anm`
+     *   * `.bsp`
+     *   * `cs_fix`
+     * * If the model isn't precached on the server, AND if the model file doesn't exist on disk
+     * * If precache failed
+     * * Model is the error model
+     *
+     * Running this function will also precache the model.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.IsValidModel
+     */
+    IsValidModel(modelName: string): boolean;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * Converts a JSON string to a Lua table. It supports comments and trailing commas.
+     *
+     * See [util.TableToJSON](https://wiki.facepunch.com/gmod/util.TableToJSON) for the opposite function.
+     *
+     * Colors will not have the color metatable.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.JSONToTable
+     */
+    JSONToTable(json: string, ignoreLimits?: boolean, ignoreConversions?: boolean): table | nil;
+}
+
+interface UtilLib {
+    /**
+     * Converts a Valve KeyValue string (typically from [util.TableToKeyValues](https://wiki.facepunch.com/gmod/util.TableToKeyValues)) to a Lua table.
+     *
+     * **NOTE**: Due to how [table](https://wiki.facepunch.com/gmod/table)s work in Lua, keys will not repeat within a table. See [util.KeyValuesToTablePreserveOrder](https://wiki.facepunch.com/gmod/util.KeyValuesToTablePreserveOrder) for alternative.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.KeyValuesToTable
+     */
+    KeyValuesToTable(keyValues: string, usesEscapeSequences?: boolean, preserveKeyCase?: boolean): table;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * A convenience function around LocalToWorld-related functions.
+     *
+     * **NOTE**: If [Entity:EntIndex](https://wiki.facepunch.com/gmod/Entity:EntIndex) returns `0`, the function will return the passed `lpos`.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.LocalToWorld
+     */
+    LocalToWorld(ent: Entity, lpos: Vector, bone?: number): Vector;
+}
+
+interface UtilLib {
+    /**
+     * 		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).
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.MD5
+     */
+    MD5(stringToHash: string): string;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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.
+     *
+     * Internally uses `ParticleTracer` engine effect. ([util.Effect](https://wiki.facepunch.com/gmod/util.Effect)) which then spawns in `ParticleEffect` effect.
+     * **NOTE**: The default bullet effect is not in .pcf format, therefore it is not used with util.ParticleTracer.  Consider utilizing [util.Effect](https://wiki.facepunch.com/gmod/util.Effect) instead
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.ParticleTracer
+     */
+    ParticleTracer(name: string, startPos: Vector, endPos: Vector, doWhiz: boolean): void;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * Returns the visibility of a square that is always pointed at the camera in the world-space.
+     *
+     * This is typically used for in-game sprites or "billboards". ([render.DrawSprite](https://wiki.facepunch.com/gmod/render.DrawSprite))
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/util.PixelVisible
+     */
+    PixelVisible(position: Vector, size: number, PixVis: pixelvis_handle_t): number;
+}
+
+interface UtilLib {
+    /**
+     * 		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.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.PointContents
+     */
+    PointContents(position: Vector): CONTENTS;
+}
+
+interface UtilLib {
+    /**
+     * 	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.
+     *
+     *
+     * 		**NOTE**: Does nothing on the client.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.PrecacheModel
+     */
+    PrecacheModel(modelName: string): void;
+}
+
+interface UtilLib {
+    /**
+     * 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.
+     *
+     *
+     * Ultimately does nothing on client, and only works with sound scripts, not direct paths.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.PrecacheSound
+     */
+    PrecacheSound(soundName: string): void;
+}
+
+interface UtilLib {
+    /**
+     * 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.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.QuickTrace
+     */
+    QuickTrace(origin: Vector, dir: Vector, filter?: Entity | Entity[] | string[] | function): TraceResult;
+}
+
+interface UtilLib {
+    /**
+     * 		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.
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/util.RelativePathToFull_Menu
+     */
+    RelativePathToFull_Menu(filePath: string, mountPath?: string): string;
+}
+
+interface UtilLib {
+    /**
+     * 		Returns which Workshop addon the given file belongs to.
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/util.RelativePathToGMA_Menu
+     */
+    RelativePathToGMA_Menu(filePath: string): table;
+}
+
+interface UtilLib {
+    /**
+     * Removes world decals at given position, in given radius. Does not remove decals on models!
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/util.RemoveDecalsAt
+     */
+    RemoveDecalsAt(pos: Vector, distance: number, limit?: number, permanent?: boolean): number;
+}
+
+interface UtilLib {
+    /**
+     * Removes persistent data of an offline player using their SteamID.
+     *
+     * See also [Player:RemovePData](https://wiki.facepunch.com/gmod/Player:RemovePData) for a more convenient version of this function for online players, [util.SetPData](https://wiki.facepunch.com/gmod/util.SetPData) and
+     *  [util.GetPData](https://wiki.facepunch.com/gmod/util.GetPData) for the other accompanying functions.
+     *
+     * **NOTE**: This function internally uses [util.SteamIDTo64](https://wiki.facepunch.com/gmod/util.SteamIDTo64), it previously utilized [Player:UniqueID](https://wiki.facepunch.com/gmod/Player:UniqueID) which can cause collisions (two or more players sharing the same PData entry). This function now tries to remove both old and new entries.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.RemovePData
+     */
+    RemovePData(steamID: string, name: string): void;
+}
+
+interface UtilLib {
+    /**
+     * 		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).
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.SHA1
+     */
+    SHA1(stringToHash: string): string;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * Makes the screen shake.
+     *
+     * **NOTE**: The screen shake effect is rendered by modifying the view origin on the client. If you override the view origin in [GM:CalcView](https://wiki.facepunch.com/gmod/GM:CalcView) you may not be able to see the shake effect.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.ScreenShake
+     */
+    ScreenShake(pos: Vector, amplitude: number, frequency: number, duration: number, radius: number, airshake?: boolean, filter?: CRecipientFilter): void;
+}
+
+interface UtilLib {
+    /**
+     * Sets persistent data for offline player using their SteamID.
+     *
+     * See also [Player:SetPData](https://wiki.facepunch.com/gmod/Player:SetPData) for a more convenient version of this function for online players, [util.RemovePData](https://wiki.facepunch.com/gmod/util.RemovePData) and
+     *  [util.GetPData](https://wiki.facepunch.com/gmod/util.GetPData) for the other accompanying functions.
+     * **NOTE**: This function internally uses [util.SteamIDTo64](https://wiki.facepunch.com/gmod/util.SteamIDTo64), it previously utilized [Player:UniqueID](https://wiki.facepunch.com/gmod/Player:UniqueID) which could have caused collisions (two or more players sharing the same PData entry).
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.SetPData
+     */
+    SetPData(steamID: string, name: string, value: any): void;
+}
+
+interface UtilLib {
+    /**
+     * Generates a random float value that should be the same on client and server.
+     *
+     * **NOTE**: This function is best used in a [predicted hook](https://wiki.facepunch.com/gmod/prediction).
+     *
+     *
+     * This uses a different method of obtaining random numbers and is unaffected by [math.randomseed](https://wiki.facepunch.com/gmod/math.randomseed). Instead it uses an internal seed that is based on the player's current predicted command and is fixed to a value of -1 outside of prediction.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.SharedRandom
+     */
+    SharedRandom(uniqueName: string, min: number, max: number, additionalSeed?: number): number;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * 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.
+     *
+     * **NOTE**: This operation induces data loss. Not all fields of a [64bit SteamID](https://developer.valvesoftware.com/wiki/SteamID) can be represented using the `STEAM_0:0:0` format, specifically the "account type" and "account instance" fields.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.SteamIDFrom64
+     */
+    SteamIDFrom64(id: string): string;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * Converts a string to the specified type.
+     *
+     * This can be useful when dealing with ConVars.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.StringToType
+     */
+    StringToType(str: string, typename: string): any;
+}
+
+interface UtilLib {
+    /**
+     * 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.
+     *
+     * See [util.JSONToTable](https://wiki.facepunch.com/gmod/util.JSONToTable) for the opposite function.
+     *
+     * **WARNING**: All keys are strings in the JSON format, so all keys of other types will be converted to strings!
+     * This can lead to loss of data where a number key could be converted into an already existing string key! (for example in a table like this: `{["5"] = "ok", [5] = "BBB"}`)
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.TableToJSON
+     */
+    TableToJSON(table: table, prettyPrint?: boolean): string;
+}
+
+interface UtilLib {
+    /**
+     * Converts the given table into a Valve keyValue formatted string.
+     *
+     * Use [util.KeyValuesToTable](https://wiki.facepunch.com/gmod/util.KeyValuesToTable) to perform the opposite transformation.
+     *
+     * [util.TableToJSON](https://wiki.facepunch.com/gmod/util.TableToJSON) can be used as an alternative.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.TableToKeyValues
+     */
+    TableToKeyValues(table: table, rootKey?: string): string;
+}
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * Returns the time since this function has been last called
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.TimerCycle
+     */
+    TimerCycle(): number;
+}
+
+interface UtilLib {
+    /**
+     * 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).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.TraceEntity
+     */
+    TraceEntity(tracedata: Trace, ent: Entity): TraceResult;
+}
+
+
+interface UtilLib {
+    /**
+     * 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).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.TraceEntityHull
+     */
+    TraceEntityHull(tracedata: HullTrace, ent: Entity): TraceResult;
+}
+
+
+interface UtilLib {
+    /**
+     * 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
+     * a simple line ("ray") trace.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.TraceHull
+     */
+    TraceHull(TraceData: HullTrace): TraceResult;
+}
+
+
+interface UtilLib {
+    /**
+     * 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.
+     * See util.TraceHull for a "box" type trace.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/util.TraceLine
+     */
+    TraceLine(traceConfig: Trace): TraceResult;
+}
+
+
+interface UtilLib {
+    /**
+     * 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;
+}
+
+interface UtilLib {
+    /**
+     * Converts string or a number to a bool, if possible. Alias of [Global.tobool](https://wiki.facepunch.com/gmod/Global.tobool).
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/util.tobool
+     * @deprecated You should use Global.tobool instead.
+     */
+    tobool(input: any): boolean;
+}
+
+interface UtilworldpickerLib {
+    /**
+     * Returns if the user is currently picking an entity.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/util.worldpicker.Active
+     */
+    Active(): boolean;
+}
+
+interface UtilworldpickerLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Finishes the world picking. This is called when a user presses their mouse after calling [util.worldpicker.Start](https://wiki.facepunch.com/gmod/util.worldpicker.Start).
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/util.worldpicker.Finish
+     */
+    Finish(tr: TraceResult): void;
+}
+
+interface UtilworldpickerLib {
+    /**
+     * 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
+     * @source https://wiki.facepunch.com/gmod/util.worldpicker.Start
+     */
+    Start(callback: (tr: table) => void): void;
+}
+