@tlua/gmod 1.0.1

package/ents.d.tlua

@@ -0,0 +1,267 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The ents library provides functions for creating and finding entities in the game.
+ * @source https://wiki.facepunch.com/gmod/ents
+ */
+declare ents: EntsLib;
+
+interface EntsLib {
+    /**
+     * Creates an entity by class name. Fails and returns `NULL` if the
+     * networked-edict limit is hit (~8176) or the class doesn't exist.
+     *
+     * NOTE: the wiki maps the class string to a concrete Entity subtype via a
+     * class-string generic (`class: \`T\``); tlua cannot map a string literal to
+     * a nominal type, so this returns the base Entity.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/ents.Create
+     */
+    Create(class: string): Entity;
+}
+
+
+interface EntsLib {
+    /**
+     * Creates a clientside only prop with optional physics.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ents.CreateClientProp
+     */
+    CreateClientProp(model?: string): Entity;
+}
+
+
+interface EntsLib {
+    /**
+     * 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
+     * when one of the attached entities is removed.
+     *
+     * `extra` accepts optional settings: `slack`, `width`, `segments`,
+     * `material`, `nogravity`.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ents.CreateClientRope
+     */
+    CreateClientRope(ent1: Entity, ent1attach: number | Vector, ent2: Entity, ent2attach: number | Vector, extra?: table): Entity;
+}
+
+
+interface EntsLib {
+    /**
+     * Creates a clientside only scripted entity. The scripted entity must be of
+     * "anim" type.
+     *
+     * NOTE: the wiki maps the class string to a concrete Entity subtype via a
+     * class-string generic; tlua cannot map a string literal to a nominal type,
+     * so this returns the base Entity.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/ents.CreateClientside
+     */
+    CreateClientside(class: string): Entity;
+}
+
+
+interface EntsLib {
+    /**
+     * Returns a table of all entities along the ray. The ray does not stop on collisions, meaning it will go through walls/entities.
+     *
+     * This function is capable of detecting clientside only entities by default.
+     *
+     * This internally uses [spatial partitioning](https://en.wikipedia.org/wiki/Space_partitioning) to avoid looping through all entities.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ents.FindAlongRay
+     */
+    FindAlongRay(start: Vector, _end: Vector, mins?: Vector, maxs?: Vector): Entity[];
+}
+
+interface EntsLib {
+    /**
+     * Gets all entities with the given class, supports wildcards.
+     *
+     * This function returns a sequential table, meaning it should be looped with [Global.ipairs](https://wiki.facepunch.com/gmod/Global.ipairs) instead of [Global.pairs](https://wiki.facepunch.com/gmod/Global.pairs) for efficiency reasons.
+     *
+     * This works internally by iterating over [ents.GetAll](https://wiki.facepunch.com/gmod/ents.GetAll). `ents.FindByClass` is always faster than [ents.GetAll](https://wiki.facepunch.com/gmod/ents.GetAll) or [ents.Iterator](https://wiki.facepunch.com/gmod/ents.Iterator).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ents.FindByClass
+     */
+    FindByClass(_class: string): Entity[];
+}
+
+interface EntsLib {
+    /**
+     * 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[];
+}
+
+interface EntsLib {
+    /**
+     * Gets all entities with the given model, supports wildcards.
+     *
+     * This works internally by iterating over [ents.GetAll](https://wiki.facepunch.com/gmod/ents.GetAll).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ents.FindByModel
+     */
+    FindByModel(model: string): Entity[];
+}
+
+interface EntsLib {
+    /**
+     * Gets all entities with the given hammer targetname. This works internally by iterating over [ents.GetAll](https://wiki.facepunch.com/gmod/ents.GetAll).
+     *
+     * Doesn't do anything on client.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ents.FindByName
+     */
+    FindByName(name: string): Entity[];
+}
+
+interface EntsLib {
+    /**
+     * Returns all entities within the specified box.
+     *
+     * This internally uses a Spatial Partition to avoid looping through all entities, so it is more efficient than using [ents.GetAll](https://wiki.facepunch.com/gmod/ents.GetAll) for this purpose.
+     *
+     * **NOTE**: Clientside entities will not be returned by this function. Serverside only entities without networked edicts (entity indexes), such as point logic or Constraints are not returned either
+     *
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ents.FindInBox
+     */
+    FindInBox(boxMins: Vector, boxMaxs: Vector): Entity[];
+}
+
+interface EntsLib {
+    /**
+     * 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.
+     *
+     * The "cone" is actually a conical "slice" of an axis-aligned box (see: [ents.FindInBox](https://wiki.facepunch.com/gmod/ents.FindInBox)). The image to the right shows approximately how this function would look in 2D. Due to this, the entity may be farther than the specified range!
+     *
+     *
+     *
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ents.FindInCone
+     */
+    FindInCone(origin: Vector, normal: Vector, range: number, angle_cos: number): Entity[];
+}
+
+interface EntsLib {
+    /**
+     * Finds all entities that lie within a [PVS (Potential Visibility Set)](https://developer.valvesoftware.com/wiki/PVS "PVS - Valve Developer Community").
+     *
+     * **NOTE**: The function won't take in to account [Global.AddOriginToPVS](https://wiki.facepunch.com/gmod/Global.AddOriginToPVS) and the like.
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/ents.FindInPVS
+     */
+    FindInPVS(viewPoint: Entity | Vector): Entity[];
+}
+
+interface EntsLib {
+    /**
+     * Gets all entities within the specified sphere.
+     *
+     * This function internally calls [util.IsBoxIntersectingSphere](https://wiki.facepunch.com/gmod/util.IsBoxIntersectingSphere) for every entity on the map based on their Orientated Bounding Box.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ents.FindInSphere
+     */
+    FindInSphere(origin: Vector, radius: number): Entity[];
+}
+
+interface EntsLib {
+    /**
+     * 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;
+}
+
+interface EntsLib {
+    /**
+     * 		Returns a table of all existing entities.
+     *
+     * Consider using [ents.Iterator](https://wiki.facepunch.com/gmod/ents.Iterator) instead for better performance.
+     *
+     * This function returns a sequential table, meaning it should be looped with [Global.ipairs](https://wiki.facepunch.com/gmod/Global.ipairs) instead of [Global.pairs](https://wiki.facepunch.com/gmod/Global.pairs) for efficiency reasons.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ents.GetAll
+     */
+    GetAll(): Entity[];
+}
+
+interface EntsLib {
+    /**
+     * 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;
+}
+
+interface EntsLib {
+    /**
+     * Gives you the amount of currently existing entities.
+     *
+     * Similar to **#**[ents.GetAll](https://wiki.facepunch.com/gmod/ents.GetAll)() but with better performance since the entity table doesn't have to be generated.
+     * If [ents.GetAll](https://wiki.facepunch.com/gmod/ents.GetAll) is already being called for iteration, than using the **#** operator on the table will be faster than calling this function since it is JITted.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ents.GetCount
+     */
+    GetCount(IncludeKillMe?: boolean): number;
+}
+
+interface EntsLib {
+    /**
+     * Returns the amount of networked entities, which is limited to 8192.
+     *
+     * [ents.Create](https://wiki.facepunch.com/gmod/ents.Create) will fail somewhere between 8064 and 8176 - this can vary based on the amount of player slots on the server and other entities.
+     *
+     * See also [MAX_EDICT_BITS](https://wiki.facepunch.com/gmod/Global_Variables#maxedictbits) global variable.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/ents.GetEdictCount
+     */
+    GetEdictCount(): number;
+}
+
+interface EntsLib {
+    /**
+     * Returns entity that has given [Entity:MapCreationID](https://wiki.facepunch.com/gmod/Entity:MapCreationID).
+     *
+     *
+     * 	This works internally by iterating over [ents.GetAll](https://wiki.facepunch.com/gmod/ents.GetAll).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ents.GetMapCreatedEntity
+     */
+    GetMapCreatedEntity(id: number): Entity | nil;
+}
+
+interface EntsLib {
+    /**
+     * Returns a Stateless Iterator for all entities, intended for use in generic
+     * for-loops. Internally uses cached values stored in Lua, making it more
+     * efficient than ents.GetAll.
+     *
+     * Returns the iterator function, a cached table of all existing Entity, and
+     * the origin index (0).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ents.Iterator
+     */
+    Iterator(): ((tbl: any, prev?: number) => (number, Entity), Entity[], number);
+}
+
+