@tlua/gmod 1.0.1

package/navmesh.d.tlua

@@ -0,0 +1,274 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The navigation mesh library. To be used with [CNavArea](https://wiki.facepunch.com/gmod/CNavArea).
+ *
+ * The navigation mesh is used by [NextBot](https://wiki.facepunch.com/gmod/NextBot) to calculate path to its target.
+ * @source https://wiki.facepunch.com/gmod/navmesh
+ */
+declare navmesh: NavmeshLib;
+
+interface NavmeshLib {
+    /**
+     * Add this position and normal to the list of walkable positions, used before map generation with [navmesh.BeginGeneration](https://wiki.facepunch.com/gmod/navmesh.BeginGeneration)
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.AddWalkableSeed
+     */
+    AddWalkableSeed(pos: Vector, dir: Vector): void;
+}
+
+interface NavmeshLib {
+    /**
+     * Starts the generation of a new navmesh.
+     *
+     * **NOTE**: This process is highly resource intensive and it's not wise to use during normal gameplay
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.BeginGeneration
+     */
+    BeginGeneration(): void;
+}
+
+interface NavmeshLib {
+    /**
+     * Clears all the walkable positions, used before calling [navmesh.BeginGeneration](https://wiki.facepunch.com/gmod/navmesh.BeginGeneration).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.ClearWalkableSeeds
+     */
+    ClearWalkableSeeds(): void;
+}
+
+interface NavmeshLib {
+    /**
+     * Creates a new [CNavArea](https://wiki.facepunch.com/gmod/CNavArea).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.CreateNavArea
+     */
+    CreateNavArea(corner: Vector, opposite_corner: Vector): CNavArea;
+}
+
+interface NavmeshLib {
+    /**
+     * Creates a new [CNavLadder](https://wiki.facepunch.com/gmod/CNavLadder).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.CreateNavLadder
+     */
+    CreateNavLadder(top: Vector, bottom: Vector, width: number, dir: Vector, maxHeightAboveTopArea?: number): CNavLadder;
+}
+
+interface NavmeshLib {
+    /**
+     * Returns a list of areas within distance, used to find hiding spots by [NextBot](https://wiki.facepunch.com/gmod/NextBot)s for example.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.Find
+     */
+    Find(pos: Vector, radius: number, stepHeight: number, dropHeight: number): table;
+}
+
+interface NavmeshLib {
+    /**
+     * Returns a list of [CNavArea](https://wiki.facepunch.com/gmod/CNavArea)s overlapping the given cube extents.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.FindInBox
+     */
+    FindInBox(pos1: Vector, pos2: Vector): table;
+}
+
+interface NavmeshLib {
+    /**
+     * Returns an integer indexed table of all [CNavArea](https://wiki.facepunch.com/gmod/CNavArea)s on the current map. If the map doesn't have a navmesh generated then this will return an empty table.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.GetAllNavAreas
+     */
+    GetAllNavAreas(): CNavArea[];
+}
+
+interface NavmeshLib {
+    /**
+     * Returns a table of all blocked [CNavArea](https://wiki.facepunch.com/gmod/CNavArea)s on the current map. See [CNavArea:MarkAsBlocked](https://wiki.facepunch.com/gmod/CNavArea:MarkAsBlocked).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.GetBlockedAreas
+     */
+    GetBlockedAreas(): table;
+}
+
+interface NavmeshLib {
+    /**
+     * Returns the position of the edit cursor when nav_edit is set to 1.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.GetEditCursorPosition
+     */
+    GetEditCursorPosition(): Vector;
+}
+
+interface NavmeshLib {
+    /**
+     * Finds the closest standable ground at, above, or below the provided position.
+     *
+     * **NOTE**: The ground must have at least 32 units of empty space above it to be considered by this function, unless 16 layers are tested without finding valid ground.
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.GetGroundHeight
+     */
+    GetGroundHeight(pos: Vector): (number, Vector);
+}
+
+interface NavmeshLib {
+    /**
+     * Returns the currently marked [CNavArea](https://wiki.facepunch.com/gmod/CNavArea), for use with editing console commands.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.GetMarkedArea
+     */
+    GetMarkedArea(): CNavArea;
+}
+
+interface NavmeshLib {
+    /**
+     * Returns the currently marked [CNavLadder](https://wiki.facepunch.com/gmod/CNavLadder), for use with editing console commands.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.GetMarkedLadder
+     */
+    GetMarkedLadder(): CNavLadder;
+}
+
+interface NavmeshLib {
+    /**
+     * Returns the Nav Area contained in this position that also satisfies the elevation limit.
+     *
+     * This function will properly see blocked [CNavArea](https://wiki.facepunch.com/gmod/CNavArea)s. See [navmesh.GetNearestNavArea](https://wiki.facepunch.com/gmod/navmesh.GetNearestNavArea).
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.GetNavArea
+     */
+    GetNavArea(pos: Vector, beneathLimit: number): CNavArea;
+}
+
+interface NavmeshLib {
+    /**
+     * Returns a [CNavArea](https://wiki.facepunch.com/gmod/CNavArea) by the given ID.
+     *
+     * **NOTE**: Avoid calling this function every frame, as internally it does a lookup trough all the [CNavArea](https://wiki.facepunch.com/gmod/CNavArea)s, call this once and store the result
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.GetNavAreaByID
+     */
+    GetNavAreaByID(id: number): CNavArea;
+}
+
+interface NavmeshLib {
+    /**
+     * Returns the total count of nav areas on the map. If you want to get all nav areas, use [navmesh.GetAllNavAreas](https://wiki.facepunch.com/gmod/navmesh.GetAllNavAreas) instead as nav areas IDs are not always sequential.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.GetNavAreaCount
+     */
+    GetNavAreaCount(): number;
+}
+
+interface NavmeshLib {
+    /**
+     * Returns a [CNavLadder](https://wiki.facepunch.com/gmod/CNavLadder) by the given ID.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.GetNavLadderByID
+     */
+    GetNavLadderByID(id: number): CNavLadder;
+}
+
+interface NavmeshLib {
+    /**
+     * Returns the closest [CNavArea](https://wiki.facepunch.com/gmod/CNavArea) to given position at the same height, or beneath it.
+     *
+     * This function will ignore blocked [CNavArea](https://wiki.facepunch.com/gmod/CNavArea)s. See [navmesh.GetNavArea](https://wiki.facepunch.com/gmod/navmesh.GetNavArea) for a function that does see blocked areas.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.GetNearestNavArea
+     */
+    GetNearestNavArea(pos: Vector, anyZ?: boolean, maxDist?: number, checkLOS?: boolean, checkGround?: boolean, team?: number): CNavArea;
+}
+
+interface NavmeshLib {
+    /**
+     * Returns the classname of the player spawn entity.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.GetPlayerSpawnName
+     */
+    GetPlayerSpawnName(): string;
+}
+
+interface NavmeshLib {
+    /**
+     * Whether we're currently generating a new navmesh with [navmesh.BeginGeneration](https://wiki.facepunch.com/gmod/navmesh.BeginGeneration).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.IsGenerating
+     */
+    IsGenerating(): boolean;
+}
+
+interface NavmeshLib {
+    /**
+     * Returns true if a navmesh has been loaded when loading the map.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.IsLoaded
+     */
+    IsLoaded(): boolean;
+}
+
+interface NavmeshLib {
+    /**
+     * 		Loads a new navmesh from the .nav file for current map discarding any changes made to the navmesh previously.
+     * 		**WARNING**: Calling this function too soon, causes the Server to crash!
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.Load
+     */
+    Load(): void;
+}
+
+interface NavmeshLib {
+    /**
+     * Deletes every [CNavArea](https://wiki.facepunch.com/gmod/CNavArea) and [CNavLadder](https://wiki.facepunch.com/gmod/CNavLadder) on the map **without saving the changes**.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.Reset
+     */
+    Reset(): void;
+}
+
+interface NavmeshLib {
+    /**
+     * Saves any changes made to navmesh to the .nav file.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.Save
+     */
+    Save(): void;
+}
+
+interface NavmeshLib {
+    /**
+     * Sets the [CNavArea](https://wiki.facepunch.com/gmod/CNavArea) as marked, so it can be used with editing console commands.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.SetMarkedArea
+     */
+    SetMarkedArea(area: CNavArea): void;
+}
+
+interface NavmeshLib {
+    /**
+     * Sets the [CNavLadder](https://wiki.facepunch.com/gmod/CNavLadder) as marked, so it can be used with editing console commands.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.SetMarkedLadder
+     */
+    SetMarkedLadder(area: CNavLadder): void;
+}
+
+interface NavmeshLib {
+    /**
+     * Sets the classname of the default spawn point entity, used before generating a new navmesh with [navmesh.BeginGeneration](https://wiki.facepunch.com/gmod/navmesh.BeginGeneration).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/navmesh.SetPlayerSpawnName
+     */
+    SetPlayerSpawnName(spawnPointClass: string): void;
+}
+