@tlua/gmod 1.0.1

package/cleanup.d.tlua

@@ -0,0 +1,88 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The cleanup library allows you to control what happens to custom entities when the clean-up buttons are pressed in the Utilities tab of the Spawn menu (default Q).
+ * @source https://wiki.facepunch.com/gmod/cleanup
+ */
+declare cleanup: CleanupLib;
+
+interface CleanupLib {
+    /**
+     * Adds an entity to a player's cleanup list.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/cleanup.Add
+     */
+    Add(pl: Player, type: string, ent: Entity): void;
+}
+
+interface CleanupLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *  Called by the `gmod_admin_cleanup` console command. Allows admins to clean up the server.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/cleanup.CC_AdminCleanup
+     */
+    CC_AdminCleanup(pl: Player, command: string, args: table): void;
+}
+
+interface CleanupLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *  Called by the `gmod_cleanup` console command. Allows players to cleanup their own props.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/cleanup.CC_Cleanup
+     */
+    CC_Cleanup(pl: Player, command: string, args: table): void;
+}
+
+interface CleanupLib {
+    /**
+     * Gets the cleanup list.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/cleanup.GetList
+     */
+    GetList(): void;
+}
+
+interface CleanupLib {
+    /**
+     * Gets the table of cleanup types.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/cleanup.GetTable
+     */
+    GetTable(): table;
+}
+
+interface CleanupLib {
+    /**
+     * Registers a new cleanup type.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/cleanup.Register
+     */
+    Register(type: string): void;
+}
+
+interface CleanupLib {
+    /**
+     * Replaces one entity in the cleanup module with another.
+     *
+     * You very likely want to call [undo.ReplaceEntity](https://wiki.facepunch.com/gmod/undo.ReplaceEntity) with the same entities as well.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/cleanup.ReplaceEntity
+     */
+    ReplaceEntity(from: Entity, to: Entity | nil): boolean;
+}
+
+interface CleanupLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Repopulates the clients cleanup menu.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/cleanup.UpdateUI
+     */
+    UpdateUI(): void;
+}
+

package/cluaemitter.d.tlua

@@ -0,0 +1,119 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * List of all possible functions available for LuaEmitters. This is the object returned by the [Global.ParticleEmitter](https://wiki.facepunch.com/gmod/Global.ParticleEmitter) function.
+ * @source https://wiki.facepunch.com/gmod/CLuaEmitter
+ */
+interface CLuaEmitter {}
+
+interface CLuaEmitter {
+    /**
+     * Creates a new [CLuaParticle](https://wiki.facepunch.com/gmod/CLuaParticle) with the given material and position.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaEmitter:Add
+     */
+    Add(self: CLuaEmitter, material: string, position: Vector): CLuaParticle;
+}
+
+interface CLuaEmitter {
+    /**
+     * Manually renders all particles the emitter has created.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaEmitter:Draw
+     */
+    Draw(self: CLuaEmitter): void;
+}
+
+interface CLuaEmitter {
+    /**
+     * Removes the emitter, making it no longer usable from Lua. If particles remain, the emitter will be removed when all particles die.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaEmitter:Finish
+     */
+    Finish(self: CLuaEmitter): void;
+}
+
+interface CLuaEmitter {
+    /**
+     * Returns the amount of active particles of this emitter.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaEmitter:GetNumActiveParticles
+     */
+    GetNumActiveParticles(self: CLuaEmitter): number;
+}
+
+interface CLuaEmitter {
+    /**
+     * Returns the position of this emitter. This is set when creating the emitter with [Global.ParticleEmitter](https://wiki.facepunch.com/gmod/Global.ParticleEmitter).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaEmitter:GetPos
+     */
+    GetPos(self: CLuaEmitter): Vector;
+}
+
+interface CLuaEmitter {
+    /**
+     * Returns whether this emitter is 3D or not. This is set when creating the emitter with [Global.ParticleEmitter](https://wiki.facepunch.com/gmod/Global.ParticleEmitter).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaEmitter:Is3D
+     */
+    Is3D(self: CLuaEmitter): boolean;
+}
+
+interface CLuaEmitter {
+    /**
+     * Returns whether this [CLuaEmitter](https://wiki.facepunch.com/gmod/CLuaEmitter) is valid or not.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaEmitter:IsValid
+     */
+    IsValid(self: CLuaEmitter): boolean;
+}
+
+interface CLuaEmitter {
+    /**
+     * Sets the bounding box for this emitter.
+     *
+     * Usually the bounding box is automatically determined by the particles, but this function overrides it.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaEmitter:SetBBox
+     */
+    SetBBox(self: CLuaEmitter, mins: Vector, maxs: Vector): void;
+}
+
+interface CLuaEmitter {
+    /**
+     * This function sets the the distance between the render camera and the emitter at which the particles should start fading and at which distance fade ends ( alpha becomes 0 ).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaEmitter:SetNearClip
+     */
+    SetNearClip(self: CLuaEmitter, distanceMin: number, distanceMax: number): void;
+}
+
+interface CLuaEmitter {
+    /**
+     * Prevents all particles of the emitter from automatically drawing.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaEmitter:SetNoDraw
+     */
+    SetNoDraw(self: CLuaEmitter, noDraw: boolean): void;
+}
+
+interface CLuaEmitter {
+    /**
+     * The function name has not much in common with its actual function, it applies a radius to every particles that affects the building of the bounding box, as it, usually is constructed by the particle that has the lowest x, y and z and the highest x, y and z, this function just adds/subtracts the radius and inflates the bounding box.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaEmitter:SetParticleCullRadius
+     */
+    SetParticleCullRadius(self: CLuaEmitter, radius: number): void;
+}
+
+interface CLuaEmitter {
+    /**
+     * Sets the position of the particle emitter.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/CLuaEmitter:SetPos
+     */
+    SetPos(self: CLuaEmitter, position: Vector): void;
+}
+

package/clualocomotion.d.tlua

@@ -0,0 +1,383 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * This class is essentially what controls a [NextBot](https://wiki.facepunch.com/gmod/NextBot) NPC. You can access it in a [NextBot](https://wiki.facepunch.com/gmod/NextBot) NPC by using **self.loco** variable.
+ * @source https://wiki.facepunch.com/gmod/CLuaLocomotion
+ */
+interface CLuaLocomotion {}
+
+interface CLuaLocomotion {
+    /**
+     * Moves the [NextBot](https://wiki.facepunch.com/gmod/NextBot) incrementally closer to the provided goal location.
+     *
+     * Each time this function is called, the NextBot moves towards the goal position passed as an argument by the amount previously set by [CLuaLocomotion:SetDesiredSpeed](https://wiki.facepunch.com/gmod/CLuaLocomotion:SetDesiredSpeed).
+     *
+     * To achieve smooth movement, this function must be called frequently.
+     * This is commonly accomplished by calling it in the [ENTITY:Think](https://wiki.facepunch.com/gmod/ENTITY:Think) hook.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:Approach
+     */
+    Approach(self: CLuaLocomotion, goal: Vector, goalWeight: number): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Removes the stuck status from the bot
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:ClearStuck
+     */
+    ClearStuck(self: CLuaLocomotion): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets the direction we want to face
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:FaceTowards
+     */
+    FaceTowards(self: CLuaLocomotion, goal: Vector): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns the acceleration speed
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetAcceleration
+     */
+    GetAcceleration(self: CLuaLocomotion): number;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns whether the Nextbot is allowed to avoid obstacles or not.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetAvoidAllowed
+     */
+    GetAvoidAllowed(self: CLuaLocomotion): boolean;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns whether the Nextbot is allowed to climb or not.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetClimbAllowed
+     */
+    GetClimbAllowed(self: CLuaLocomotion): boolean;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns the current acceleration as a vector
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetCurrentAcceleration
+     */
+    GetCurrentAcceleration(self: CLuaLocomotion): Vector;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Gets the height the bot is scared to fall from
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetDeathDropHeight
+     */
+    GetDeathDropHeight(self: CLuaLocomotion): number;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Gets the deceleration speed
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetDeceleration
+     */
+    GetDeceleration(self: CLuaLocomotion): number;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns the desired movement speed set by [CLuaLocomotion:SetDesiredSpeed](https://wiki.facepunch.com/gmod/CLuaLocomotion:SetDesiredSpeed)
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetDesiredSpeed
+     */
+    GetDesiredSpeed(self: CLuaLocomotion): number;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns the locomotion's gravity.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetGravity
+     */
+    GetGravity(self: CLuaLocomotion): number;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Return unit vector in XY plane describing our direction of motion - even if we are currently not moving
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetGroundMotionVector
+     */
+    GetGroundMotionVector(self: CLuaLocomotion): Vector;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns the current ground normal.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetGroundNormal
+     */
+    GetGroundNormal(self: CLuaLocomotion): Vector;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns whether the Nextbot is allowed to jump gaps or not.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetJumpGapsAllowed
+     */
+    GetJumpGapsAllowed(self: CLuaLocomotion): boolean;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Gets the height of the bot's jump
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetJumpHeight
+     */
+    GetJumpHeight(self: CLuaLocomotion): number;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns maximum jump height of this [CLuaLocomotion](https://wiki.facepunch.com/gmod/CLuaLocomotion).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetMaxJumpHeight
+     */
+    GetMaxJumpHeight(self: CLuaLocomotion): number;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns the max rate at which the NextBot can visually rotate.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetMaxYawRate
+     */
+    GetMaxYawRate(self: CLuaLocomotion): number;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns the [NextBot](https://wiki.facepunch.com/gmod/NextBot) this locomotion is associated with.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetNextBot
+     */
+    GetNextBot(self: CLuaLocomotion): NextBot;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Gets the max height the bot can step up
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetStepHeight
+     */
+    GetStepHeight(self: CLuaLocomotion): number;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns the current movement velocity as a vector
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:GetVelocity
+     */
+    GetVelocity(self: CLuaLocomotion): Vector;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns whether this [CLuaLocomotion](https://wiki.facepunch.com/gmod/CLuaLocomotion) can reach and/or traverse/move in given [CNavArea](https://wiki.facepunch.com/gmod/CNavArea).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:IsAreaTraversable
+     */
+    IsAreaTraversable(self: CLuaLocomotion, area: CNavArea): boolean;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns true if we're trying to move.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:IsAttemptingToMove
+     */
+    IsAttemptingToMove(self: CLuaLocomotion): boolean;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns true of the locomotion engine is jumping or climbing
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:IsClimbingOrJumping
+     */
+    IsClimbingOrJumping(self: CLuaLocomotion): boolean;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns whether the nextbot this locomotion is attached to is on ground or not.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:IsOnGround
+     */
+    IsOnGround(self: CLuaLocomotion): boolean;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns true if we're stuck
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:IsStuck
+     */
+    IsStuck(self: CLuaLocomotion): boolean;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Returns whether or not the target in question is on a ladder or not.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:IsUsingLadder
+     */
+    IsUsingLadder(self: CLuaLocomotion): boolean;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Makes the bot jump. It must be on ground ([Entity:IsOnGround](https://wiki.facepunch.com/gmod/Entity:IsOnGround)) and its model must have `ACT_JUMP` activity.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:Jump
+     */
+    Jump(self: CLuaLocomotion, act?: number): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Makes the bot jump across a gap. The bot must be on ground ([Entity:IsOnGround](https://wiki.facepunch.com/gmod/Entity:IsOnGround)) and its model must have `ACT_JUMP` activity.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:JumpAcrossGap
+     */
+    JumpAcrossGap(self: CLuaLocomotion, landingGoal: Vector, landingForward: Vector): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets the acceleration speed
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:SetAcceleration
+     */
+    SetAcceleration(self: CLuaLocomotion, speed?: number): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets whether the Nextbot is allowed try to to avoid obstacles or not. This is used during path generation. Works similarly to `nb_allow_avoiding` convar. By default bots are allowed to try to avoid obstacles.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:SetAvoidAllowed
+     */
+    SetAvoidAllowed(self: CLuaLocomotion, allowed: boolean): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets whether the Nextbot is allowed to climb or not. This is used during path generation. Works similarly to `nb_allow_climbing` convar. By default bots are allowed to climb.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:SetClimbAllowed
+     */
+    SetClimbAllowed(self: CLuaLocomotion, allowed: boolean): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets the height the bot is scared to fall from.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:SetDeathDropHeight
+     */
+    SetDeathDropHeight(self: CLuaLocomotion, height?: number): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets the deceleration speed.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:SetDeceleration
+     */
+    SetDeceleration(self: CLuaLocomotion, deceleration?: number): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets how far the NextBot will need to move each time [CLuaLocomotion:Approach](https://wiki.facepunch.com/gmod/CLuaLocomotion:Approach) is called to move at given speed.
+     *
+     * The default amount is 0. This means the bot will not move if this value has not been set.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:SetDesiredSpeed
+     */
+    SetDesiredSpeed(self: CLuaLocomotion, speed?: number): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets the locomotion's gravity.
+     *
+     * **NOTE**: With values 0 or below, or even lower positive values, the nextbot will start to drift sideways, use [CLuaLocomotion:SetVelocity](https://wiki.facepunch.com/gmod/CLuaLocomotion:SetVelocity) to counteract this.
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:SetGravity
+     */
+    SetGravity(self: CLuaLocomotion, gravity?: number): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets whether the Nextbot is allowed to jump gaps or not. This is used during path generation. Works similarly to `nb_allow_gap_jumping` convar. By default bots are allowed to jump gaps.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:SetJumpGapsAllowed
+     */
+    SetJumpGapsAllowed(self: CLuaLocomotion, allowed: boolean): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets the height of the bot's jump
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:SetJumpHeight
+     */
+    SetJumpHeight(self: CLuaLocomotion, height?: number): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets the max rate at which the NextBot can visually rotate. This will not affect moving or pathing.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:SetMaxYawRate
+     */
+    SetMaxYawRate(self: CLuaLocomotion, yawRate?: number): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets the max height the bot can step up
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:SetStepHeight
+     */
+    SetStepHeight(self: CLuaLocomotion, height?: number): void;
+}
+
+interface CLuaLocomotion {
+    /**
+     * Sets the current movement velocity
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/CLuaLocomotion:SetVelocity
+     */
+    SetVelocity(self: CLuaLocomotion, velocity: Vector): void;
+}
+