@tlua/gmod 1.0.1

package/panellist.d.tlua

@@ -0,0 +1,13 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		A panel list with a custom vertical scroll bar that doesn't have up/down buttons and has a momentum to scrolling.
+ *
+ *
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/PanelList
+ * @deprecated You should use DScrollPanel instead
+ */
+interface PanelList extends Panel {}
+

package/pathfollower.d.tlua

@@ -0,0 +1,301 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Path object for a NextBot NPC and bots created by [player.CreateNextbot](https://wiki.facepunch.com/gmod/player.CreateNextbot). Returned by [Global.Path](https://wiki.facepunch.com/gmod/Global.Path).
+ * @source https://wiki.facepunch.com/gmod/PathFollower
+ */
+interface PathFollower {}
+
+interface PathFollower {
+    /**
+     * Computes the shortest path to the provided entity arg. PathFollower Object must have `Chase` type.
+     *
+     * For PathFollower objects of the `Follow` type use [PathFollower:Compute](https://wiki.facepunch.com/gmod/PathFollower:Compute)
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:Chase
+     */
+    Chase(self: PathFollower, bot: NextBot, ent: Entity, generator?: (area: CNavArea, fromArea: CNavArea, ladder: CNavLadder, elevator: Entity, length: number) => number): void;
+}
+
+interface PathFollower {
+    /**
+     * Compute shortest path from bot to 'goal' via A* algorithm. This only works if the PathFollower is the `Follow` Type.
+     *
+     * For PathFollowers of the `Chase` Type see [PathFollower:Chase](https://wiki.facepunch.com/gmod/PathFollower:Chase)
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:Compute
+     */
+    Compute(self: PathFollower, bot: NextBot, goal: Vector, generator?: (area: CNavArea, fromArea: CNavArea, ladder: CNavLadder, elevator: Entity, length: number) => number): boolean;
+}
+
+interface PathFollower {
+    /**
+     * Draws the path. This is meant for debugging - and uses [debugoverlay](https://wiki.facepunch.com/gmod/debugoverlay).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:Draw
+     */
+    Draw(self: PathFollower): void;
+}
+
+interface PathFollower {
+    /**
+     * Returns the first segment of the path.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:FirstSegment
+     */
+    FirstSegment(self: PathFollower): table;
+}
+
+interface PathFollower {
+    /**
+     * Returns the age since the path was built
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetAge
+     */
+    GetAge(self: PathFollower): number;
+}
+
+interface PathFollower {
+    /**
+     * Returns all of the segments of the given path.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetAllSegments
+     */
+    GetAllSegments(self: PathFollower): PathSegment;
+}
+
+interface PathFollower {
+    /**
+     * The closest position along the path to a position
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetClosestPosition
+     */
+    GetClosestPosition(self: PathFollower, position: Vector): Vector;
+}
+
+interface PathFollower {
+    /**
+     * Returns the current goal data. Can return nil if the current goal is invalid, for example immediately after [PathFollower:Update](https://wiki.facepunch.com/gmod/PathFollower:Update).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetCurrentGoal
+     */
+    GetCurrentGoal(self: PathFollower): table;
+}
+
+interface PathFollower {
+    /**
+     * Returns the cursor data
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetCursorData
+     */
+    GetCursorData(self: PathFollower): table;
+}
+
+interface PathFollower {
+    /**
+     * Returns the current progress along the path
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetCursorPosition
+     */
+    GetCursorPosition(self: PathFollower): number;
+}
+
+interface PathFollower {
+    /**
+     * Returns the path end position
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetEnd
+     */
+    GetEnd(self: PathFollower): Vector;
+}
+
+interface PathFollower {
+    /**
+     * Returns how close we can get to the goal to call it done.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetGoalTolerance
+     */
+    GetGoalTolerance(self: PathFollower): number;
+}
+
+interface PathFollower {
+    /**
+     * Returns the entity the bot is currently trying to avoid.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetHindrance
+     * @deprecated Currently always returns NULL due to internal implementation of Lua Nextbots, where nothing is considered a hindrance, so do not try to use.
+     */
+    GetHindrance(self: PathFollower): Entity;
+}
+
+interface PathFollower {
+    /**
+     * Returns the total length of the path
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetLength
+     */
+    GetLength(self: PathFollower): number;
+}
+
+interface PathFollower {
+    /**
+     * Returns the minimum range movement goal must be along path.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetMinLookAheadDistance
+     */
+    GetMinLookAheadDistance(self: PathFollower): number;
+}
+
+interface PathFollower {
+    /**
+     * Returns the vector position of distance along path
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetPositionOnPath
+     */
+    GetPositionOnPath(self: PathFollower, distance: number): Vector;
+}
+
+interface PathFollower {
+    /**
+     * Returns the path start position
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:GetStart
+     */
+    GetStart(self: PathFollower): Vector;
+}
+
+interface PathFollower {
+    /**
+     * Invalidates the current path
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:Invalidate
+     */
+    Invalidate(self: PathFollower): void;
+}
+
+interface PathFollower {
+    /**
+     * Returns true if the path is valid
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:IsValid
+     */
+    IsValid(self: PathFollower): boolean;
+}
+
+interface PathFollower {
+    /**
+     * Returns the last segment of the path.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:LastSegment
+     */
+    LastSegment(self: PathFollower): table;
+}
+
+interface PathFollower {
+    /**
+     * Moves the cursor by give distance.
+     *
+     * For a function that sets the distance, see [PathFollower:MoveCursorTo](https://wiki.facepunch.com/gmod/PathFollower:MoveCursorTo).
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:MoveCursor
+     */
+    MoveCursor(self: PathFollower, distance: number): void;
+}
+
+interface PathFollower {
+    /**
+     * Sets the cursor position to given distance.
+     *
+     * For relative distance, see [PathFollower:MoveCursor](https://wiki.facepunch.com/gmod/PathFollower:MoveCursor).
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:MoveCursorTo
+     */
+    MoveCursorTo(self: PathFollower, distance: number): void;
+}
+
+interface PathFollower {
+    /**
+     * Moves the cursor of the path to the closest position compared to given vector.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:MoveCursorToClosestPosition
+     */
+    MoveCursorToClosestPosition(self: PathFollower, pos: Vector, type?: number, alongLimit?: number): void;
+}
+
+interface PathFollower {
+    /**
+     * Moves the cursor to the end of the path
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:MoveCursorToEnd
+     */
+    MoveCursorToEnd(self: PathFollower): void;
+}
+
+interface PathFollower {
+    /**
+     * Moves the cursor to the end of the path
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:MoveCursorToStart
+     */
+    MoveCursorToStart(self: PathFollower): void;
+}
+
+interface PathFollower {
+    /**
+     * Returns the next segment of the path.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:NextSegment
+     */
+    NextSegment(self: PathFollower): table;
+}
+
+interface PathFollower {
+    /**
+     * Returns the previous segment of the path.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:PriorSegment
+     */
+    PriorSegment(self: PathFollower): table;
+}
+
+interface PathFollower {
+    /**
+     * Resets the age which is retrieved by [PathFollower:GetAge](https://wiki.facepunch.com/gmod/PathFollower:GetAge) to 0.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:ResetAge
+     */
+    ResetAge(self: PathFollower): void;
+}
+
+interface PathFollower {
+    /**
+     * How close we can get to the goal to call it done
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:SetGoalTolerance
+     */
+    SetGoalTolerance(self: PathFollower, distance: number): void;
+}
+
+interface PathFollower {
+    /**
+     * Sets minimum range movement goal must be along path
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:SetMinLookAheadDistance
+     */
+    SetMinLookAheadDistance(self: PathFollower, mindist: number): void;
+}
+
+interface PathFollower {
+    /**
+     * Move the bot along the path.
+     *     **NOTE**: player nextbots require [CUserCmd:SetForwardMove](https://wiki.facepunch.com/gmod/CUserCmd:SetForwardMove) to move forward along the path
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/PathFollower:Update
+     */
+    Update(self: PathFollower, bot: NextBot): void;
+}
+

package/permissions.d.tlua

@@ -0,0 +1,77 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Used to ask player for various potentially dangerous permissions.
+ * @source https://wiki.facepunch.com/gmod/permissions
+ */
+declare permissions: PermissionsLib;
+
+interface PermissionsLib {
+    /**
+     * Requests the player to connect to a specified server. The player will be prompted with a confirmation window.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/permissions.AskToConnect
+     */
+    AskToConnect(address: string): void;
+}
+
+interface PermissionsLib {
+    /**
+     * Connects player to the server. This is what [permissions.AskToConnect](https://wiki.facepunch.com/gmod/permissions.AskToConnect) uses internally.
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/permissions.Connect
+     */
+    Connect(ip: string): void;
+}
+
+interface PermissionsLib {
+    /**
+     * Activates player's microphone as if they pressed the speak button themself. The player will be prompted with a confirmation window which grants permission temporarily/permanently(depending on checkbox state) for the connected server (revokable).
+     * This is used for TTT's traitor voice channel.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/permissions.EnableVoiceChat
+     */
+    EnableVoiceChat(enable: boolean): void;
+}
+
+interface PermissionsLib {
+    /**
+     * Returns all permissions per server. Permanent permissions are stored in `settings/permissions.bin`.
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/permissions.GetAll
+     */
+    GetAll(): Table<string, table>;
+}
+
+interface PermissionsLib {
+    /**
+     * Grants permission to the current connected server.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/permissions.Grant
+     */
+    Grant(permission: string, temporary: boolean): void;
+}
+
+interface PermissionsLib {
+    /**
+     * Returns whether the player has granted the current server a specific permission.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/permissions.IsGranted
+     */
+    IsGranted(permission: string): boolean;
+}
+
+interface PermissionsLib {
+    /**
+     * Revokes permission from the server.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/permissions.Revoke
+     */
+    Revoke(permission: string, ip: string): void;
+}
+

package/physcollide.d.tlua

@@ -0,0 +1,40 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * A PhysCollide holds collision data from VPhysics. These objects can be used to run (currently quite limited) collision tests, but do not represent actual physics objects.
+ *
+ * Created by [Global.CreatePhysCollideBox](https://wiki.facepunch.com/gmod/Global.CreatePhysCollideBox) or [Global.CreatePhysCollidesFromModel](https://wiki.facepunch.com/gmod/Global.CreatePhysCollidesFromModel).
+ * @source https://wiki.facepunch.com/gmod/PhysCollide
+ */
+interface PhysCollide {}
+
+interface PhysCollide {
+    /**
+     * Destroys the [PhysCollide](https://wiki.facepunch.com/gmod/PhysCollide) object.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/PhysCollide:Destroy
+     */
+    Destroy(self: PhysCollide): void;
+}
+
+interface PhysCollide {
+    /**
+     * Checks whether this [PhysCollide](https://wiki.facepunch.com/gmod/PhysCollide) object is valid or not.
+     *
+     * You should just use [Global.IsValid](https://wiki.facepunch.com/gmod/Global.IsValid) instead.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/PhysCollide:IsValid
+     */
+    IsValid(self: PhysCollide): boolean;
+}
+
+interface PhysCollide {
+    /**
+     * Performs a trace against this PhysCollide with the given parameters. This can be used for both line traces and box traces.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/PhysCollide:TraceBox
+     */
+    TraceBox(self: PhysCollide, origin: Vector, angles: Angle, rayStart: Vector, rayEnd: Vector, rayMins: Vector, rayMaxs: Vector): (Vector, Vector, number);
+}
+

package/physenv.d.tlua

@@ -0,0 +1,136 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The physenv library allows you to control the physics environment created by the engine, and lets you modify constants such as gravity and maximum velocity.
+ * @source https://wiki.facepunch.com/gmod/physenv
+ */
+declare physenv: PhysenvLib;
+
+interface PhysenvLib {
+    /**
+     * Adds a [material surface property](https://developer.valvesoftware.com/wiki/Material_surface_properties) type to the game's physics environment.
+     *
+     * See [util.GetSurfaceData](https://wiki.facepunch.com/gmod/util.GetSurfaceData) for the opposite function.
+     *
+     * The game has a limit of 128 surface properties - this includes properties loaded automatically from [surfaceproperties.txt](https://github.com/Facepunch/garrysmod/blob/master/garrysmod/scripts/surfaceproperties.txt). Due to this, there's only a small amount of open slots that can be registered with GMod's provided surfaceproperties.txt.
+     *
+     * Does nothing on `x86-64` beta.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/physenv.AddSurfaceData
+     */
+    AddSurfaceData(properties: string): void;
+}
+
+interface PhysenvLib {
+    /**
+     * Returns the air density used to calculate drag on physics objects.
+     * 		The unit is in `kg/m³`.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/physenv.GetAirDensity
+     */
+    GetAirDensity(): number;
+}
+
+interface PhysenvLib {
+    /**
+     * Gets the gravitational acceleration used for physics objects in `source_unit/s^2`.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/physenv.GetGravity
+     */
+    GetGravity(): Vector;
+}
+
+interface PhysenvLib {
+    /**
+     * 		Returns the last simulation duration of the in-game physics.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/physenv.GetLastSimulationTime
+     */
+    GetLastSimulationTime(): number;
+}
+
+interface PhysenvLib {
+    /**
+     * Gets the current performance settings in table form.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/physenv.GetPerformanceSettings
+     */
+    GetPerformanceSettings(): table;
+}
+
+interface PhysenvLib {
+    /**
+     * Returns the pause status of global physics simulation. See [physenv.SetPhysicsPaused](https://wiki.facepunch.com/gmod/physenv.SetPhysicsPaused) for the setter.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/physenv.GetPhysicsPaused
+     */
+    GetPhysicsPaused(): boolean;
+}
+
+interface PhysenvLib {
+    /**
+     * 		Returns the physics time scale set with [physenv.SetTimeScale](https://wiki.facepunch.com/gmod/physenv.SetTimeScale).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/physenv.GetTimeScale
+     */
+    GetTimeScale(): number;
+}
+
+interface PhysenvLib {
+    /**
+     * Sets the air density.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/physenv.SetAirDensity
+     */
+    SetAirDensity(airDensity: number): void;
+}
+
+interface PhysenvLib {
+    /**
+     * Sets the gravitational acceleration used for physics objects. Does not affect players.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/physenv.SetGravity
+     */
+    SetGravity(gravAccel: Vector): void;
+}
+
+interface PhysenvLib {
+    /**
+     * Sets the performance settings.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/physenv.SetPerformanceSettings
+     */
+    SetPerformanceSettings(performanceSettings: PhysEnvPerformanceSettings): void;
+}
+
+interface PhysenvLib {
+    /**
+     * Pauses or unpauses the physics simulation globally. See [physenv.GetPhysicsPaused](https://wiki.facepunch.com/gmod/physenv.GetPhysicsPaused) for the getter.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/physenv.SetPhysicsPaused
+     */
+    SetPhysicsPaused(pause: boolean): void;
+}
+
+interface PhysenvLib {
+    /**
+     * Sets the time scale of the physics simulation.
+     *
+     * This will affect serverside-only physics if called on server, and clientside-only physics if used on the client.
+     *
+     * See [game.SetTimeScale](https://wiki.facepunch.com/gmod/game.SetTimeScale) for a function that also affects all game logic.
+     *
+     * The true timescale will be `phys_timescale` (`cl_phys_timescale` on client) multiplied by [physenv.GetTimeScale](https://wiki.facepunch.com/gmod/physenv.GetTimeScale).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/physenv.SetTimeScale
+     */
+    SetTimeScale(timeScale: number): void;
+}
+